| Index: discovery/googleapis_beta/adexchangebuyer2__v2beta1.json
|
| diff --git a/discovery/googleapis_beta/adexchangebuyer2__v2beta1.json b/discovery/googleapis_beta/adexchangebuyer2__v2beta1.json
|
| index 2e039a5996b9aca2bfcecb28d2a23958253d7837..7ef884ee548b33dc3ee8d7739468601fee8daf0a 100644
|
| --- a/discovery/googleapis_beta/adexchangebuyer2__v2beta1.json
|
| +++ b/discovery/googleapis_beta/adexchangebuyer2__v2beta1.json
|
| @@ -25,6 +25,22 @@
|
| "ownerDomain": "google.com",
|
| "ownerName": "Google",
|
| "parameters": {
|
| + "pp": {
|
| + "default": "true",
|
| + "description": "Pretty-print response.",
|
| + "location": "query",
|
| + "type": "boolean"
|
| + },
|
| + "bearer_token": {
|
| + "description": "OAuth bearer token.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "oauth_token": {
|
| + "description": "OAuth 2.0 token for the current user.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| "upload_protocol": {
|
| "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| "location": "query",
|
| @@ -36,13 +52,13 @@
|
| "location": "query",
|
| "type": "boolean"
|
| },
|
| - "uploadType": {
|
| - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| + "fields": {
|
| + "description": "Selector specifying which fields to include in a partial response.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "fields": {
|
| - "description": "Selector specifying which fields to include in a partial response.",
|
| + "uploadType": {
|
| + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| @@ -80,34 +96,18 @@
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "key": {
|
| - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "access_token": {
|
| "description": "OAuth access token.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "quotaUser": {
|
| - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "pp": {
|
| - "default": "true",
|
| - "description": "Pretty-print response.",
|
| - "location": "query",
|
| - "type": "boolean"
|
| - },
|
| - "bearer_token": {
|
| - "description": "OAuth bearer token.",
|
| + "key": {
|
| + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "oauth_token": {
|
| - "description": "OAuth 2.0 token for the current user.",
|
| + "quotaUser": {
|
| + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| "location": "query",
|
| "type": "string"
|
| }
|
| @@ -127,15 +127,15 @@
|
| "filterSetId"
|
| ],
|
| "parameters": {
|
| - "accountId": {
|
| - "description": "Account ID of the buyer.",
|
| + "filterSetId": {
|
| + "description": "The ID of the filter set to get.",
|
| "format": "int64",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "filterSetId": {
|
| - "description": "The ID of the filter set to get.",
|
| + "accountId": {
|
| + "description": "Account ID of the buyer.",
|
| "format": "int64",
|
| "location": "path",
|
| "required": true,
|
| @@ -159,7 +159,7 @@
|
| ],
|
| "parameters": {
|
| "pageToken": {
|
| - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilterSetsResponse.nextPageToken\nreturned from the previous call to the\naccounts.rtbBreakout.filterSets.list\nmethod.",
|
| + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilterSetsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.list\nmethod.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| @@ -171,7 +171,7 @@
|
| "type": "string"
|
| },
|
| "pageSize": {
|
| - "description": "Requested page size. The server may return fewer than requested.\nIf unspecified, the server will pick an appropriate default.",
|
| + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
|
| "format": "int32",
|
| "location": "query",
|
| "type": "integer"
|
| @@ -262,11 +262,6 @@
|
| "filterSetId"
|
| ],
|
| "parameters": {
|
| - "pageToken": {
|
| - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.list\nmethod.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "accountId": {
|
| "description": "Account ID of the buyer.",
|
| "format": "int64",
|
| @@ -275,7 +270,7 @@
|
| "type": "string"
|
| },
|
| "pageSize": {
|
| - "description": "Requested page size. The server may return fewer than requested.\nIf unspecified, the server will pick an appropriate default.",
|
| + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
|
| "format": "int32",
|
| "location": "query",
|
| "type": "integer"
|
| @@ -286,6 +281,11 @@
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| + },
|
| + "pageToken": {
|
| + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.list\nmethod.",
|
| + "location": "query",
|
| + "type": "string"
|
| }
|
| },
|
| "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids",
|
| @@ -298,25 +298,73 @@
|
| }
|
| },
|
| "resources": {
|
| - "creatives": {
|
| + "details": {
|
| "methods": {
|
| "list": {
|
| - "description": "List all creatives associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative.",
|
| + "description": "List all details associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each detail.",
|
| "httpMethod": "GET",
|
| - "id": "adexchangebuyer2.accounts.filterSets.filteredBids.creatives.list",
|
| + "id": "adexchangebuyer2.accounts.filterSets.filteredBids.details.list",
|
| "parameterOrder": [
|
| "accountId",
|
| "filterSetId",
|
| "creativeStatusId"
|
| ],
|
| "parameters": {
|
| + "creativeStatusId": {
|
| + "description": "The ID of the creative status for which to retrieve a breakdown by detail.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
|
| + "format": "int32",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "integer"
|
| + },
|
| + "pageToken": {
|
| + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByDetailResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.details.list\nmethod.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "accountId": {
|
| + "description": "Account ID of the buyer.",
|
| + "format": "int64",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "pageSize": {
|
| + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| "filterSetId": {
|
| "description": "The ID of the filter set to apply.",
|
| "format": "int64",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| - },
|
| + }
|
| + },
|
| + "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/details",
|
| + "response": {
|
| + "$ref": "ListCreativeStatusBreakdownByDetailResponse"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/adexchange.buyer"
|
| + ]
|
| + }
|
| + }
|
| + },
|
| + "creatives": {
|
| + "methods": {
|
| + "list": {
|
| + "description": "List all creatives associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative.",
|
| + "httpMethod": "GET",
|
| + "id": "adexchangebuyer2.accounts.filterSets.filteredBids.creatives.list",
|
| + "parameterOrder": [
|
| + "accountId",
|
| + "filterSetId",
|
| + "creativeStatusId"
|
| + ],
|
| + "parameters": {
|
| "creativeStatusId": {
|
| "description": "The ID of the creative status for which to retrieve a breakdown by\ncreative.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
|
| "format": "int32",
|
| @@ -337,10 +385,17 @@
|
| "type": "string"
|
| },
|
| "pageSize": {
|
| - "description": "Requested page size. The server may return fewer than requested.\nIf unspecified, the server will pick an appropriate default.",
|
| + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
|
| "format": "int32",
|
| "location": "query",
|
| "type": "integer"
|
| + },
|
| + "filterSetId": {
|
| + "description": "The ID of the filter set to apply.",
|
| + "format": "int64",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| }
|
| },
|
| "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives",
|
| @@ -366,8 +421,13 @@
|
| "creativeId"
|
| ],
|
| "parameters": {
|
| + "pageToken": {
|
| + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusAndCreativeBreakdownByDetailResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.creatives.details.list\nmethod.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| "pageSize": {
|
| - "description": "Requested page size. The server may return fewer than requested.\nIf unspecified, the server will pick an appropriate default.",
|
| + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
|
| "format": "int32",
|
| "location": "query",
|
| "type": "integer"
|
| @@ -398,11 +458,6 @@
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| - },
|
| - "pageToken": {
|
| - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusAndCreativeBreakdownByDetailResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.creatives.details.list\nmethod.",
|
| - "location": "query",
|
| - "type": "string"
|
| }
|
| },
|
| "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives/{creativeId}/details",
|
| @@ -416,77 +471,22 @@
|
| }
|
| }
|
| }
|
| - },
|
| - "details": {
|
| - "methods": {
|
| - "list": {
|
| - "description": "List all details associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each detail.",
|
| - "httpMethod": "GET",
|
| - "id": "adexchangebuyer2.accounts.filterSets.filteredBids.details.list",
|
| - "parameterOrder": [
|
| - "accountId",
|
| - "filterSetId",
|
| - "creativeStatusId"
|
| - ],
|
| - "parameters": {
|
| - "filterSetId": {
|
| - "description": "The ID of the filter set to apply.",
|
| - "format": "int64",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| - "creativeStatusId": {
|
| - "description": "The ID of the creative status for which to retrieve a breakdown by detail.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
|
| - "format": "int32",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "integer"
|
| - },
|
| - "pageToken": {
|
| - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByDetailResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.details.list\nmethod.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "accountId": {
|
| - "description": "Account ID of the buyer.",
|
| - "format": "int64",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| - "pageSize": {
|
| - "description": "Requested page size. The server may return fewer than requested.\nIf unspecified, the server will pick an appropriate default.",
|
| - "format": "int32",
|
| - "location": "query",
|
| - "type": "integer"
|
| - }
|
| - },
|
| - "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/details",
|
| - "response": {
|
| - "$ref": "ListCreativeStatusBreakdownByDetailResponse"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/adexchange.buyer"
|
| - ]
|
| - }
|
| - }
|
| }
|
| }
|
| },
|
| - "filteredImpressions": {
|
| + "nonBillableWinningBids": {
|
| "methods": {
|
| "list": {
|
| - "description": "List all reasons that caused an impression to be filtered (i.e. not\nconsidered as an inventory match), with the number of impressions that were\nfiltered for each reason.",
|
| + "description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason.",
|
| "httpMethod": "GET",
|
| - "id": "adexchangebuyer2.accounts.filterSets.filteredImpressions.list",
|
| + "id": "adexchangebuyer2.accounts.filterSets.nonBillableWinningBids.list",
|
| "parameterOrder": [
|
| "accountId",
|
| "filterSetId"
|
| ],
|
| "parameters": {
|
| "pageToken": {
|
| - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredImpressionsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredImpressions.list\nmethod.",
|
| + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.nonBillableWinningBids.list\nmethod.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| @@ -498,7 +498,7 @@
|
| "type": "string"
|
| },
|
| "pageSize": {
|
| - "description": "Requested page size. The server may return fewer than requested.\nIf unspecified, the server will pick an appropriate default.",
|
| + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
|
| "format": "int32",
|
| "location": "query",
|
| "type": "integer"
|
| @@ -511,9 +511,9 @@
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredImpressions",
|
| + "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/nonBillableWinningBids",
|
| "response": {
|
| - "$ref": "ListFilteredImpressionsResponse"
|
| + "$ref": "ListNonBillableWinningBidsResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/adexchange.buyer"
|
| @@ -545,7 +545,7 @@
|
| "type": "string"
|
| },
|
| "pageSize": {
|
| - "description": "Requested page size. The server may return fewer than requested.\nIf unspecified, the server will pick an appropriate default.",
|
| + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
|
| "format": "int32",
|
| "location": "query",
|
| "type": "integer"
|
| @@ -568,26 +568,19 @@
|
| }
|
| }
|
| },
|
| - "bidMetrics": {
|
| + "impressionMetrics": {
|
| "methods": {
|
| "list": {
|
| - "description": "Lists all metrics that are measured in terms of number of bids.",
|
| + "description": "Lists all metrics that are measured in terms of number of impressions.",
|
| "httpMethod": "GET",
|
| - "id": "adexchangebuyer2.accounts.filterSets.bidMetrics.list",
|
| + "id": "adexchangebuyer2.accounts.filterSets.impressionMetrics.list",
|
| "parameterOrder": [
|
| "accountId",
|
| "filterSetId"
|
| ],
|
| "parameters": {
|
| - "filterSetId": {
|
| - "description": "The ID of the filter set to apply.",
|
| - "format": "int64",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| "pageToken": {
|
| - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidMetricsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidMetrics.list\nmethod.",
|
| + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.impressionMetrics.list\nmethod.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| @@ -599,15 +592,22 @@
|
| "type": "string"
|
| },
|
| "pageSize": {
|
| - "description": "Requested page size. The server may return fewer than requested.\nIf unspecified, the server will pick an appropriate default.",
|
| + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
|
| "format": "int32",
|
| "location": "query",
|
| "type": "integer"
|
| + },
|
| + "filterSetId": {
|
| + "description": "The ID of the filter set to apply.",
|
| + "format": "int64",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| }
|
| },
|
| - "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidMetrics",
|
| + "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/impressionMetrics",
|
| "response": {
|
| - "$ref": "ListBidMetricsResponse"
|
| + "$ref": "ListImpressionMetricsResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/adexchange.buyer"
|
| @@ -615,19 +615,19 @@
|
| }
|
| }
|
| },
|
| - "impressionMetrics": {
|
| + "bidMetrics": {
|
| "methods": {
|
| "list": {
|
| - "description": "Lists all metrics that are measured in terms of number of impressions.",
|
| + "description": "Lists all metrics that are measured in terms of number of bids.",
|
| "httpMethod": "GET",
|
| - "id": "adexchangebuyer2.accounts.filterSets.impressionMetrics.list",
|
| + "id": "adexchangebuyer2.accounts.filterSets.bidMetrics.list",
|
| "parameterOrder": [
|
| "accountId",
|
| "filterSetId"
|
| ],
|
| "parameters": {
|
| "pageToken": {
|
| - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.impressionMetrics.list\nmethod.",
|
| + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidMetricsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidMetrics.list\nmethod.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| @@ -639,7 +639,7 @@
|
| "type": "string"
|
| },
|
| "pageSize": {
|
| - "description": "Requested page size. The server may return fewer than requested.\nIf unspecified, the server will pick an appropriate default.",
|
| + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
|
| "format": "int32",
|
| "location": "query",
|
| "type": "integer"
|
| @@ -652,9 +652,9 @@
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/impressionMetrics",
|
| + "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidMetrics",
|
| "response": {
|
| - "$ref": "ListImpressionMetricsResponse"
|
| + "$ref": "ListBidMetricsResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/adexchange.buyer"
|
| @@ -673,6 +673,13 @@
|
| "filterSetId"
|
| ],
|
| "parameters": {
|
| + "filterSetId": {
|
| + "description": "The ID of the filter set to apply.",
|
| + "format": "int64",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| "pageToken": {
|
| "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidResponseErrors.list\nmethod.",
|
| "location": "query",
|
| @@ -686,17 +693,10 @@
|
| "type": "string"
|
| },
|
| "pageSize": {
|
| - "description": "Requested page size. The server may return fewer than requested.\nIf unspecified, the server will pick an appropriate default.",
|
| + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
|
| "format": "int32",
|
| "location": "query",
|
| "type": "integer"
|
| - },
|
| - "filterSetId": {
|
| - "description": "The ID of the filter set to apply.",
|
| - "format": "int64",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| }
|
| },
|
| "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponseErrors",
|
| @@ -720,6 +720,13 @@
|
| "filterSetId"
|
| ],
|
| "parameters": {
|
| + "filterSetId": {
|
| + "description": "The ID of the filter set to apply.",
|
| + "format": "int64",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| "pageToken": {
|
| "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidResponsesWithoutBids.list\nmethod.",
|
| "location": "query",
|
| @@ -733,17 +740,10 @@
|
| "type": "string"
|
| },
|
| "pageSize": {
|
| - "description": "Requested page size. The server may return fewer than requested.\nIf unspecified, the server will pick an appropriate default.",
|
| + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
|
| "format": "int32",
|
| "location": "query",
|
| "type": "integer"
|
| - },
|
| - "filterSetId": {
|
| - "description": "The ID of the filter set to apply.",
|
| - "format": "int64",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| }
|
| },
|
| "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponsesWithoutBids",
|
| @@ -780,7 +780,7 @@
|
| "type": "string"
|
| },
|
| "pageSize": {
|
| - "description": "Requested page size. The server may return fewer than requested.\nIf unspecified, the server will pick an appropriate default.",
|
| + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
|
| "format": "int32",
|
| "location": "query",
|
| "type": "integer"
|
| @@ -847,11 +847,6 @@
|
| "accountId"
|
| ],
|
| "parameters": {
|
| - "pageToken": {
|
| - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientsResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.list method.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "accountId": {
|
| "description": "Unique numerical account ID of the sponsor buyer to list the clients for.",
|
| "format": "int64",
|
| @@ -864,6 +859,11 @@
|
| "format": "int32",
|
| "location": "query",
|
| "type": "integer"
|
| + },
|
| + "pageToken": {
|
| + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientsResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.list method.",
|
| + "location": "query",
|
| + "type": "string"
|
| }
|
| },
|
| "path": "v2beta1/accounts/{accountId}/clients",
|
| @@ -940,6 +940,41 @@
|
| "resources": {
|
| "invitations": {
|
| "methods": {
|
| + "create": {
|
| + "description": "Creates and sends out an email invitation to access\nan Ad Exchange client buyer account.",
|
| + "httpMethod": "POST",
|
| + "id": "adexchangebuyer2.accounts.clients.invitations.create",
|
| + "parameterOrder": [
|
| + "accountId",
|
| + "clientAccountId"
|
| + ],
|
| + "parameters": {
|
| + "accountId": {
|
| + "description": "Numerical account ID of the client's sponsor buyer. (required)",
|
| + "format": "int64",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "clientAccountId": {
|
| + "description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)",
|
| + "format": "int64",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
|
| + "request": {
|
| + "$ref": "ClientUserInvitation"
|
| + },
|
| + "response": {
|
| + "$ref": "ClientUserInvitation"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/adexchange.buyer"
|
| + ]
|
| + },
|
| "get": {
|
| "description": "Retrieves an existing client user invitation.",
|
| "httpMethod": "GET",
|
| @@ -950,22 +985,22 @@
|
| "invitationId"
|
| ],
|
| "parameters": {
|
| - "accountId": {
|
| - "description": "Numerical account ID of the client's sponsor buyer. (required)",
|
| + "invitationId": {
|
| + "description": "Numerical identifier of the user invitation to retrieve. (required)",
|
| "format": "int64",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "clientAccountId": {
|
| - "description": "Numerical account ID of the client buyer that the user invitation\nto be retrieved is associated with. (required)",
|
| + "accountId": {
|
| + "description": "Numerical account ID of the client's sponsor buyer. (required)",
|
| "format": "int64",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "invitationId": {
|
| - "description": "Numerical identifier of the user invitation to retrieve. (required)",
|
| + "clientAccountId": {
|
| + "description": "Numerical account ID of the client buyer that the user invitation\nto be retrieved is associated with. (required)",
|
| "format": "int64",
|
| "location": "path",
|
| "required": true,
|
| @@ -1021,16 +1056,28 @@
|
| "scopes": [
|
| "https://www.googleapis.com/auth/adexchange.buyer"
|
| ]
|
| - },
|
| - "create": {
|
| - "description": "Creates and sends out an email invitation to access\nan Ad Exchange client buyer account.",
|
| - "httpMethod": "POST",
|
| - "id": "adexchangebuyer2.accounts.clients.invitations.create",
|
| + }
|
| + }
|
| + },
|
| + "users": {
|
| + "methods": {
|
| + "update": {
|
| + "description": "Updates an existing client user.\nOnly the user status can be changed on update.",
|
| + "httpMethod": "PUT",
|
| + "id": "adexchangebuyer2.accounts.clients.users.update",
|
| "parameterOrder": [
|
| "accountId",
|
| - "clientAccountId"
|
| + "clientAccountId",
|
| + "userId"
|
| ],
|
| "parameters": {
|
| + "userId": {
|
| + "description": "Numerical identifier of the user to retrieve. (required)",
|
| + "format": "int64",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| "accountId": {
|
| "description": "Numerical account ID of the client's sponsor buyer. (required)",
|
| "format": "int64",
|
| @@ -1039,28 +1086,24 @@
|
| "type": "string"
|
| },
|
| "clientAccountId": {
|
| - "description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)",
|
| + "description": "Numerical account ID of the client buyer that the user to be retrieved\nis associated with. (required)",
|
| "format": "int64",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
|
| + "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
|
| "request": {
|
| - "$ref": "ClientUserInvitation"
|
| + "$ref": "ClientUser"
|
| },
|
| "response": {
|
| - "$ref": "ClientUserInvitation"
|
| + "$ref": "ClientUser"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/adexchange.buyer"
|
| ]
|
| - }
|
| - }
|
| - },
|
| - "users": {
|
| - "methods": {
|
| + },
|
| "list": {
|
| "description": "Lists all the known client users for a specified\nsponsor buyer account ID.",
|
| "httpMethod": "GET",
|
| @@ -1070,12 +1113,6 @@
|
| "clientAccountId"
|
| ],
|
| "parameters": {
|
| - "clientAccountId": {
|
| - "description": "The account ID of the client buyer to list users for. (required)\nYou must specify either a string representation of a\nnumerical account identifier or the `-` character\nto list all the client users for all the clients\nof a given sponsor buyer.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| "pageToken": {
|
| "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUsersResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.users.list method.",
|
| "location": "query",
|
| @@ -1093,6 +1130,12 @@
|
| "format": "int32",
|
| "location": "query",
|
| "type": "integer"
|
| + },
|
| + "clientAccountId": {
|
| + "description": "The account ID of the client buyer to list users for. (required)\nYou must specify either a string representation of a\nnumerical account identifier or the `-` character\nto list all the client users for all the clients\nof a given sponsor buyer.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| }
|
| },
|
| "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
|
| @@ -1142,49 +1185,6 @@
|
| "scopes": [
|
| "https://www.googleapis.com/auth/adexchange.buyer"
|
| ]
|
| - },
|
| - "update": {
|
| - "description": "Updates an existing client user.\nOnly the user status can be changed on update.",
|
| - "httpMethod": "PUT",
|
| - "id": "adexchangebuyer2.accounts.clients.users.update",
|
| - "parameterOrder": [
|
| - "accountId",
|
| - "clientAccountId",
|
| - "userId"
|
| - ],
|
| - "parameters": {
|
| - "userId": {
|
| - "description": "Numerical identifier of the user to retrieve. (required)",
|
| - "format": "int64",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| - "accountId": {
|
| - "description": "Numerical account ID of the client's sponsor buyer. (required)",
|
| - "format": "int64",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| - "clientAccountId": {
|
| - "description": "Numerical account ID of the client buyer that the user to be retrieved\nis associated with. (required)",
|
| - "format": "int64",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
|
| - "request": {
|
| - "$ref": "ClientUser"
|
| - },
|
| - "response": {
|
| - "$ref": "ClientUser"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/adexchange.buyer"
|
| - ]
|
| }
|
| }
|
| }
|
| @@ -1192,45 +1192,6 @@
|
| },
|
| "creatives": {
|
| "methods": {
|
| - "list": {
|
| - "description": "Lists creatives.",
|
| - "httpMethod": "GET",
|
| - "id": "adexchangebuyer2.accounts.creatives.list",
|
| - "parameterOrder": [
|
| - "accountId"
|
| - ],
|
| - "parameters": {
|
| - "pageToken": {
|
| - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativesResponse.next_page_token\nreturned from the previous call to 'ListCreatives' method.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "accountId": {
|
| - "description": "The account to list the creatives from.\nSpecify \"-\" to list all creatives the current user has access to.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| - "pageSize": {
|
| - "description": "Requested page size. The server may return fewer creatives than requested\n(due to timeout constraint) even if more are available via another call.\nIf unspecified, server will pick an appropriate default.\nAcceptable values are 1 to 1000, inclusive.",
|
| - "format": "int32",
|
| - "location": "query",
|
| - "type": "integer"
|
| - },
|
| - "query": {
|
| - "description": "An optional query string to filter creatives. If no filter is specified,\nall active creatives will be returned.\nSupported queries are:\n<ul>\n<li>accountId=<i>account_id_string</i>\n<li>creativeId=<i>creative_id_string</i>\n<li>dealsStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n<li>openAuctionStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n<li>attribute: {a numeric attribute from the list of attributes}\n<li>disapprovalReason: {a reason from DisapprovalReason\n</ul>\nExample: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47'",
|
| - "location": "query",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v2beta1/accounts/{accountId}/creatives",
|
| - "response": {
|
| - "$ref": "ListCreativesResponse"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/adexchange.buyer"
|
| - ]
|
| - },
|
| "create": {
|
| "description": "Creates a creative.",
|
| "httpMethod": "POST",
|
| @@ -1275,14 +1236,14 @@
|
| "creativeId"
|
| ],
|
| "parameters": {
|
| - "creativeId": {
|
| - "description": "The creative ID of the creative to stop notifications for.\nSpecify \"-\" to specify stopping account level notifications.",
|
| + "accountId": {
|
| + "description": "The account of the creative to stop notifications for.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "accountId": {
|
| - "description": "The account of the creative to stop notifications for.",
|
| + "creativeId": {
|
| + "description": "The creative ID of the creative to stop notifications for.\nSpecify \"-\" to specify stopping account level notifications.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| @@ -1371,14 +1332,14 @@
|
| "creativeId"
|
| ],
|
| "parameters": {
|
| - "accountId": {
|
| - "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
|
| + "creativeId": {
|
| + "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "creativeId": {
|
| - "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
|
| + "accountId": {
|
| + "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| @@ -1394,6 +1355,45 @@
|
| "scopes": [
|
| "https://www.googleapis.com/auth/adexchange.buyer"
|
| ]
|
| + },
|
| + "list": {
|
| + "description": "Lists creatives.",
|
| + "httpMethod": "GET",
|
| + "id": "adexchangebuyer2.accounts.creatives.list",
|
| + "parameterOrder": [
|
| + "accountId"
|
| + ],
|
| + "parameters": {
|
| + "pageToken": {
|
| + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativesResponse.next_page_token\nreturned from the previous call to 'ListCreatives' method.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "accountId": {
|
| + "description": "The account to list the creatives from.\nSpecify \"-\" to list all creatives the current user has access to.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "pageSize": {
|
| + "description": "Requested page size. The server may return fewer creatives than requested\n(due to timeout constraint) even if more are available via another call.\nIf unspecified, server will pick an appropriate default.\nAcceptable values are 1 to 1000, inclusive.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| + "query": {
|
| + "description": "An optional query string to filter creatives. If no filter is specified,\nall active creatives will be returned.\nSupported queries are:\n<ul>\n<li>accountId=<i>account_id_string</i>\n<li>creativeId=<i>creative_id_string</i>\n<li>dealsStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n<li>openAuctionStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n<li>attribute: {a numeric attribute from the list of attributes}\n<li>disapprovalReason: {a reason from DisapprovalReason\n</ul>\nExample: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47'",
|
| + "location": "query",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v2beta1/accounts/{accountId}/creatives",
|
| + "response": {
|
| + "$ref": "ListCreativesResponse"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/adexchange.buyer"
|
| + ]
|
| }
|
| },
|
| "resources": {
|
| @@ -1474,6 +1474,11 @@
|
| "creativeId"
|
| ],
|
| "parameters": {
|
| + "query": {
|
| + "description": "An optional query string to filter deal associations. If no filter is\nspecified, all associations will be returned.\nSupported queries are:\n<ul>\n<li>accountId=<i>account_id_string</i>\n<li>creativeId=<i>creative_id_string</i>\n<li>dealsId=<i>deals_id_string</i>\n<li>dealsStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n<li>openAuctionStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n</ul>\nExample: 'dealsId=12345 AND dealsStatus:disapproved'",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| "creativeId": {
|
| "description": "The creative ID to list the associations from.\nSpecify \"-\" to list all creatives under the above account.",
|
| "location": "path",
|
| @@ -1496,11 +1501,6 @@
|
| "format": "int32",
|
| "location": "query",
|
| "type": "integer"
|
| - },
|
| - "query": {
|
| - "description": "An optional query string to filter deal associations. If no filter is\nspecified, all associations will be returned.\nSupported queries are:\n<ul>\n<li>accountId=<i>account_id_string</i>\n<li>creativeId=<i>creative_id_string</i>\n<li>dealsId=<i>deals_id_string</i>\n<li>dealsStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n<li>openAuctionStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n</ul>\nExample: 'dealsId=12345 AND dealsStatus:disapproved'",
|
| - "location": "query",
|
| - "type": "string"
|
| }
|
| },
|
| "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
|
| @@ -1518,1789 +1518,1795 @@
|
| }
|
| }
|
| },
|
| - "revision": "20170608",
|
| + "revision": "20170623",
|
| "rootUrl": "https://adexchangebuyer.googleapis.com/",
|
| "schemas": {
|
| - "ClientUser": {
|
| - "description": "A client user is created under a client buyer and has restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the associated client buyer.\n\nThe only way a new client user can be created is via accepting an\nemail invitation\n(see the\naccounts.clients.invitations.create\nmethod).\n\nAll fields are required unless otherwise specified.",
|
| - "id": "ClientUser",
|
| + "WatchCreativeRequest": {
|
| + "description": "A request for watching changes to creative Status.",
|
| + "id": "WatchCreativeRequest",
|
| "properties": {
|
| - "userId": {
|
| - "description": "The unique numerical ID of the client user\nthat has accepted an invitation.\nThe value of this field is ignored in an update operation.",
|
| - "format": "int64",
|
| - "type": "string"
|
| - },
|
| - "email": {
|
| - "description": "User's email address. The value of this field\nis ignored in an update operation.",
|
| + "topic": {
|
| + "description": "The Pub/Sub topic to publish notifications to.\nThis topic must already exist and must give permission to\nad-exchange-buyside-reports@google.com to write to the topic.\nThis should be the full resource name in\n\"projects/{project_id}/topics/{topic_id}\" format.",
|
| "type": "string"
|
| - },
|
| - "clientAccountId": {
|
| - "description": "Numerical account ID of the client buyer\nwith which the user is associated; the\nbuyer must be a client of the current sponsor buyer.\nThe value of this field is ignored in an update operation.",
|
| - "format": "int64",
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "TimeInterval": {
|
| + "description": "An interval of time, with an absolute start and end.\nThis is included in the response, for several reasons:\n1) The request may have specified start or end times relative to the time the\n request was sent; the response indicates the corresponding absolute time\n interval.\n2) The request may have specified an end time past the latest time for which\n data was available (e.g. if requesting data for the today); the response\n indicates the latest time for which data was actually returned.\n3) The response data for a single request may be broken down into multiple\n time intervals, if a time series was requested.",
|
| + "id": "TimeInterval",
|
| + "properties": {
|
| + "endTime": {
|
| + "description": "The timestamp marking the end of the range (exclusive) for which data is\nincluded.",
|
| + "format": "google-datetime",
|
| "type": "string"
|
| },
|
| - "status": {
|
| - "description": "The status of the client user.",
|
| - "enum": [
|
| - "USER_STATUS_UNSPECIFIED",
|
| - "PENDING",
|
| - "ACTIVE",
|
| - "DISABLED"
|
| - ],
|
| - "enumDescriptions": [
|
| - "A placeholder for an undefined user status.",
|
| - "A user who was already created but hasn't accepted the invitation yet.",
|
| - "A user that is currently active.",
|
| - "A user that is currently disabled."
|
| - ],
|
| + "startTime": {
|
| + "description": "The timestamp marking the start of the range (inclusive) for which data is\nincluded.",
|
| + "format": "google-datetime",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "CreativeDealAssociation": {
|
| - "description": "The association between a creative and a deal.",
|
| - "id": "CreativeDealAssociation",
|
| + "FilteredBidCreativeRow": {
|
| + "description": "The number of filtered bids with the specified dimension values that have the\nspecified creative.",
|
| + "id": "FilteredBidCreativeRow",
|
| "properties": {
|
| - "creativeId": {
|
| - "description": "The ID of the creative associated with the deal.",
|
| - "type": "string"
|
| + "bidCount": {
|
| + "$ref": "MetricValue",
|
| + "description": "The number of bids with the specified creative."
|
| },
|
| - "dealsId": {
|
| - "description": "The externalDealId for the deal associated with the creative.",
|
| + "creativeId": {
|
| + "description": "The ID of the creative.",
|
| "type": "string"
|
| },
|
| - "accountId": {
|
| - "description": "The account the creative belongs to.",
|
| - "type": "string"
|
| + "rowDimensions": {
|
| + "$ref": "RowDimensions",
|
| + "description": "The values of all dimensions associated with metric values in this row."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "FilteringStats": {
|
| - "description": "@OutputOnly Filtering reasons for this creative during a period of a single\nday (from midnight to midnight Pacific).",
|
| - "id": "FilteringStats",
|
| + "RelativeDateRange": {
|
| + "description": "A relative date range, specified by an offset and a duration.\nThe supported range of dates begins 30 days before today and ends today.\nI.e. the limits for these values are:\noffset_days >= 0\nduration_days >= 1\noffset_days + duration_days <= 30",
|
| + "id": "RelativeDateRange",
|
| "properties": {
|
| - "reasons": {
|
| - "description": "The set of filtering reasons for this date.",
|
| - "items": {
|
| - "$ref": "Reason"
|
| - },
|
| - "type": "array"
|
| + "durationDays": {
|
| + "description": "The number of days in the requested date range. E.g. for a range spanning\ntoday, 1. For a range spanning the last 7 days, 7.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| },
|
| - "date": {
|
| - "$ref": "Date",
|
| - "description": "The day during which the data was collected.\nThe data is collected from 00:00:00 to 23:59:59 PT.\nDuring switches from PST to PDT and back, the day may\ncontain 23 or 25 hours of data instead of the usual 24."
|
| + "offsetDays": {
|
| + "description": "The end date of the filter set, specified as the number of days before\ntoday. E.g. for a range where the last date is today, 0.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Creative": {
|
| - "description": "A creative and its classification data.",
|
| - "id": "Creative",
|
| + "NativeContent": {
|
| + "description": "Native content for a creative.",
|
| + "id": "NativeContent",
|
| "properties": {
|
| - "dealsStatus": {
|
| - "description": "@OutputOnly The top-level deals status of this creative.\nIf disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
|
| - "enum": [
|
| - "STATUS_UNSPECIFIED",
|
| - "NOT_CHECKED",
|
| - "CONDITIONALLY_APPROVED",
|
| - "APPROVED",
|
| - "DISAPPROVED"
|
| - ],
|
| - "enumDescriptions": [
|
| - "The status is unknown.",
|
| - "The creative has not been checked.",
|
| - "The creative has been conditionally approved.\nSee serving_restrictions for details.",
|
| - "The creative has been approved.",
|
| - "The creative has been disapproved."
|
| - ],
|
| + "callToAction": {
|
| + "description": "A label for the button that the user is supposed to click.",
|
| "type": "string"
|
| },
|
| - "detectedProductCategories": {
|
| - "description": "@OutputOnly Detected product categories, if any.\nSee the ad-product-categories.txt file in the technical documentation\nfor a list of IDs.",
|
| - "items": {
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| - "type": "array"
|
| + "body": {
|
| + "description": "A long description of the ad.",
|
| + "type": "string"
|
| },
|
| - "openAuctionStatus": {
|
| - "description": "@OutputOnly The top-level open auction status of this creative.\nIf disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
|
| - "enum": [
|
| - "STATUS_UNSPECIFIED",
|
| - "NOT_CHECKED",
|
| - "CONDITIONALLY_APPROVED",
|
| - "APPROVED",
|
| - "DISAPPROVED"
|
| - ],
|
| - "enumDescriptions": [
|
| - "The status is unknown.",
|
| - "The creative has not been checked.",
|
| - "The creative has been conditionally approved.\nSee serving_restrictions for details.",
|
| - "The creative has been approved.",
|
| - "The creative has been disapproved."
|
| - ],
|
| + "starRating": {
|
| + "description": "The app rating in the app store. Must be in the range [0-5].",
|
| + "format": "double",
|
| + "type": "number"
|
| + },
|
| + "videoUrl": {
|
| + "description": "The URL to fetch a native video ad.",
|
| + "type": "string"
|
| + },
|
| + "clickLinkUrl": {
|
| + "description": "The URL that the browser/SDK will load when the user clicks the ad.",
|
| + "type": "string"
|
| + },
|
| + "logo": {
|
| + "$ref": "Image",
|
| + "description": "A smaller image, for the advertiser's logo."
|
| + },
|
| + "priceDisplayText": {
|
| + "description": "The price of the promoted app including currency info.",
|
| + "type": "string"
|
| + },
|
| + "image": {
|
| + "$ref": "Image",
|
| + "description": "A large image."
|
| + },
|
| + "clickTrackingUrl": {
|
| + "description": "The URL to use for click tracking.",
|
| "type": "string"
|
| },
|
| "advertiserName": {
|
| - "description": "The name of the company being advertised in the creative.",
|
| + "description": "The name of the advertiser or sponsor, to be displayed in the ad creative.",
|
| "type": "string"
|
| },
|
| - "detectedDomains": {
|
| - "description": "@OutputOnly\nThe detected domains for this creative.",
|
| + "storeUrl": {
|
| + "description": "The URL to the app store to purchase/download the promoted app.",
|
| + "type": "string"
|
| + },
|
| + "headline": {
|
| + "description": "A short title for the ad.",
|
| + "type": "string"
|
| + },
|
| + "appIcon": {
|
| + "$ref": "Image",
|
| + "description": "The app icon, for app download ads."
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ListClientsResponse": {
|
| + "id": "ListClientsResponse",
|
| + "properties": {
|
| + "nextPageToken": {
|
| + "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientsRequest.pageToken\nfield in the subsequent call to the\naccounts.clients.list method\nto retrieve the next page of results.",
|
| + "type": "string"
|
| + },
|
| + "clients": {
|
| + "description": "The returned list of clients.",
|
| "items": {
|
| - "type": "string"
|
| + "$ref": "Client"
|
| },
|
| "type": "array"
|
| - },
|
| - "detectedAdvertiserIds": {
|
| - "description": "@OutputOnly Detected advertiser IDs, if any.",
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ListBidResponsesWithoutBidsResponse": {
|
| + "description": "Response message for listing all reasons that bid responses were considered\nto have no applicable bids.",
|
| + "id": "ListBidResponsesWithoutBidsResponse",
|
| + "properties": {
|
| + "bidResponseWithoutBidsStatusRows": {
|
| + "description": "List of rows, with counts of bid responses without bids aggregated by\nstatus.",
|
| "items": {
|
| - "format": "int64",
|
| - "type": "string"
|
| + "$ref": "BidResponseWithoutBidsStatusRow"
|
| },
|
| "type": "array"
|
| },
|
| - "filteringStats": {
|
| - "$ref": "FilteringStats",
|
| - "description": "@OutputOnly The filtering stats for this creative."
|
| + "nextPageToken": {
|
| + "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidResponsesWithoutBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.bidResponsesWithoutBids.list\nmethod to retrieve the next page of results.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ServingContext": {
|
| + "description": "The serving context for this restriction.",
|
| + "id": "ServingContext",
|
| + "properties": {
|
| + "appType": {
|
| + "$ref": "AppContext",
|
| + "description": "Matches impressions for a particular app type."
|
| },
|
| - "attributes": {
|
| - "description": "All attributes for the ads that may be shown from this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
|
| + "securityType": {
|
| + "$ref": "SecurityContext",
|
| + "description": "Matches impressions for a particular security type."
|
| + },
|
| + "platform": {
|
| + "$ref": "PlatformContext",
|
| + "description": "Matches impressions coming from a particular platform."
|
| + },
|
| + "location": {
|
| + "$ref": "LocationContext",
|
| + "description": "Matches impressions coming from users *or* publishers in a specific\nlocation."
|
| + },
|
| + "auctionType": {
|
| + "$ref": "AuctionContext",
|
| + "description": "Matches impressions for a particular auction type."
|
| + },
|
| + "all": {
|
| + "description": "Matches all contexts.",
|
| + "enum": [
|
| + "SIMPLE_CONTEXT"
|
| + ],
|
| "enumDescriptions": [
|
| - "Do not use. This is a placeholder value only.",
|
| - "The creative is tagged.",
|
| - "The creative is cookie targeted.",
|
| - "The creative is user interest targeted.",
|
| - "The creative does not expand.",
|
| - "The creative expands up.",
|
| - "The creative expands down.",
|
| - "The creative expands left.",
|
| - "The creative expands right.",
|
| - "The creative expands up and left.",
|
| - "The creative expands up and right.",
|
| - "The creative expands down and left.",
|
| - "The creative expands down and right.",
|
| - "The creative expands up or down.",
|
| - "The creative expands left or right.",
|
| - "The creative expands on any diagonal.",
|
| - "The creative expands when rolled over.",
|
| - "The instream vast video type is vpaid flash.",
|
| - "The creative is MRAID",
|
| - "The creative is SSL.",
|
| - "The creative is an interstitial.",
|
| - "The creative is eligible for native.",
|
| - "The creative is not eligible for native.",
|
| - "The creative can dynamically resize to fill a variety of slot sizes."
|
| + "A simple context."
|
| ],
|
| - "items": {
|
| - "enum": [
|
| - "ATTRIBUTE_UNSPECIFIED",
|
| - "IS_TAGGED",
|
| - "IS_COOKIE_TARGETED",
|
| - "IS_USER_INTEREST_TARGETED",
|
| - "EXPANDING_DIRECTION_NONE",
|
| - "EXPANDING_DIRECTION_UP",
|
| - "EXPANDING_DIRECTION_DOWN",
|
| - "EXPANDING_DIRECTION_LEFT",
|
| - "EXPANDING_DIRECTION_RIGHT",
|
| - "EXPANDING_DIRECTION_UP_LEFT",
|
| - "EXPANDING_DIRECTION_UP_RIGHT",
|
| - "EXPANDING_DIRECTION_DOWN_LEFT",
|
| - "EXPANDING_DIRECTION_DOWN_RIGHT",
|
| - "EXPANDING_DIRECTION_UP_OR_DOWN",
|
| - "EXPANDING_DIRECTION_LEFT_OR_RIGHT",
|
| - "EXPANDING_DIRECTION_ANY_DIAGONAL",
|
| - "EXPANDING_ACTION_ROLLOVER_TO_EXPAND",
|
| - "INSTREAM_VAST_VIDEO_TYPE_VPAID_FLASH",
|
| - "RICH_MEDIA_CAPABILITY_TYPE_MRAID",
|
| - "RICH_MEDIA_CAPABILITY_TYPE_SSL",
|
| - "RICH_MEDIA_CAPABILITY_TYPE_INTERSTITIAL",
|
| - "NATIVE_ELIGIBILITY_ELIGIBLE",
|
| - "NATIVE_ELIGIBILITY_NOT_ELIGIBLE",
|
| - "RENDERING_SIZELESS_ADX"
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "apiUpdateTime": {
|
| - "description": "@OutputOnly The last update timestamp of the creative via API.",
|
| - "format": "google-datetime",
|
| - "type": "string"
|
| - },
|
| - "detectedLanguages": {
|
| - "description": "@OutputOnly\nThe detected languages for this creative. The order is arbitrary. The codes\nare 2 or 5 characters and are documented at\nhttps://developers.google.com/adwords/api/docs/appendix/languagecodes.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "creativeId": {
|
| - "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
|
| - "type": "string"
|
| - },
|
| - "accountId": {
|
| - "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
|
| "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Image": {
|
| + "description": "An image resource. You may provide a larger image than was requested,\nso long as the aspect ratio is preserved.",
|
| + "id": "Image",
|
| + "properties": {
|
| + "height": {
|
| + "description": "Image height in pixels.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| },
|
| - "native": {
|
| - "$ref": "NativeContent",
|
| - "description": "A native creative."
|
| - },
|
| - "video": {
|
| - "$ref": "VideoContent",
|
| - "description": "A video creative."
|
| - },
|
| - "servingRestrictions": {
|
| - "description": "@OutputOnly The granular status of this ad in specific contexts.\nA context here relates to where something ultimately serves (for example,\na physical location, a platform, an HTTPS vs HTTP request, or the type\nof auction).",
|
| - "items": {
|
| - "$ref": "ServingRestriction"
|
| - },
|
| - "type": "array"
|
| + "width": {
|
| + "description": "Image width in pixels.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| },
|
| - "agencyId": {
|
| - "description": "The agency ID for this creative.",
|
| - "format": "int64",
|
| + "url": {
|
| + "description": "The URL of the image.",
|
| "type": "string"
|
| - },
|
| - "clickThroughUrls": {
|
| - "description": "The set of destination URLs for the creative.",
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ListFilterSetsResponse": {
|
| + "description": "Response message for listing filter sets.",
|
| + "id": "ListFilterSetsResponse",
|
| + "properties": {
|
| + "filterSets": {
|
| + "description": "The filter sets belonging to the buyer.",
|
| "items": {
|
| - "type": "string"
|
| + "$ref": "FilterSet"
|
| },
|
| "type": "array"
|
| },
|
| - "adChoicesDestinationUrl": {
|
| - "description": "The link to AdChoices destination page.",
|
| + "nextPageToken": {
|
| + "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilterSetsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.list\nmethod to retrieve the next page of results.",
|
| "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "BidResponseWithoutBidsStatusRow": {
|
| + "description": "The number of impressions with the specified dimension values that were\nconsidered to have no applicable bids, as described by the specified status.",
|
| + "id": "BidResponseWithoutBidsStatusRow",
|
| + "properties": {
|
| + "impressionCount": {
|
| + "$ref": "MetricValue",
|
| + "description": "The number of impressions for which there was a bid response with the\nspecified status."
|
| },
|
| - "detectedSensitiveCategories": {
|
| - "description": "@OutputOnly Detected sensitive categories, if any.\nSee the ad-sensitive-categories.txt file in the technical documentation for\na list of IDs. You should use these IDs along with the\nexcluded-sensitive-category field in the bid request to filter your bids.",
|
| - "items": {
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "restrictedCategories": {
|
| - "description": "All restricted categories for the ads that may be shown from this creative.",
|
| + "status": {
|
| + "description": "The status specifying why the bid responses were considered to have no\napplicable bids.",
|
| + "enum": [
|
| + "STATUS_UNSPECIFIED",
|
| + "RESPONSES_WITHOUT_BIDS",
|
| + "RESPONSES_WITHOUT_BIDS_FOR_ACCOUNT",
|
| + "RESPONSES_WITHOUT_BIDS_FOR_DEAL"
|
| + ],
|
| "enumDescriptions": [
|
| - "The ad has no restricted categories",
|
| - "The alcohol restricted category."
|
| + "A placeholder for an undefined status.\nThis value will never be returned in responses.",
|
| + "The response had no bids.",
|
| + "The response had no bids for the specified account, though it may have\nincluded bids on behalf of other accounts.",
|
| + "The response had no bids for the specified deal, though it may have\nincluded bids on other deals on behalf of the account to which the deal\nbelongs."
|
| ],
|
| - "items": {
|
| - "enum": [
|
| - "NO_RESTRICTED_CATEGORIES",
|
| - "ALCOHOL"
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "corrections": {
|
| - "description": "@OutputOnly Shows any corrections that were applied to this creative.",
|
| - "items": {
|
| - "$ref": "Correction"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "version": {
|
| - "description": "@OutputOnly The version of this creative.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "type": "string"
|
| },
|
| - "vendorIds": {
|
| - "description": "All vendor IDs for the ads that may be shown from this creative.\nSee https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt\nfor possible values.",
|
| - "items": {
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| - "type": "array"
|
| + "rowDimensions": {
|
| + "$ref": "RowDimensions",
|
| + "description": "The values of all dimensions associated with metric values in this row."
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ClientUserInvitation": {
|
| + "description": "An invitation for a new client user to get access to the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.",
|
| + "id": "ClientUserInvitation",
|
| + "properties": {
|
| + "invitationId": {
|
| + "description": "The unique numerical ID of the invitation that is sent to the user.\nThe value of this field is ignored in create operations.",
|
| + "format": "int64",
|
| + "type": "string"
|
| },
|
| - "impressionTrackingUrls": {
|
| - "description": "The set of URLs to be called to record an impression.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| + "email": {
|
| + "description": "The email address to which the invitation is sent. Email\naddresses should be unique among all client users under each sponsor\nbuyer.",
|
| + "type": "string"
|
| },
|
| - "html": {
|
| - "$ref": "HtmlContent",
|
| - "description": "An HTML creative."
|
| + "clientAccountId": {
|
| + "description": "Numerical account ID of the client buyer\nthat the invited user is associated with.\nThe value of this field is ignored in create operations.",
|
| + "format": "int64",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListFilteredImpressionsResponse": {
|
| - "description": "Response message for listing all reasons that impressions were filtered (i.e.\nnot considered as an inventory match) for the buyer.",
|
| - "id": "ListFilteredImpressionsResponse",
|
| + "ListClientUserInvitationsResponse": {
|
| + "id": "ListClientUserInvitationsResponse",
|
| "properties": {
|
| "nextPageToken": {
|
| - "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilteredImpressionsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredImpressions.list\nmethod to retrieve the next page of results.",
|
| + "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUserInvitationsRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.",
|
| "type": "string"
|
| },
|
| - "impressionsStatusRows": {
|
| - "description": "List of rows, with counts of filtered impressions aggregated by status.",
|
| + "invitations": {
|
| + "description": "The returned list of client users.",
|
| "items": {
|
| - "$ref": "ImpressionStatusRow"
|
| + "$ref": "ClientUserInvitation"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "RemoveDealAssociationRequest": {
|
| - "description": "A request for removing the association between a deal and a creative.",
|
| - "id": "RemoveDealAssociationRequest",
|
| - "properties": {
|
| - "association": {
|
| - "$ref": "CreativeDealAssociation",
|
| - "description": "The association between a creative and a deal that should be removed."
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ListCreativeStatusBreakdownByCreativeResponse": {
|
| - "description": "Response message for listing all creatives associated with a given filtered\nbid reason.",
|
| - "id": "ListCreativeStatusBreakdownByCreativeResponse",
|
| + "ListClientUsersResponse": {
|
| + "id": "ListClientUsersResponse",
|
| "properties": {
|
| "nextPageToken": {
|
| - "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByCreativeRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.creatives.list\nmethod to retrieve the next page of results.",
|
| + "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.",
|
| "type": "string"
|
| },
|
| - "filteredBidCreativeRows": {
|
| - "description": "List of rows, with counts of bids with a given creative status aggregated\nby creative.",
|
| + "users": {
|
| + "description": "The returned list of client users.",
|
| "items": {
|
| - "$ref": "FilteredBidCreativeRow"
|
| + "$ref": "ClientUser"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Client": {
|
| - "description": "A client resource represents a client buyer—an agency,\na brand, or an advertiser customer of the sponsor buyer.\nUsers associated with the client buyer have restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the client buyer.\nAll fields are required unless otherwise specified.",
|
| - "id": "Client",
|
| + "ListCreativeStatusBreakdownByDetailResponse": {
|
| + "description": "Response message for listing all details associated with a given filtered bid\nreason.",
|
| + "id": "ListCreativeStatusBreakdownByDetailResponse",
|
| "properties": {
|
| - "status": {
|
| - "description": "The status of the client buyer.",
|
| - "enum": [
|
| - "CLIENT_STATUS_UNSPECIFIED",
|
| - "DISABLED",
|
| - "ACTIVE"
|
| - ],
|
| - "enumDescriptions": [
|
| - "A placeholder for an undefined client status.",
|
| - "A client that is currently disabled.",
|
| - "A client that is currently active."
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "entityType": {
|
| - "description": "The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.",
|
| - "enum": [
|
| - "ENTITY_TYPE_UNSPECIFIED",
|
| - "ADVERTISER",
|
| - "BRAND",
|
| - "AGENCY"
|
| - ],
|
| - "enumDescriptions": [
|
| - "A placeholder for an undefined client entity type. Should not be used.",
|
| - "An advertiser.",
|
| - "A brand.",
|
| - "An advertising agency."
|
| - ],
|
| - "type": "string"
|
| + "filteredBidDetailRows": {
|
| + "description": "List of rows, with counts of bids with a given creative status aggregated\nby detail.",
|
| + "items": {
|
| + "$ref": "FilteredBidDetailRow"
|
| + },
|
| + "type": "array"
|
| },
|
| - "clientName": {
|
| - "description": "Name used to represent this client to publishers.\nYou may have multiple clients that map to the same entity,\nbut for each client the combination of `clientName` and entity\nmust be unique.\nYou can specify this field as empty.",
|
| + "nextPageToken": {
|
| + "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByDetailRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.details.list\nmethod to retrieve the next page of results.",
|
| "type": "string"
|
| },
|
| - "role": {
|
| - "description": "The role which is assigned to the client buyer. Each role implies a set of\npermissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,\n`CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.",
|
| + "detailType": {
|
| + "description": "The type of detail that the detail IDs represent.",
|
| "enum": [
|
| - "CLIENT_ROLE_UNSPECIFIED",
|
| - "CLIENT_DEAL_VIEWER",
|
| - "CLIENT_DEAL_NEGOTIATOR",
|
| - "CLIENT_DEAL_APPROVER"
|
| + "TYPE_UNSPECIFIED",
|
| + "CREATIVE_ATTRIBUTE",
|
| + "VENDOR",
|
| + "SENSITIVE_CATEGORY",
|
| + "PRODUCT_CATEGORY"
|
| ],
|
| "enumDescriptions": [
|
| - "A placeholder for an undefined client role.",
|
| - "Users associated with this client can see publisher deal offers\nin the Marketplace.\nThey can neither negotiate proposals nor approve deals.\nIf this client is visible to publishers, they can send deal proposals\nto this client.",
|
| - "Users associated with this client can respond to deal proposals\nsent to them by publishers. They can also initiate deal proposals\nof their own.",
|
| - "Users associated with this client can approve eligible deals\non your behalf. Some deals may still explicitly require publisher\nfinalization. If this role is not selected, the sponsor buyer\nwill need to manually approve each of their deals."
|
| + "A placeholder for an undefined status.\nThis value will never be returned in responses.",
|
| + "Indicates that the detail ID refers to a creative attribute; see\n[publisher-excludable-creative-attributes](https://developers.google.com/ad-exchange/rtb/downloads/publisher-excludable-creative-attributes).",
|
| + "Indicates that the detail ID refers to a vendor; see\n[vendors](https://developers.google.com/ad-exchange/rtb/downloads/vendors).",
|
| + "Indicates that the detail ID refers to a sensitive category; see\n[ad-sensitive-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-sensitive-categories).",
|
| + "Indicates that the detail ID refers to a product category; see\n[ad-product-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-product-categories)."
|
| ],
|
| "type": "string"
|
| - },
|
| - "visibleToSeller": {
|
| - "description": "Whether the client buyer will be visible to sellers.",
|
| - "type": "boolean"
|
| - },
|
| - "entityId": {
|
| - "description": "Numerical identifier of the client entity.\nThe entity can be an advertiser, a brand, or an agency.\nThis identifier is unique among all the entities with the same type.\n\nA list of all known advertisers with their identifiers is available in the\n[advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)\nfile.\n\nA list of all known brands with their identifiers is available in the\n[brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)\nfile.\n\nA list of all known agencies with their identifiers is available in the\n[agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)\nfile.",
|
| - "format": "int64",
|
| - "type": "string"
|
| - },
|
| - "clientAccountId": {
|
| - "description": "The globally-unique numerical ID of the client.\nThe value of this field is ignored in create and update operations.",
|
| - "format": "int64",
|
| - "type": "string"
|
| - },
|
| - "entityName": {
|
| - "description": "The name of the entity. This field is automatically fetched based on\nthe type and ID.\nThe value of this field is ignored in create and update operations.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Correction": {
|
| - "description": "@OutputOnly Shows any corrections that were applied to this creative.",
|
| - "id": "Correction",
|
| + "LocationContext": {
|
| + "description": "@OutputOnly The Geo criteria the restriction applies to.",
|
| + "id": "LocationContext",
|
| "properties": {
|
| - "type": {
|
| - "description": "The type of correction that was applied to the creative.",
|
| - "enum": [
|
| - "CORRECTION_TYPE_UNSPECIFIED",
|
| - "VENDOR_IDS_ADDED",
|
| - "SSL_ATTRIBUTE_REMOVED",
|
| - "FLASH_FREE_ATTRIBUTE_REMOVED",
|
| - "FLASH_FREE_ATTRIBUTE_ADDED",
|
| - "REQUIRED_ATTRIBUTE_ADDED",
|
| - "REQUIRED_VENDOR_ADDED",
|
| - "SSL_ATTRIBUTE_ADDED",
|
| - "IN_BANNER_VIDEO_ATTRIBUTE_ADDED",
|
| - "MRAID_ATTRIBUTE_ADDED",
|
| - "FLASH_ATTRIBUTE_REMOVED",
|
| - "VIDEO_IN_SNIPPET_ATTRIBUTE_ADDED"
|
| - ],
|
| - "enumDescriptions": [
|
| - "The correction type is unknown. Refer to the details for more information.",
|
| - "The ad's declared vendors did not match the vendors that were detected.\nThe detected vendors were added.",
|
| - "The ad had the SSL attribute declared but was not SSL-compliant.\nThe SSL attribute was removed.",
|
| - "The ad was declared as Flash-free but contained Flash, so the Flash-free\nattribute was removed.",
|
| - "The ad was not declared as Flash-free but it did not reference any flash\ncontent, so the Flash-free attribute was added.",
|
| - "The ad did not declare a required creative attribute.\nThe attribute was added.",
|
| - "The ad did not declare a required technology vendor.\nThe technology vendor was added.",
|
| - "The ad did not declare the SSL attribute but was SSL-compliant, so the\nSSL attribute was added.",
|
| - "Properties consistent with In-banner video were found, so an\nIn-Banner Video attribute was added.",
|
| - "The ad makes calls to the MRAID API so the MRAID attribute was added.",
|
| - "The ad unnecessarily declared the Flash attribute, so the Flash attribute\nwas removed.",
|
| - "The ad contains video content."
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "contexts": {
|
| - "description": "The contexts for the correction.",
|
| - "items": {
|
| - "$ref": "ServingContext"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "details": {
|
| - "description": "Additional details about what was corrected.",
|
| + "geoCriteriaIds": {
|
| + "description": "IDs representing the geo location for this context.\nPlease refer to the\n[geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)\nfile for different geo criteria IDs.",
|
| "items": {
|
| - "type": "string"
|
| + "format": "int32",
|
| + "type": "integer"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "FilterSet": {
|
| - "description": "A set of filters that is applied to a request for data.\nWithin a filter set, an AND operation is performed across the filters\nrepresented by each field. An OR operation is performed across the filters\nrepresented by the multiple values of a repeated field. E.g.\n\"format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR\nseller_network_id=56)\"",
|
| - "id": "FilterSet",
|
| + "PlatformContext": {
|
| + "description": "@OutputOnly The type of platform the restriction applies to.",
|
| + "id": "PlatformContext",
|
| "properties": {
|
| - "creativeId": {
|
| - "description": "The ID of the creative on which to filter; optional.",
|
| - "type": "string"
|
| - },
|
| - "relativeDateRange": {
|
| - "$ref": "RelativeDateRange",
|
| - "description": "A relative date range, defined by an offset from today and a duration.\nInterpreted relative to Pacific time zone."
|
| - },
|
| "platforms": {
|
| - "description": "The list of platforms on which to filter; may be empty. The filters\nrepresented by multiple platforms are ORed together (i.e. if non-empty,\nresults must match any one of the platforms).",
|
| + "description": "The platforms this restriction applies to.",
|
| "enumDescriptions": [
|
| - "A placeholder for an undefined platform; indicates that no platform\nfilter will be applied.",
|
| - "The ad impression appears on a desktop.",
|
| - "The ad impression appears on a tablet.",
|
| - "The ad impression appears on a mobile device."
|
| + "Desktop platform.",
|
| + "Android platform.",
|
| + "iOS platform."
|
| ],
|
| "items": {
|
| "enum": [
|
| - "PLATFORM_UNSPECIFIED",
|
| "DESKTOP",
|
| - "TABLET",
|
| - "MOBILE"
|
| + "ANDROID",
|
| + "IOS"
|
| ],
|
| "type": "string"
|
| },
|
| "type": "array"
|
| - },
|
| - "sellerNetworkIds": {
|
| - "description": "The list of IDs of the seller (publisher) networks on which to filter;\nmay be empty. The filters represented by multiple seller network IDs are\nORed together (i.e. if non-empty, results must match any one of the\npublisher networks).\nSee [seller-network-ids](https://developers.google.com/ad-exchange/rtb/downloads/seller-network-ids)\nfile for the set of existing seller network IDs.",
|
| - "items": {
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "ownerAccountId": {
|
| - "description": "The account ID of the buyer who owns this filter set.\nThe value of this field is ignored in create operations.",
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "MetricValue": {
|
| + "description": "A metric value, with an expected value and a variance; represents a count\nthat may be either exact or estimated (i.e. when sampled).",
|
| + "id": "MetricValue",
|
| + "properties": {
|
| + "variance": {
|
| + "description": "The variance (i.e. square of the standard deviation) of the metric value.\nIf value is exact, variance is 0.\nCan be used to calculate margin of error as a percentage of value, using\nthe following formula, where Z is the standard constant that depends on the\ndesired size of the confidence interval (e.g. for 90% confidence interval,\nuse Z = 1.645):\n\n marginOfError = 100 * Z * sqrt(variance) / value",
|
| "format": "int64",
|
| "type": "string"
|
| },
|
| - "absoluteDateRange": {
|
| - "$ref": "AbsoluteDateRange",
|
| - "description": "An absolute date range, defined by a start date and an end date.\nInterpreted relative to Pacific time zone."
|
| - },
|
| - "buyerAccountId": {
|
| - "description": "The ID of the buyer account on which to filter; optional.",
|
| + "value": {
|
| + "description": "The expected value of the metric.",
|
| "format": "int64",
|
| "type": "string"
|
| - },
|
| - "environment": {
|
| - "description": "The environment on which to filter; optional.",
|
| - "enum": [
|
| - "ENVIRONMENT_UNSPECIFIED",
|
| - "WEB",
|
| - "APP"
|
| - ],
|
| - "enumDescriptions": [
|
| - "A placeholder for an undefined environment; indicates that no environment\nfilter will be applied.",
|
| - "The ad impression appears on the web.",
|
| - "The ad impression appears in an app."
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "dealId": {
|
| - "description": "The ID of the deal on which to filter; optional.",
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ClientUser": {
|
| + "description": "A client user is created under a client buyer and has restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the associated client buyer.\n\nThe only way a new client user can be created is via accepting an\nemail invitation\n(see the\naccounts.clients.invitations.create\nmethod).\n\nAll fields are required unless otherwise specified.",
|
| + "id": "ClientUser",
|
| + "properties": {
|
| + "clientAccountId": {
|
| + "description": "Numerical account ID of the client buyer\nwith which the user is associated; the\nbuyer must be a client of the current sponsor buyer.\nThe value of this field is ignored in an update operation.",
|
| "format": "int64",
|
| "type": "string"
|
| },
|
| - "format": {
|
| - "description": "The format on which to filter; optional.",
|
| - "enum": [
|
| - "FORMAT_UNSPECIFIED",
|
| - "DISPLAY",
|
| - "VIDEO"
|
| - ],
|
| - "enumDescriptions": [
|
| - "A placeholder for an undefined format; indicates that no format filter\nwill be applied.",
|
| - "The ad impression is display format (i.e. an image).",
|
| - "The ad impression is video format."
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "timeSeriesGranularity": {
|
| - "description": "The granularity of time intervals if a time series breakdown is desired;\noptional.",
|
| + "status": {
|
| + "description": "The status of the client user.",
|
| "enum": [
|
| - "INTERVAL_UNSPECIFIED",
|
| - "HOURLY",
|
| - "DAILY"
|
| + "USER_STATUS_UNSPECIFIED",
|
| + "PENDING",
|
| + "ACTIVE",
|
| + "DISABLED"
|
| ],
|
| "enumDescriptions": [
|
| - "A placeholder for an unspecified interval; no time series is applied.\nAll rows in response will contain data for the entire requested time range.",
|
| - "Indicates that data will be broken down by the hour.",
|
| - "Indicates that data will be broken down by the day."
|
| + "A placeholder for an undefined user status.",
|
| + "A user who was already created but hasn't accepted the invitation yet.",
|
| + "A user that is currently active.",
|
| + "A user that is currently disabled."
|
| ],
|
| "type": "string"
|
| },
|
| - "filterSetId": {
|
| - "description": "The ID of the filter set; unique within the account of the filter set\nowner.\nThe value of this field is ignored in create operations.",
|
| + "userId": {
|
| + "description": "The unique numerical ID of the client user\nthat has accepted an invitation.\nThe value of this field is ignored in an update operation.",
|
| "format": "int64",
|
| "type": "string"
|
| },
|
| - "realtimeTimeRange": {
|
| - "$ref": "RealtimeTimeRange",
|
| - "description": "An open-ended realtime time range, defined by the aggregation start\ntimestamp."
|
| - }
|
| - },
|
| + "email": {
|
| + "description": "User's email address. The value of this field\nis ignored in an update operation.",
|
| + "type": "string"
|
| + }
|
| + },
|
| "type": "object"
|
| },
|
| - "ListDealAssociationsResponse": {
|
| - "description": "A response for listing creative and deal associations",
|
| - "id": "ListDealAssociationsResponse",
|
| + "CreativeDealAssociation": {
|
| + "description": "The association between a creative and a deal.",
|
| + "id": "CreativeDealAssociation",
|
| "properties": {
|
| - "associations": {
|
| - "description": "The list of associations.",
|
| - "items": {
|
| - "$ref": "CreativeDealAssociation"
|
| - },
|
| - "type": "array"
|
| + "accountId": {
|
| + "description": "The account the creative belongs to.",
|
| + "type": "string"
|
| },
|
| - "nextPageToken": {
|
| - "description": "A token to retrieve the next page of results.\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of results.",
|
| + "creativeId": {
|
| + "description": "The ID of the creative associated with the deal.",
|
| + "type": "string"
|
| + },
|
| + "dealsId": {
|
| + "description": "The externalDealId for the deal associated with the creative.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "CalloutStatusRow": {
|
| - "description": "The number of impressions with the specified dimension values where the\ncorresponding bid request or bid response was not successful, as described by\nthe specified callout status.",
|
| - "id": "CalloutStatusRow",
|
| + "FilteringStats": {
|
| + "description": "@OutputOnly Filtering reasons for this creative during a period of a single\nday (from midnight to midnight Pacific).",
|
| + "id": "FilteringStats",
|
| "properties": {
|
| - "rowDimensions": {
|
| - "$ref": "RowDimensions",
|
| - "description": "The values of all dimensions associated with metric values in this row."
|
| - },
|
| - "calloutStatusId": {
|
| - "description": "The ID of the callout status.\nSee [callout-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/callout-status-codes).",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "date": {
|
| + "$ref": "Date",
|
| + "description": "The day during which the data was collected.\nThe data is collected from 00:00:00 to 23:59:59 PT.\nDuring switches from PST to PDT and back, the day may\ncontain 23 or 25 hours of data instead of the usual 24."
|
| },
|
| - "impressionCount": {
|
| - "$ref": "MetricValue",
|
| - "description": "The number of impressions for which there was a bid request or bid response\nwith the specified callout status."
|
| + "reasons": {
|
| + "description": "The set of filtering reasons for this date.",
|
| + "items": {
|
| + "$ref": "Reason"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Disapproval": {
|
| - "description": "@OutputOnly The reason and details for a disapproval.",
|
| - "id": "Disapproval",
|
| + "Creative": {
|
| + "description": "A creative and its classification data.",
|
| + "id": "Creative",
|
| "properties": {
|
| - "reason": {
|
| - "description": "The categorized reason for disapproval.",
|
| + "accountId": {
|
| + "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
|
| + "type": "string"
|
| + },
|
| + "native": {
|
| + "$ref": "NativeContent",
|
| + "description": "A native creative."
|
| + },
|
| + "video": {
|
| + "$ref": "VideoContent",
|
| + "description": "A video creative."
|
| + },
|
| + "servingRestrictions": {
|
| + "description": "@OutputOnly The granular status of this ad in specific contexts.\nA context here relates to where something ultimately serves (for example,\na physical location, a platform, an HTTPS vs HTTP request, or the type\nof auction).",
|
| + "items": {
|
| + "$ref": "ServingRestriction"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "agencyId": {
|
| + "description": "The agency ID for this creative.",
|
| + "format": "int64",
|
| + "type": "string"
|
| + },
|
| + "clickThroughUrls": {
|
| + "description": "The set of destination URLs for the creative.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "detectedSensitiveCategories": {
|
| + "description": "@OutputOnly Detected sensitive categories, if any.\nSee the ad-sensitive-categories.txt file in the technical documentation for\na list of IDs. You should use these IDs along with the\nexcluded-sensitive-category field in the bid request to filter your bids.",
|
| + "items": {
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "adChoicesDestinationUrl": {
|
| + "description": "The link to AdChoices destination page.",
|
| + "type": "string"
|
| + },
|
| + "restrictedCategories": {
|
| + "description": "All restricted categories for the ads that may be shown from this creative.",
|
| + "enumDescriptions": [
|
| + "The ad has no restricted categories",
|
| + "The alcohol restricted category."
|
| + ],
|
| + "items": {
|
| + "enum": [
|
| + "NO_RESTRICTED_CATEGORIES",
|
| + "ALCOHOL"
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "corrections": {
|
| + "description": "@OutputOnly Shows any corrections that were applied to this creative.",
|
| + "items": {
|
| + "$ref": "Correction"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "version": {
|
| + "description": "@OutputOnly The version of this creative.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "vendorIds": {
|
| + "description": "All vendor IDs for the ads that may be shown from this creative.\nSee https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt\nfor possible values.",
|
| + "items": {
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "impressionTrackingUrls": {
|
| + "description": "The set of URLs to be called to record an impression.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "html": {
|
| + "$ref": "HtmlContent",
|
| + "description": "An HTML creative."
|
| + },
|
| + "dealsStatus": {
|
| + "description": "@OutputOnly The top-level deals status of this creative.\nIf disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
|
| "enum": [
|
| - "LENGTH_OF_IMAGE_ANIMATION",
|
| - "BROKEN_URL",
|
| - "MEDIA_NOT_FUNCTIONAL",
|
| - "INVALID_FOURTH_PARTY_CALL",
|
| - "INCORRECT_REMARKETING_DECLARATION",
|
| - "LANDING_PAGE_ERROR",
|
| - "AD_SIZE_DOES_NOT_MATCH_AD_SLOT",
|
| - "NO_BORDER",
|
| - "FOURTH_PARTY_BROWSER_COOKIES",
|
| - "LSO_OBJECTS",
|
| - "BLANK_CREATIVE",
|
| - "DESTINATION_URLS_UNDECLARED",
|
| - "PROBLEM_WITH_CLICK_MACRO",
|
| - "INCORRECT_AD_TECHNOLOGY_DECLARATION",
|
| - "INCORRECT_DESTINATION_URL_DECLARATION",
|
| - "EXPANDABLE_INCORRECT_DIRECTION",
|
| - "EXPANDABLE_DIRECTION_NOT_SUPPORTED",
|
| - "EXPANDABLE_INVALID_VENDOR",
|
| - "EXPANDABLE_FUNCTIONALITY",
|
| - "VIDEO_INVALID_VENDOR",
|
| - "VIDEO_UNSUPPORTED_LENGTH",
|
| - "VIDEO_UNSUPPORTED_FORMAT",
|
| - "VIDEO_FUNCTIONALITY",
|
| - "LANDING_PAGE_DISABLED",
|
| - "MALWARE_SUSPECTED",
|
| - "ADULT_IMAGE_OR_VIDEO",
|
| - "INACCURATE_AD_TEXT",
|
| - "COUNTERFEIT_DESIGNER_GOODS",
|
| - "POP_UP",
|
| - "INVALID_RTB_PROTOCOL_USAGE",
|
| - "RAW_IP_ADDRESS_IN_SNIPPET",
|
| - "UNACCEPTABLE_CONTENT_SOFTWARE",
|
| - "UNAUTHORIZED_COOKIE_ON_GOOGLE_DOMAIN",
|
| - "UNDECLARED_FLASH_OBJECTS",
|
| - "INVALID_SSL_DECLARATION",
|
| - "DIRECT_DOWNLOAD_IN_AD",
|
| - "MAXIMUM_DOWNLOAD_SIZE_EXCEEDED",
|
| - "DESTINATION_URL_SITE_NOT_CRAWLABLE",
|
| - "BAD_URL_LEGAL_DISAPPROVAL",
|
| - "PHARMA_GAMBLING_ALCOHOL_NOT_ALLOWED",
|
| - "DYNAMIC_DNS_AT_DESTINATION_URL",
|
| - "POOR_IMAGE_OR_VIDEO_QUALITY",
|
| - "UNACCEPTABLE_IMAGE_CONTENT",
|
| - "INCORRECT_IMAGE_LAYOUT",
|
| - "IRRELEVANT_IMAGE_OR_VIDEO",
|
| - "DESTINATION_SITE_DOES_NOT_ALLOW_GOING_BACK",
|
| - "MISLEADING_CLAIMS_IN_AD",
|
| - "RESTRICTED_PRODUCTS",
|
| - "UNACCEPTABLE_CONTENT",
|
| - "AUTOMATED_AD_CLICKING",
|
| - "INVALID_URL_PROTOCOL",
|
| - "UNDECLARED_RESTRICTED_CONTENT",
|
| - "INVALID_REMARKETING_LIST_USAGE",
|
| - "DESTINATION_SITE_NOT_CRAWLABLE_ROBOTS_TXT",
|
| - "CLICK_TO_DOWNLOAD_NOT_AN_APP",
|
| - "INACCURATE_REVIEW_EXTENSION",
|
| - "SEXUALLY_EXPLICIT_CONTENT",
|
| - "GAINING_AN_UNFAIR_ADVANTAGE",
|
| - "GAMING_THE_GOOGLE_NETWORK",
|
| - "DANGEROUS_PRODUCTS_KNIVES",
|
| - "DANGEROUS_PRODUCTS_EXPLOSIVES",
|
| - "DANGEROUS_PRODUCTS_GUNS",
|
| - "DANGEROUS_PRODUCTS_DRUGS",
|
| - "DANGEROUS_PRODUCTS_TOBACCO",
|
| - "DANGEROUS_PRODUCTS_WEAPONS",
|
| - "UNCLEAR_OR_IRRELEVANT_AD",
|
| - "PROFESSIONAL_STANDARDS",
|
| - "DYSFUNCTIONAL_PROMOTION",
|
| - "INVALID_INTEREST_BASED_AD",
|
| - "MISUSE_OF_PERSONAL_INFORMATION",
|
| - "OMISSION_OF_RELEVANT_INFORMATION",
|
| - "UNAVAILABLE_PROMOTIONS",
|
| - "MISLEADING_PROMOTIONS",
|
| - "INAPPROPRIATE_CONTENT",
|
| - "SENSITIVE_EVENTS",
|
| - "SHOCKING_CONTENT",
|
| - "ENABLING_DISHONEST_BEHAVIOR",
|
| - "TECHNICAL_REQUIREMENTS",
|
| - "RESTRICTED_POLITICAL_CONTENT",
|
| - "UNSUPPORTED_CONTENT",
|
| - "INVALID_BIDDING_METHOD",
|
| - "VIDEO_TOO_LONG",
|
| - "VIOLATES_JAPANESE_PHARMACY_LAW",
|
| - "UNACCREDITED_PET_PHARMACY",
|
| - "ABORTION",
|
| - "CONTRACEPTIVES",
|
| - "NEED_CERTIFICATES_TO_ADVERTISE_IN_CHINA",
|
| - "KCDSP_REGISTRATION",
|
| - "NOT_FAMILY_SAFE",
|
| - "CLINICAL_TRIAL_RECRUITMENT",
|
| - "MAXIMUM_NUMBER_OF_HTTP_CALLS_EXCEEDED",
|
| - "MAXIMUM_NUMBER_OF_COOKIES_EXCEEDED",
|
| - "PERSONAL_LOANS",
|
| - "UNSUPPORTED_FLASH_CONTENT"
|
| + "STATUS_UNSPECIFIED",
|
| + "NOT_CHECKED",
|
| + "CONDITIONALLY_APPROVED",
|
| + "APPROVED",
|
| + "DISAPPROVED"
|
| ],
|
| "enumDescriptions": [
|
| - "The length of the image animation is longer than allowed.",
|
| - "The click through URL doesn't work properly.",
|
| - "Something is wrong with the creative itself.",
|
| - "The ad makes a fourth party call to an unapproved vendor.",
|
| - "The ad targets consumers using remarketing lists and/or collects\ndata for subsequent use in retargeting, but does not correctly declare\nthat use.",
|
| - "Clicking on the ad leads to an error page.",
|
| - "The ad size when rendered does not match the declaration.",
|
| - "Ads with a white background require a border, which was missing.",
|
| - "The creative attempts to set cookies from a fourth party that is not\ncertified.",
|
| - "The creative sets an LSO object.",
|
| - "The ad serves a blank.",
|
| - "The ad uses rotation, but not all destination URLs were declared.",
|
| - "There is a problem with the way the click macro is used.",
|
| - "The ad technology declaration is not accurate.",
|
| - "The actual destination URL does not match the declared destination URL.",
|
| - "The declared expanding direction does not match the actual direction.",
|
| - "The ad does not expand in a supported direction.",
|
| - "The ad uses an expandable vendor that is not supported.",
|
| - "There was an issue with the expandable ad.",
|
| - "The ad uses a video vendor that is not supported.",
|
| - "The length of the video ad is not supported.",
|
| - "The format of the video ad is not supported.",
|
| - "There was an issue with the video ad.",
|
| - "The landing page does not conform to Ad Exchange policy.",
|
| - "The ad or the landing page may contain malware.",
|
| - "The ad contains adult images or video content.",
|
| - "The ad contains text that is unclear or inaccurate.",
|
| - "The ad promotes counterfeit designer goods.",
|
| - "The ad causes a popup window to appear.",
|
| - "The creative does not follow policies set for the RTB protocol.",
|
| - "The ad contains a URL that uses a numeric IP address for the domain.",
|
| - "The ad or landing page contains unacceptable content because it initiated\na software or executable download.",
|
| - "The ad set an unauthorized cookie on a Google domain.",
|
| - "Flash content found when no flash was declared.",
|
| - "SSL support declared but not working correctly.",
|
| - "Rich Media - Direct Download in Ad (ex. PDF download).",
|
| - "Maximum download size exceeded.",
|
| - "Bad Destination URL: Site Not Crawlable.",
|
| - "Bad URL: Legal disapproval.",
|
| - "Pharmaceuticals, Gambling, Alcohol not allowed and at least one was\ndetected.",
|
| - "Dynamic DNS at Destination URL.",
|
| - "Poor Image / Video Quality.",
|
| - "For example, Image Trick to Click.",
|
| - "Incorrect Image Layout.",
|
| - "Irrelevant Image / Video.",
|
| - "Broken back button.",
|
| - "Misleading/Inaccurate claims in ads.",
|
| - "Restricted Products.",
|
| - "Unacceptable content. For example, malware.",
|
| - "The ad automatically redirects to the destination site without a click,\nor reports a click when none were made.",
|
| - "The ad uses URL protocols that do not exist or are not allowed on AdX.",
|
| - "Restricted content (for example, alcohol) was found in the ad but not\ndeclared.",
|
| - "Violation of the remarketing list policy.",
|
| - "The destination site's robot.txt file prevents it from being crawled.",
|
| - "Click to download must link to an app.",
|
| - "A review extension must be an accurate review.",
|
| - "Sexually explicit content.",
|
| - "The ad tries to gain an unfair traffic advantage.",
|
| - "The ad tries to circumvent Google's advertising systems.",
|
| - "The ad promotes dangerous knives.",
|
| - "The ad promotes explosives.",
|
| - "The ad promotes guns & parts.",
|
| - "The ad promotes recreational drugs/services & related equipment.",
|
| - "The ad promotes tobacco products/services & related equipment.",
|
| - "The ad promotes weapons.",
|
| - "The ad is unclear or irrelevant to the destination site.",
|
| - "The ad does not meet professional standards.",
|
| - "The promotion is unnecessarily difficult to navigate.",
|
| - "Violation of Google's policy for interest-based ads.",
|
| - "Misuse of personal information.",
|
| - "Omission of relevant information.",
|
| - "Unavailable promotions.",
|
| - "Misleading or unrealistic promotions.",
|
| - "Offensive or inappropriate content.",
|
| - "Capitalizing on sensitive events.",
|
| - "Shocking content.",
|
| - "Products & Services that enable dishonest behavior.",
|
| - "The ad does not meet technical requirements.",
|
| - "Restricted political content.",
|
| - "Unsupported content.",
|
| - "Invalid bidding method.",
|
| - "Video length exceeds limits.",
|
| - "Unacceptable content: Japanese healthcare.",
|
| - "Online pharmacy ID required.",
|
| - "Unacceptable content: Abortion.",
|
| - "Unacceptable content: Birth control.",
|
| - "Restricted in China.",
|
| - "Unacceptable content: Korean healthcare.",
|
| - "Non-family safe or adult content.",
|
| - "Clinical trial recruitment.",
|
| - "Maximum number of HTTP calls exceeded.",
|
| - "Maximum number of cookies exceeded.",
|
| - "Financial service ad does not adhere to specifications.",
|
| - "Flash content was found in an unsupported context."
|
| + "The status is unknown.",
|
| + "The creative has not been checked.",
|
| + "The creative has been conditionally approved.\nSee serving_restrictions for details.",
|
| + "The creative has been approved.",
|
| + "The creative has been disapproved."
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "detectedProductCategories": {
|
| + "description": "@OutputOnly Detected product categories, if any.\nSee the ad-product-categories.txt file in the technical documentation\nfor a list of IDs.",
|
| + "items": {
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "openAuctionStatus": {
|
| + "description": "@OutputOnly The top-level open auction status of this creative.\nIf disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
|
| + "enum": [
|
| + "STATUS_UNSPECIFIED",
|
| + "NOT_CHECKED",
|
| + "CONDITIONALLY_APPROVED",
|
| + "APPROVED",
|
| + "DISAPPROVED"
|
| + ],
|
| + "enumDescriptions": [
|
| + "The status is unknown.",
|
| + "The creative has not been checked.",
|
| + "The creative has been conditionally approved.\nSee serving_restrictions for details.",
|
| + "The creative has been approved.",
|
| + "The creative has been disapproved."
|
| ],
|
| "type": "string"
|
| },
|
| - "details": {
|
| - "description": "Additional details about the reason for disapproval.",
|
| + "advertiserName": {
|
| + "description": "The name of the company being advertised in the creative.",
|
| + "type": "string"
|
| + },
|
| + "detectedAdvertiserIds": {
|
| + "description": "@OutputOnly Detected advertiser IDs, if any.",
|
| "items": {
|
| + "format": "int64",
|
| "type": "string"
|
| },
|
| "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "StopWatchingCreativeRequest": {
|
| - "description": "A request for stopping notifications for changes to creative Status.",
|
| - "id": "StopWatchingCreativeRequest",
|
| - "properties": {},
|
| - "type": "object"
|
| - },
|
| - "ServingRestriction": {
|
| - "description": "@OutputOnly A representation of the status of an ad in a\nspecific context. A context here relates to where something ultimately serves\n(for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,\nor the type of auction).",
|
| - "id": "ServingRestriction",
|
| - "properties": {
|
| - "disapprovalReasons": {
|
| - "description": "Any disapprovals bound to this restriction.\nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
|
| + },
|
| + "detectedDomains": {
|
| + "description": "@OutputOnly\nThe detected domains for this creative.",
|
| "items": {
|
| - "$ref": "Disapproval"
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| },
|
| - "contexts": {
|
| - "description": "The contexts for the restriction.",
|
| + "filteringStats": {
|
| + "$ref": "FilteringStats",
|
| + "description": "@OutputOnly The filtering stats for this creative."
|
| + },
|
| + "attributes": {
|
| + "description": "All attributes for the ads that may be shown from this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
|
| + "enumDescriptions": [
|
| + "Do not use. This is a placeholder value only.",
|
| + "The creative is tagged.",
|
| + "The creative is cookie targeted.",
|
| + "The creative is user interest targeted.",
|
| + "The creative does not expand.",
|
| + "The creative expands up.",
|
| + "The creative expands down.",
|
| + "The creative expands left.",
|
| + "The creative expands right.",
|
| + "The creative expands up and left.",
|
| + "The creative expands up and right.",
|
| + "The creative expands down and left.",
|
| + "The creative expands down and right.",
|
| + "The creative expands up or down.",
|
| + "The creative expands left or right.",
|
| + "The creative expands on any diagonal.",
|
| + "The creative expands when rolled over.",
|
| + "The instream vast video type is vpaid flash.",
|
| + "The creative is MRAID",
|
| + "The creative is SSL.",
|
| + "The creative is an interstitial.",
|
| + "The creative is eligible for native.",
|
| + "The creative is not eligible for native.",
|
| + "The creative can dynamically resize to fill a variety of slot sizes."
|
| + ],
|
| "items": {
|
| - "$ref": "ServingContext"
|
| + "enum": [
|
| + "ATTRIBUTE_UNSPECIFIED",
|
| + "IS_TAGGED",
|
| + "IS_COOKIE_TARGETED",
|
| + "IS_USER_INTEREST_TARGETED",
|
| + "EXPANDING_DIRECTION_NONE",
|
| + "EXPANDING_DIRECTION_UP",
|
| + "EXPANDING_DIRECTION_DOWN",
|
| + "EXPANDING_DIRECTION_LEFT",
|
| + "EXPANDING_DIRECTION_RIGHT",
|
| + "EXPANDING_DIRECTION_UP_LEFT",
|
| + "EXPANDING_DIRECTION_UP_RIGHT",
|
| + "EXPANDING_DIRECTION_DOWN_LEFT",
|
| + "EXPANDING_DIRECTION_DOWN_RIGHT",
|
| + "EXPANDING_DIRECTION_UP_OR_DOWN",
|
| + "EXPANDING_DIRECTION_LEFT_OR_RIGHT",
|
| + "EXPANDING_DIRECTION_ANY_DIAGONAL",
|
| + "EXPANDING_ACTION_ROLLOVER_TO_EXPAND",
|
| + "INSTREAM_VAST_VIDEO_TYPE_VPAID_FLASH",
|
| + "RICH_MEDIA_CAPABILITY_TYPE_MRAID",
|
| + "RICH_MEDIA_CAPABILITY_TYPE_SSL",
|
| + "RICH_MEDIA_CAPABILITY_TYPE_INTERSTITIAL",
|
| + "NATIVE_ELIGIBILITY_ELIGIBLE",
|
| + "NATIVE_ELIGIBILITY_NOT_ELIGIBLE",
|
| + "RENDERING_SIZELESS_ADX"
|
| + ],
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| },
|
| - "status": {
|
| - "description": "The status of the creative in this context (for example, it has been\nexplicitly disapproved or is pending review).",
|
| - "enum": [
|
| - "STATUS_UNSPECIFIED",
|
| - "DISAPPROVAL",
|
| - "PENDING_REVIEW"
|
| - ],
|
| - "enumDescriptions": [
|
| - "The status is not known.",
|
| - "The ad was disapproved in this context.",
|
| - "The ad is pending review in this context."
|
| - ],
|
| + "apiUpdateTime": {
|
| + "description": "@OutputOnly The last update timestamp of the creative via API.",
|
| + "format": "google-datetime",
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "Date": {
|
| - "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
|
| - "id": "Date",
|
| - "properties": {
|
| - "month": {
|
| - "description": "Month of year. Must be from 1 to 12.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| },
|
| - "year": {
|
| - "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "detectedLanguages": {
|
| + "description": "@OutputOnly\nThe detected languages for this creative. The order is arbitrary. The codes\nare 2 or 5 characters and are documented at\nhttps://developers.google.com/adwords/api/docs/appendix/languagecodes.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| },
|
| - "day": {
|
| - "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "creativeId": {
|
| + "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "RowDimensions": {
|
| - "description": "A response may include multiple rows, breaking down along various dimensions.\nEncapsulates the values of all dimensions for a given row.",
|
| - "id": "RowDimensions",
|
| + "RemoveDealAssociationRequest": {
|
| + "description": "A request for removing the association between a deal and a creative.",
|
| + "id": "RemoveDealAssociationRequest",
|
| "properties": {
|
| - "timeInterval": {
|
| - "$ref": "TimeInterval",
|
| - "description": "The time interval that this row represents."
|
| + "association": {
|
| + "$ref": "CreativeDealAssociation",
|
| + "description": "The association between a creative and a deal that should be removed."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Empty": {
|
| - "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
|
| - "id": "Empty",
|
| - "properties": {},
|
| - "type": "object"
|
| - },
|
| - "ListCreativeStatusAndCreativeBreakdownByDetailResponse": {
|
| - "description": "Response message for listing all details associated with a given filtered bid\nreason and a given creative.",
|
| - "id": "ListCreativeStatusAndCreativeBreakdownByDetailResponse",
|
| + "ListCreativeStatusBreakdownByCreativeResponse": {
|
| + "description": "Response message for listing all creatives associated with a given filtered\nbid reason.",
|
| + "id": "ListCreativeStatusBreakdownByCreativeResponse",
|
| "properties": {
|
| - "filteredBidDetailRows": {
|
| - "description": "List of rows, with counts of bids with a given creative status and\ncreative, aggregated by detail.",
|
| + "filteredBidCreativeRows": {
|
| + "description": "List of rows, with counts of bids with a given creative status aggregated\nby creative.",
|
| "items": {
|
| - "$ref": "FilteredBidDetailRow"
|
| + "$ref": "FilteredBidCreativeRow"
|
| },
|
| "type": "array"
|
| },
|
| "nextPageToken": {
|
| - "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusAndCreativeBreakdownByDetailRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.creatives.details.list\nmethod to retrieve the next page of results.",
|
| + "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByCreativeRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.creatives.list\nmethod to retrieve the next page of results.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Client": {
|
| + "description": "A client resource represents a client buyer—an agency,\na brand, or an advertiser customer of the sponsor buyer.\nUsers associated with the client buyer have restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the client buyer.\nAll fields are required unless otherwise specified.",
|
| + "id": "Client",
|
| + "properties": {
|
| + "role": {
|
| + "description": "The role which is assigned to the client buyer. Each role implies a set of\npermissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,\n`CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.",
|
| + "enum": [
|
| + "CLIENT_ROLE_UNSPECIFIED",
|
| + "CLIENT_DEAL_VIEWER",
|
| + "CLIENT_DEAL_NEGOTIATOR",
|
| + "CLIENT_DEAL_APPROVER"
|
| + ],
|
| + "enumDescriptions": [
|
| + "A placeholder for an undefined client role.",
|
| + "Users associated with this client can see publisher deal offers\nin the Marketplace.\nThey can neither negotiate proposals nor approve deals.\nIf this client is visible to publishers, they can send deal proposals\nto this client.",
|
| + "Users associated with this client can respond to deal proposals\nsent to them by publishers. They can also initiate deal proposals\nof their own.",
|
| + "Users associated with this client can approve eligible deals\non your behalf. Some deals may still explicitly require publisher\nfinalization. If this role is not selected, the sponsor buyer\nwill need to manually approve each of their deals."
|
| + ],
|
| "type": "string"
|
| },
|
| - "detailType": {
|
| - "description": "The type of detail that the detail IDs represent.",
|
| + "visibleToSeller": {
|
| + "description": "Whether the client buyer will be visible to sellers.",
|
| + "type": "boolean"
|
| + },
|
| + "entityId": {
|
| + "description": "Numerical identifier of the client entity.\nThe entity can be an advertiser, a brand, or an agency.\nThis identifier is unique among all the entities with the same type.\n\nA list of all known advertisers with their identifiers is available in the\n[advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)\nfile.\n\nA list of all known brands with their identifiers is available in the\n[brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)\nfile.\n\nA list of all known agencies with their identifiers is available in the\n[agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)\nfile.",
|
| + "format": "int64",
|
| + "type": "string"
|
| + },
|
| + "clientAccountId": {
|
| + "description": "The globally-unique numerical ID of the client.\nThe value of this field is ignored in create and update operations.",
|
| + "format": "int64",
|
| + "type": "string"
|
| + },
|
| + "entityName": {
|
| + "description": "The name of the entity. This field is automatically fetched based on\nthe type and ID.\nThe value of this field is ignored in create and update operations.",
|
| + "type": "string"
|
| + },
|
| + "status": {
|
| + "description": "The status of the client buyer.",
|
| "enum": [
|
| - "TYPE_UNSPECIFIED",
|
| - "CREATIVE_ATTRIBUTE",
|
| - "VENDOR",
|
| - "SENSITIVE_CATEGORY",
|
| - "PRODUCT_CATEGORY"
|
| + "CLIENT_STATUS_UNSPECIFIED",
|
| + "DISABLED",
|
| + "ACTIVE"
|
| ],
|
| "enumDescriptions": [
|
| - "A placeholder for an undefined status.\nThis value will never be returned in responses.",
|
| - "Indicates that the detail ID refers to a creative attribute; see\n[publisher-excludable-creative-attributes](https://developers.google.com/ad-exchange/rtb/downloads/publisher-excludable-creative-attributes).",
|
| - "Indicates that the detail ID refers to a vendor; see\n[vendors](https://developers.google.com/ad-exchange/rtb/downloads/vendors).",
|
| - "Indicates that the detail ID refers to a sensitive category; see\n[ad-sensitive-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-sensitive-categories).",
|
| - "Indicates that the detail ID refers to a product category; see\n[ad-product-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-product-categories)."
|
| + "A placeholder for an undefined client status.",
|
| + "A client that is currently disabled.",
|
| + "A client that is currently active."
|
| ],
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "AppContext": {
|
| - "description": "@OutputOnly The app type the restriction applies to for mobile device.",
|
| - "id": "AppContext",
|
| - "properties": {
|
| - "appTypes": {
|
| - "description": "The app types this restriction applies to.",
|
| + },
|
| + "entityType": {
|
| + "description": "The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.",
|
| + "enum": [
|
| + "ENTITY_TYPE_UNSPECIFIED",
|
| + "ADVERTISER",
|
| + "BRAND",
|
| + "AGENCY"
|
| + ],
|
| "enumDescriptions": [
|
| - "Native app context.",
|
| - "Mobile web app context."
|
| + "A placeholder for an undefined client entity type. Should not be used.",
|
| + "An advertiser.",
|
| + "A brand.",
|
| + "An advertising agency."
|
| ],
|
| - "items": {
|
| - "enum": [
|
| - "NATIVE",
|
| - "WEB"
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ListFilteredBidsResponse": {
|
| - "description": "Response message for listing all reasons that bids were filtered from the\nauction.",
|
| - "id": "ListFilteredBidsResponse",
|
| - "properties": {
|
| - "creativeStatusRows": {
|
| - "description": "List of rows, with counts of filtered bids aggregated by filtering reason\n(i.e. creative status).",
|
| - "items": {
|
| - "$ref": "CreativeStatusRow"
|
| - },
|
| - "type": "array"
|
| + "type": "string"
|
| },
|
| - "nextPageToken": {
|
| - "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.list\nmethod to retrieve the next page of results.",
|
| + "clientName": {
|
| + "description": "Name used to represent this client to publishers.\nYou may have multiple clients that map to the same entity,\nbut for each client the combination of `clientName` and entity\nmust be unique.\nYou can specify this field as empty.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "SecurityContext": {
|
| - "description": "@OutputOnly A security context.",
|
| - "id": "SecurityContext",
|
| + "Correction": {
|
| + "description": "@OutputOnly Shows any corrections that were applied to this creative.",
|
| + "id": "Correction",
|
| "properties": {
|
| - "securities": {
|
| - "description": "The security types in this context.",
|
| - "enumDescriptions": [
|
| - "Matches impressions that require insecure compatibility.",
|
| - "Matches impressions that require SSL compatibility."
|
| - ],
|
| + "details": {
|
| + "description": "Additional details about what was corrected.",
|
| "items": {
|
| - "enum": [
|
| - "INSECURE",
|
| - "SSL"
|
| - ],
|
| "type": "string"
|
| },
|
| "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "HtmlContent": {
|
| - "description": "HTML content for a creative.",
|
| - "id": "HtmlContent",
|
| - "properties": {
|
| - "snippet": {
|
| - "description": "The HTML snippet that displays the ad when inserted in the web page.",
|
| - "type": "string"
|
| - },
|
| - "height": {
|
| - "description": "The height of the HTML snippet in pixels.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| },
|
| - "width": {
|
| - "description": "The width of the HTML snippet in pixels.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ListCreativesResponse": {
|
| - "description": "A response for listing creatives.",
|
| - "id": "ListCreativesResponse",
|
| - "properties": {
|
| - "nextPageToken": {
|
| - "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativesRequest.page_token\nfield in the subsequent call to `ListCreatives` method to retrieve the next\npage of results.",
|
| + "type": {
|
| + "description": "The type of correction that was applied to the creative.",
|
| + "enum": [
|
| + "CORRECTION_TYPE_UNSPECIFIED",
|
| + "VENDOR_IDS_ADDED",
|
| + "SSL_ATTRIBUTE_REMOVED",
|
| + "FLASH_FREE_ATTRIBUTE_REMOVED",
|
| + "FLASH_FREE_ATTRIBUTE_ADDED",
|
| + "REQUIRED_ATTRIBUTE_ADDED",
|
| + "REQUIRED_VENDOR_ADDED",
|
| + "SSL_ATTRIBUTE_ADDED",
|
| + "IN_BANNER_VIDEO_ATTRIBUTE_ADDED",
|
| + "MRAID_ATTRIBUTE_ADDED",
|
| + "FLASH_ATTRIBUTE_REMOVED",
|
| + "VIDEO_IN_SNIPPET_ATTRIBUTE_ADDED"
|
| + ],
|
| + "enumDescriptions": [
|
| + "The correction type is unknown. Refer to the details for more information.",
|
| + "The ad's declared vendors did not match the vendors that were detected.\nThe detected vendors were added.",
|
| + "The ad had the SSL attribute declared but was not SSL-compliant.\nThe SSL attribute was removed.",
|
| + "The ad was declared as Flash-free but contained Flash, so the Flash-free\nattribute was removed.",
|
| + "The ad was not declared as Flash-free but it did not reference any flash\ncontent, so the Flash-free attribute was added.",
|
| + "The ad did not declare a required creative attribute.\nThe attribute was added.",
|
| + "The ad did not declare a required technology vendor.\nThe technology vendor was added.",
|
| + "The ad did not declare the SSL attribute but was SSL-compliant, so the\nSSL attribute was added.",
|
| + "Properties consistent with In-banner video were found, so an\nIn-Banner Video attribute was added.",
|
| + "The ad makes calls to the MRAID API so the MRAID attribute was added.",
|
| + "The ad unnecessarily declared the Flash attribute, so the Flash attribute\nwas removed.",
|
| + "The ad contains video content."
|
| + ],
|
| "type": "string"
|
| },
|
| - "creatives": {
|
| - "description": "The list of creatives.",
|
| + "contexts": {
|
| + "description": "The contexts for the correction.",
|
| "items": {
|
| - "$ref": "Creative"
|
| + "$ref": "ServingContext"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListFilteredBidRequestsResponse": {
|
| - "description": "Response message for listing all reasons that bid requests were filtered and\nnot sent to the buyer.",
|
| - "id": "ListFilteredBidRequestsResponse",
|
| + "FilterSet": {
|
| + "description": "A set of filters that is applied to a request for data.\nWithin a filter set, an AND operation is performed across the filters\nrepresented by each field. An OR operation is performed across the filters\nrepresented by the multiple values of a repeated field. E.g.\n\"format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR\nseller_network_id=56)\"",
|
| + "id": "FilterSet",
|
| "properties": {
|
| - "calloutStatusRows": {
|
| - "description": "List of rows, with counts of filtered bid requests aggregated by callout\nstatus.",
|
| + "sellerNetworkIds": {
|
| + "description": "The list of IDs of the seller (publisher) networks on which to filter;\nmay be empty. The filters represented by multiple seller network IDs are\nORed together (i.e. if non-empty, results must match any one of the\npublisher networks).\nSee [seller-network-ids](https://developers.google.com/ad-exchange/rtb/downloads/seller-network-ids)\nfile for the set of existing seller network IDs.",
|
| "items": {
|
| - "$ref": "CalloutStatusRow"
|
| + "format": "int32",
|
| + "type": "integer"
|
| },
|
| "type": "array"
|
| },
|
| - "nextPageToken": {
|
| - "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidRequestsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBidRequests.list\nmethod to retrieve the next page of results.",
|
| + "ownerAccountId": {
|
| + "description": "The account ID of the buyer who owns this filter set.\nThe value of this field is ignored in create operations.",
|
| + "format": "int64",
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ListBidMetricsResponse": {
|
| - "description": "Response message for listing the metrics that are measured in number of bids.",
|
| - "id": "ListBidMetricsResponse",
|
| - "properties": {
|
| - "bidMetricsRows": {
|
| - "description": "List of rows, each containing a set of bid metrics.",
|
| - "items": {
|
| - "$ref": "BidMetricsRow"
|
| - },
|
| - "type": "array"
|
| },
|
| - "nextPageToken": {
|
| - "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidMetricsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.bidMetrics.list\nmethod to retrieve the next page of results.",
|
| + "absoluteDateRange": {
|
| + "$ref": "AbsoluteDateRange",
|
| + "description": "An absolute date range, defined by a start date and an end date.\nInterpreted relative to Pacific time zone."
|
| + },
|
| + "buyerAccountId": {
|
| + "description": "The ID of the buyer account on which to filter; optional.",
|
| + "format": "int64",
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "Reason": {
|
| - "description": "A specific filtering status and how many times it occurred.",
|
| - "id": "Reason",
|
| - "properties": {
|
| - "count": {
|
| - "description": "The number of times the creative was filtered for the status. The\ncount is aggregated across all publishers on the exchange.",
|
| + },
|
| + "environment": {
|
| + "description": "The environment on which to filter; optional.",
|
| + "enum": [
|
| + "ENVIRONMENT_UNSPECIFIED",
|
| + "WEB",
|
| + "APP"
|
| + ],
|
| + "enumDescriptions": [
|
| + "A placeholder for an undefined environment; indicates that no environment\nfilter will be applied.",
|
| + "The ad impression appears on the web.",
|
| + "The ad impression appears in an app."
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "dealId": {
|
| + "description": "The ID of the deal on which to filter; optional.",
|
| "format": "int64",
|
| "type": "string"
|
| },
|
| - "status": {
|
| - "description": "The filtering status code. Please refer to the\n[creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)\nfile for different statuses.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ListLosingBidsResponse": {
|
| - "description": "Response message for listing all reasons that bids lost in the auction.",
|
| - "id": "ListLosingBidsResponse",
|
| - "properties": {
|
| - "creativeStatusRows": {
|
| - "description": "List of rows, with counts of losing bids aggregated by loss reason (i.e.\ncreative status).",
|
| + "format": {
|
| + "description": "The format on which to filter; optional.",
|
| + "enum": [
|
| + "FORMAT_UNSPECIFIED",
|
| + "DISPLAY",
|
| + "VIDEO"
|
| + ],
|
| + "enumDescriptions": [
|
| + "A placeholder for an undefined format; indicates that no format filter\nwill be applied.",
|
| + "The ad impression is display format (i.e. an image).",
|
| + "The ad impression is video format."
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "timeSeriesGranularity": {
|
| + "description": "The granularity of time intervals if a time series breakdown is desired;\noptional.",
|
| + "enum": [
|
| + "INTERVAL_UNSPECIFIED",
|
| + "HOURLY",
|
| + "DAILY"
|
| + ],
|
| + "enumDescriptions": [
|
| + "A placeholder for an unspecified interval; no time series is applied.\nAll rows in response will contain data for the entire requested time range.",
|
| + "Indicates that data will be broken down by the hour.",
|
| + "Indicates that data will be broken down by the day."
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "filterSetId": {
|
| + "description": "The ID of the filter set; unique within the account of the filter set\nowner.\nThe value of this field is ignored in create operations.",
|
| + "format": "int64",
|
| + "type": "string"
|
| + },
|
| + "realtimeTimeRange": {
|
| + "$ref": "RealtimeTimeRange",
|
| + "description": "An open-ended realtime time range, defined by the aggregation start\ntimestamp."
|
| + },
|
| + "creativeId": {
|
| + "description": "The ID of the creative on which to filter; optional.",
|
| + "type": "string"
|
| + },
|
| + "relativeDateRange": {
|
| + "$ref": "RelativeDateRange",
|
| + "description": "A relative date range, defined by an offset from today and a duration.\nInterpreted relative to Pacific time zone."
|
| + },
|
| + "platforms": {
|
| + "description": "The list of platforms on which to filter; may be empty. The filters\nrepresented by multiple platforms are ORed together (i.e. if non-empty,\nresults must match any one of the platforms).",
|
| + "enumDescriptions": [
|
| + "A placeholder for an undefined platform; indicates that no platform\nfilter will be applied.",
|
| + "The ad impression appears on a desktop.",
|
| + "The ad impression appears on a tablet.",
|
| + "The ad impression appears on a mobile device."
|
| + ],
|
| "items": {
|
| - "$ref": "CreativeStatusRow"
|
| + "enum": [
|
| + "PLATFORM_UNSPECIFIED",
|
| + "DESKTOP",
|
| + "TABLET",
|
| + "MOBILE"
|
| + ],
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| - },
|
| - "nextPageToken": {
|
| - "description": "A token to retrieve the next page of results.\nPass this value in the\nListLosingBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.losingBids.list\nmethod to retrieve the next page of results.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "VideoContent": {
|
| - "description": "Video content for a creative.",
|
| - "id": "VideoContent",
|
| + "ListDealAssociationsResponse": {
|
| + "description": "A response for listing creative and deal associations",
|
| + "id": "ListDealAssociationsResponse",
|
| "properties": {
|
| - "videoUrl": {
|
| - "description": "The URL to fetch a video ad.",
|
| + "associations": {
|
| + "description": "The list of associations.",
|
| + "items": {
|
| + "$ref": "CreativeDealAssociation"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "nextPageToken": {
|
| + "description": "A token to retrieve the next page of results.\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of results.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ImpressionMetricsRow": {
|
| - "description": "The set of metrics that are measured in numbers of impressions, representing\nhow many impressions with the specified dimension values were considered\neligible at each stage of the bidding funnel.",
|
| - "id": "ImpressionMetricsRow",
|
| + "CalloutStatusRow": {
|
| + "description": "The number of impressions with the specified dimension values where the\ncorresponding bid request or bid response was not successful, as described by\nthe specified callout status.",
|
| + "id": "CalloutStatusRow",
|
| "properties": {
|
| "rowDimensions": {
|
| "$ref": "RowDimensions",
|
| "description": "The values of all dimensions associated with metric values in this row."
|
| },
|
| - "availableImpressions": {
|
| - "$ref": "MetricValue",
|
| - "description": "The number of impressions available to the buyer on Ad Exchange.\nIn some cases this value may be unavailable."
|
| - },
|
| - "bidRequests": {
|
| - "$ref": "MetricValue",
|
| - "description": "The number of impressions for which Ad Exchange sent the buyer a bid\nrequest."
|
| - },
|
| - "inventoryMatches": {
|
| - "$ref": "MetricValue",
|
| - "description": "The number of impressions that match the buyer's inventory pretargeting."
|
| - },
|
| - "responsesWithBids": {
|
| - "$ref": "MetricValue",
|
| - "description": "The number of impressions for which Ad Exchange received a response from\nthe buyer that contained at least one applicable bid."
|
| + "calloutStatusId": {
|
| + "description": "The ID of the callout status.\nSee [callout-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/callout-status-codes).",
|
| + "format": "int32",
|
| + "type": "integer"
|
| },
|
| - "successfulResponses": {
|
| + "impressionCount": {
|
| "$ref": "MetricValue",
|
| - "description": "The number of impressions for which the buyer successfully sent a response\nto Ad Exchange."
|
| + "description": "The number of impressions for which there was a bid request or bid response\nwith the specified callout status."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "AuctionContext": {
|
| - "description": "@OutputOnly The auction type the restriction applies to.",
|
| - "id": "AuctionContext",
|
| + "Disapproval": {
|
| + "description": "@OutputOnly The reason and details for a disapproval.",
|
| + "id": "Disapproval",
|
| "properties": {
|
| - "auctionTypes": {
|
| - "description": "The auction types this restriction applies to.",
|
| + "details": {
|
| + "description": "Additional details about the reason for disapproval.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "reason": {
|
| + "description": "The categorized reason for disapproval.",
|
| + "enum": [
|
| + "LENGTH_OF_IMAGE_ANIMATION",
|
| + "BROKEN_URL",
|
| + "MEDIA_NOT_FUNCTIONAL",
|
| + "INVALID_FOURTH_PARTY_CALL",
|
| + "INCORRECT_REMARKETING_DECLARATION",
|
| + "LANDING_PAGE_ERROR",
|
| + "AD_SIZE_DOES_NOT_MATCH_AD_SLOT",
|
| + "NO_BORDER",
|
| + "FOURTH_PARTY_BROWSER_COOKIES",
|
| + "LSO_OBJECTS",
|
| + "BLANK_CREATIVE",
|
| + "DESTINATION_URLS_UNDECLARED",
|
| + "PROBLEM_WITH_CLICK_MACRO",
|
| + "INCORRECT_AD_TECHNOLOGY_DECLARATION",
|
| + "INCORRECT_DESTINATION_URL_DECLARATION",
|
| + "EXPANDABLE_INCORRECT_DIRECTION",
|
| + "EXPANDABLE_DIRECTION_NOT_SUPPORTED",
|
| + "EXPANDABLE_INVALID_VENDOR",
|
| + "EXPANDABLE_FUNCTIONALITY",
|
| + "VIDEO_INVALID_VENDOR",
|
| + "VIDEO_UNSUPPORTED_LENGTH",
|
| + "VIDEO_UNSUPPORTED_FORMAT",
|
| + "VIDEO_FUNCTIONALITY",
|
| + "LANDING_PAGE_DISABLED",
|
| + "MALWARE_SUSPECTED",
|
| + "ADULT_IMAGE_OR_VIDEO",
|
| + "INACCURATE_AD_TEXT",
|
| + "COUNTERFEIT_DESIGNER_GOODS",
|
| + "POP_UP",
|
| + "INVALID_RTB_PROTOCOL_USAGE",
|
| + "RAW_IP_ADDRESS_IN_SNIPPET",
|
| + "UNACCEPTABLE_CONTENT_SOFTWARE",
|
| + "UNAUTHORIZED_COOKIE_ON_GOOGLE_DOMAIN",
|
| + "UNDECLARED_FLASH_OBJECTS",
|
| + "INVALID_SSL_DECLARATION",
|
| + "DIRECT_DOWNLOAD_IN_AD",
|
| + "MAXIMUM_DOWNLOAD_SIZE_EXCEEDED",
|
| + "DESTINATION_URL_SITE_NOT_CRAWLABLE",
|
| + "BAD_URL_LEGAL_DISAPPROVAL",
|
| + "PHARMA_GAMBLING_ALCOHOL_NOT_ALLOWED",
|
| + "DYNAMIC_DNS_AT_DESTINATION_URL",
|
| + "POOR_IMAGE_OR_VIDEO_QUALITY",
|
| + "UNACCEPTABLE_IMAGE_CONTENT",
|
| + "INCORRECT_IMAGE_LAYOUT",
|
| + "IRRELEVANT_IMAGE_OR_VIDEO",
|
| + "DESTINATION_SITE_DOES_NOT_ALLOW_GOING_BACK",
|
| + "MISLEADING_CLAIMS_IN_AD",
|
| + "RESTRICTED_PRODUCTS",
|
| + "UNACCEPTABLE_CONTENT",
|
| + "AUTOMATED_AD_CLICKING",
|
| + "INVALID_URL_PROTOCOL",
|
| + "UNDECLARED_RESTRICTED_CONTENT",
|
| + "INVALID_REMARKETING_LIST_USAGE",
|
| + "DESTINATION_SITE_NOT_CRAWLABLE_ROBOTS_TXT",
|
| + "CLICK_TO_DOWNLOAD_NOT_AN_APP",
|
| + "INACCURATE_REVIEW_EXTENSION",
|
| + "SEXUALLY_EXPLICIT_CONTENT",
|
| + "GAINING_AN_UNFAIR_ADVANTAGE",
|
| + "GAMING_THE_GOOGLE_NETWORK",
|
| + "DANGEROUS_PRODUCTS_KNIVES",
|
| + "DANGEROUS_PRODUCTS_EXPLOSIVES",
|
| + "DANGEROUS_PRODUCTS_GUNS",
|
| + "DANGEROUS_PRODUCTS_DRUGS",
|
| + "DANGEROUS_PRODUCTS_TOBACCO",
|
| + "DANGEROUS_PRODUCTS_WEAPONS",
|
| + "UNCLEAR_OR_IRRELEVANT_AD",
|
| + "PROFESSIONAL_STANDARDS",
|
| + "DYSFUNCTIONAL_PROMOTION",
|
| + "INVALID_INTEREST_BASED_AD",
|
| + "MISUSE_OF_PERSONAL_INFORMATION",
|
| + "OMISSION_OF_RELEVANT_INFORMATION",
|
| + "UNAVAILABLE_PROMOTIONS",
|
| + "MISLEADING_PROMOTIONS",
|
| + "INAPPROPRIATE_CONTENT",
|
| + "SENSITIVE_EVENTS",
|
| + "SHOCKING_CONTENT",
|
| + "ENABLING_DISHONEST_BEHAVIOR",
|
| + "TECHNICAL_REQUIREMENTS",
|
| + "RESTRICTED_POLITICAL_CONTENT",
|
| + "UNSUPPORTED_CONTENT",
|
| + "INVALID_BIDDING_METHOD",
|
| + "VIDEO_TOO_LONG",
|
| + "VIOLATES_JAPANESE_PHARMACY_LAW",
|
| + "UNACCREDITED_PET_PHARMACY",
|
| + "ABORTION",
|
| + "CONTRACEPTIVES",
|
| + "NEED_CERTIFICATES_TO_ADVERTISE_IN_CHINA",
|
| + "KCDSP_REGISTRATION",
|
| + "NOT_FAMILY_SAFE",
|
| + "CLINICAL_TRIAL_RECRUITMENT",
|
| + "MAXIMUM_NUMBER_OF_HTTP_CALLS_EXCEEDED",
|
| + "MAXIMUM_NUMBER_OF_COOKIES_EXCEEDED",
|
| + "PERSONAL_LOANS",
|
| + "UNSUPPORTED_FLASH_CONTENT"
|
| + ],
|
| "enumDescriptions": [
|
| - "The restriction applies to open auction.",
|
| - "The restriction applies to direct deals."
|
| + "The length of the image animation is longer than allowed.",
|
| + "The click through URL doesn't work properly.",
|
| + "Something is wrong with the creative itself.",
|
| + "The ad makes a fourth party call to an unapproved vendor.",
|
| + "The ad targets consumers using remarketing lists and/or collects\ndata for subsequent use in retargeting, but does not correctly declare\nthat use.",
|
| + "Clicking on the ad leads to an error page.",
|
| + "The ad size when rendered does not match the declaration.",
|
| + "Ads with a white background require a border, which was missing.",
|
| + "The creative attempts to set cookies from a fourth party that is not\ncertified.",
|
| + "The creative sets an LSO object.",
|
| + "The ad serves a blank.",
|
| + "The ad uses rotation, but not all destination URLs were declared.",
|
| + "There is a problem with the way the click macro is used.",
|
| + "The ad technology declaration is not accurate.",
|
| + "The actual destination URL does not match the declared destination URL.",
|
| + "The declared expanding direction does not match the actual direction.",
|
| + "The ad does not expand in a supported direction.",
|
| + "The ad uses an expandable vendor that is not supported.",
|
| + "There was an issue with the expandable ad.",
|
| + "The ad uses a video vendor that is not supported.",
|
| + "The length of the video ad is not supported.",
|
| + "The format of the video ad is not supported.",
|
| + "There was an issue with the video ad.",
|
| + "The landing page does not conform to Ad Exchange policy.",
|
| + "The ad or the landing page may contain malware.",
|
| + "The ad contains adult images or video content.",
|
| + "The ad contains text that is unclear or inaccurate.",
|
| + "The ad promotes counterfeit designer goods.",
|
| + "The ad causes a popup window to appear.",
|
| + "The creative does not follow policies set for the RTB protocol.",
|
| + "The ad contains a URL that uses a numeric IP address for the domain.",
|
| + "The ad or landing page contains unacceptable content because it initiated\na software or executable download.",
|
| + "The ad set an unauthorized cookie on a Google domain.",
|
| + "Flash content found when no flash was declared.",
|
| + "SSL support declared but not working correctly.",
|
| + "Rich Media - Direct Download in Ad (ex. PDF download).",
|
| + "Maximum download size exceeded.",
|
| + "Bad Destination URL: Site Not Crawlable.",
|
| + "Bad URL: Legal disapproval.",
|
| + "Pharmaceuticals, Gambling, Alcohol not allowed and at least one was\ndetected.",
|
| + "Dynamic DNS at Destination URL.",
|
| + "Poor Image / Video Quality.",
|
| + "For example, Image Trick to Click.",
|
| + "Incorrect Image Layout.",
|
| + "Irrelevant Image / Video.",
|
| + "Broken back button.",
|
| + "Misleading/Inaccurate claims in ads.",
|
| + "Restricted Products.",
|
| + "Unacceptable content. For example, malware.",
|
| + "The ad automatically redirects to the destination site without a click,\nor reports a click when none were made.",
|
| + "The ad uses URL protocols that do not exist or are not allowed on AdX.",
|
| + "Restricted content (for example, alcohol) was found in the ad but not\ndeclared.",
|
| + "Violation of the remarketing list policy.",
|
| + "The destination site's robot.txt file prevents it from being crawled.",
|
| + "Click to download must link to an app.",
|
| + "A review extension must be an accurate review.",
|
| + "Sexually explicit content.",
|
| + "The ad tries to gain an unfair traffic advantage.",
|
| + "The ad tries to circumvent Google's advertising systems.",
|
| + "The ad promotes dangerous knives.",
|
| + "The ad promotes explosives.",
|
| + "The ad promotes guns & parts.",
|
| + "The ad promotes recreational drugs/services & related equipment.",
|
| + "The ad promotes tobacco products/services & related equipment.",
|
| + "The ad promotes weapons.",
|
| + "The ad is unclear or irrelevant to the destination site.",
|
| + "The ad does not meet professional standards.",
|
| + "The promotion is unnecessarily difficult to navigate.",
|
| + "Violation of Google's policy for interest-based ads.",
|
| + "Misuse of personal information.",
|
| + "Omission of relevant information.",
|
| + "Unavailable promotions.",
|
| + "Misleading or unrealistic promotions.",
|
| + "Offensive or inappropriate content.",
|
| + "Capitalizing on sensitive events.",
|
| + "Shocking content.",
|
| + "Products & Services that enable dishonest behavior.",
|
| + "The ad does not meet technical requirements.",
|
| + "Restricted political content.",
|
| + "Unsupported content.",
|
| + "Invalid bidding method.",
|
| + "Video length exceeds limits.",
|
| + "Unacceptable content: Japanese healthcare.",
|
| + "Online pharmacy ID required.",
|
| + "Unacceptable content: Abortion.",
|
| + "Unacceptable content: Birth control.",
|
| + "Restricted in China.",
|
| + "Unacceptable content: Korean healthcare.",
|
| + "Non-family safe or adult content.",
|
| + "Clinical trial recruitment.",
|
| + "Maximum number of HTTP calls exceeded.",
|
| + "Maximum number of cookies exceeded.",
|
| + "Financial service ad does not adhere to specifications.",
|
| + "Flash content was found in an unsupported context."
|
| ],
|
| - "items": {
|
| - "enum": [
|
| - "OPEN_AUCTION",
|
| - "DIRECT_DEALS"
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListImpressionMetricsResponse": {
|
| - "description": "Response message for listing the metrics that are measured in number of\nimpressions.",
|
| - "id": "ListImpressionMetricsResponse",
|
| - "properties": {
|
| - "nextPageToken": {
|
| - "description": "A token to retrieve the next page of results.\nPass this value in the\nListImpressionMetricsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.impressionMetrics.list\nmethod to retrieve the next page of results.",
|
| - "type": "string"
|
| - },
|
| - "impressionMetricsRows": {
|
| - "description": "List of rows, each containing a set of impression metrics.",
|
| - "items": {
|
| - "$ref": "ImpressionMetricsRow"
|
| - },
|
| - "type": "array"
|
| - }
|
| - },
|
| + "StopWatchingCreativeRequest": {
|
| + "description": "A request for stopping notifications for changes to creative Status.",
|
| + "id": "StopWatchingCreativeRequest",
|
| + "properties": {},
|
| "type": "object"
|
| },
|
| - "ImpressionStatusRow": {
|
| - "description": "The number of impressions with the specified dimension values that were\nfiltered due to the specified filtering status.",
|
| - "id": "ImpressionStatusRow",
|
| + "ServingRestriction": {
|
| + "description": "@OutputOnly A representation of the status of an ad in a\nspecific context. A context here relates to where something ultimately serves\n(for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,\nor the type of auction).",
|
| + "id": "ServingRestriction",
|
| "properties": {
|
| - "impressionCount": {
|
| - "$ref": "MetricValue",
|
| - "description": "The number of impressions that were filtered with the specified status."
|
| - },
|
| "status": {
|
| - "description": "The status for which impressions were filtered.",
|
| + "description": "The status of the creative in this context (for example, it has been\nexplicitly disapproved or is pending review).",
|
| "enum": [
|
| "STATUS_UNSPECIFIED",
|
| - "PRETARGETING_CONFIGURATIONS"
|
| + "DISAPPROVAL",
|
| + "PENDING_REVIEW"
|
| ],
|
| "enumDescriptions": [
|
| - "A placeholder for an undefined status.\nThis value will never be returned in responses.",
|
| - "The impression was filtered because it did not match the buyer's\npretargeting configurations."
|
| + "The status is not known.",
|
| + "The ad was disapproved in this context.",
|
| + "The ad is pending review in this context."
|
| ],
|
| "type": "string"
|
| },
|
| - "rowDimensions": {
|
| - "$ref": "RowDimensions",
|
| - "description": "The values of all dimensions associated with metric values in this row."
|
| + "disapprovalReasons": {
|
| + "description": "Any disapprovals bound to this restriction.\nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
|
| + "items": {
|
| + "$ref": "Disapproval"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "contexts": {
|
| + "description": "The contexts for the restriction.",
|
| + "items": {
|
| + "$ref": "ServingContext"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "BidMetricsRow": {
|
| - "description": "The set of metrics that are measured in numbers of bids, representing how\nmany bids with the specified dimension values were considered eligible at\neach stage of the bidding funnel;",
|
| - "id": "BidMetricsRow",
|
| + "Date": {
|
| + "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
|
| + "id": "Date",
|
| "properties": {
|
| - "rowDimensions": {
|
| - "$ref": "RowDimensions",
|
| - "description": "The values of all dimensions associated with metric values in this row."
|
| - },
|
| - "viewableImpressions": {
|
| - "$ref": "MetricValue",
|
| - "description": "The number of bids for which the corresponding impression was viewable (as\ndefined by Active View)."
|
| - },
|
| - "impressionsWon": {
|
| - "$ref": "MetricValue",
|
| - "description": "The number of bids that won an impression."
|
| - },
|
| - "bids": {
|
| - "$ref": "MetricValue",
|
| - "description": "The number of bids that Ad Exchange received from the buyer."
|
| + "year": {
|
| + "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| },
|
| - "billedImpressions": {
|
| - "$ref": "MetricValue",
|
| - "description": "The number of bids for which the buyer was billed."
|
| + "day": {
|
| + "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| },
|
| - "bidsInAuction": {
|
| - "$ref": "MetricValue",
|
| - "description": "The number of bids that were permitted to compete in the auction."
|
| + "month": {
|
| + "description": "Month of year. Must be from 1 to 12.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListBidResponseErrorsResponse": {
|
| - "description": "Response message for listing all reasons that bid responses resulted in an\nerror.",
|
| - "id": "ListBidResponseErrorsResponse",
|
| + "RowDimensions": {
|
| + "description": "A response may include multiple rows, breaking down along various dimensions.\nEncapsulates the values of all dimensions for a given row.",
|
| + "id": "RowDimensions",
|
| "properties": {
|
| - "calloutStatusRows": {
|
| - "description": "List of rows, with counts of bid responses aggregated by callout status.",
|
| - "items": {
|
| - "$ref": "CalloutStatusRow"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "nextPageToken": {
|
| - "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidResponseErrorsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.bidResponseErrors.list\nmethod to retrieve the next page of results.",
|
| - "type": "string"
|
| + "timeInterval": {
|
| + "$ref": "TimeInterval",
|
| + "description": "The time interval that this row represents."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "CreativeStatusRow": {
|
| - "description": "The number of bids with the specified dimension values that did not win the\nauction (either were filtered pre-auction or lost the auction), as described\nby the specified creative status.",
|
| - "id": "CreativeStatusRow",
|
| + "Empty": {
|
| + "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
|
| + "id": "Empty",
|
| + "properties": {},
|
| + "type": "object"
|
| + },
|
| + "ListCreativeStatusAndCreativeBreakdownByDetailResponse": {
|
| + "description": "Response message for listing all details associated with a given filtered bid\nreason and a given creative.",
|
| + "id": "ListCreativeStatusAndCreativeBreakdownByDetailResponse",
|
| "properties": {
|
| - "rowDimensions": {
|
| - "$ref": "RowDimensions",
|
| - "description": "The values of all dimensions associated with metric values in this row."
|
| + "detailType": {
|
| + "description": "The type of detail that the detail IDs represent.",
|
| + "enum": [
|
| + "TYPE_UNSPECIFIED",
|
| + "CREATIVE_ATTRIBUTE",
|
| + "VENDOR",
|
| + "SENSITIVE_CATEGORY",
|
| + "PRODUCT_CATEGORY"
|
| + ],
|
| + "enumDescriptions": [
|
| + "A placeholder for an undefined status.\nThis value will never be returned in responses.",
|
| + "Indicates that the detail ID refers to a creative attribute; see\n[publisher-excludable-creative-attributes](https://developers.google.com/ad-exchange/rtb/downloads/publisher-excludable-creative-attributes).",
|
| + "Indicates that the detail ID refers to a vendor; see\n[vendors](https://developers.google.com/ad-exchange/rtb/downloads/vendors).",
|
| + "Indicates that the detail ID refers to a sensitive category; see\n[ad-sensitive-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-sensitive-categories).",
|
| + "Indicates that the detail ID refers to a product category; see\n[ad-product-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-product-categories)."
|
| + ],
|
| + "type": "string"
|
| },
|
| - "creativeStatusId": {
|
| - "description": "The ID of the creative status.\nSee [creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "filteredBidDetailRows": {
|
| + "description": "List of rows, with counts of bids with a given creative status and\ncreative, aggregated by detail.",
|
| + "items": {
|
| + "$ref": "FilteredBidDetailRow"
|
| + },
|
| + "type": "array"
|
| },
|
| - "bidCount": {
|
| - "$ref": "MetricValue",
|
| - "description": "The number of bids with the specified status."
|
| + "nextPageToken": {
|
| + "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusAndCreativeBreakdownByDetailRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.creatives.details.list\nmethod to retrieve the next page of results.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "RealtimeTimeRange": {
|
| - "description": "An open-ended realtime time range specified by the start timestamp.\nFor filter sets that specify a realtime time range RTB metrics continue to\nbe aggregated throughout the lifetime of the filter set.",
|
| - "id": "RealtimeTimeRange",
|
| + "AppContext": {
|
| + "description": "@OutputOnly The app type the restriction applies to for mobile device.",
|
| + "id": "AppContext",
|
| "properties": {
|
| - "startTimestamp": {
|
| - "description": "The start timestamp of the real-time RTB metrics aggregation.",
|
| - "format": "google-datetime",
|
| - "type": "string"
|
| + "appTypes": {
|
| + "description": "The app types this restriction applies to.",
|
| + "enumDescriptions": [
|
| + "Native app context.",
|
| + "Mobile web app context."
|
| + ],
|
| + "items": {
|
| + "enum": [
|
| + "NATIVE",
|
| + "WEB"
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "FilteredBidDetailRow": {
|
| - "description": "The number of filtered bids with the specified dimension values, among those\nfiltered due to the requested filtering reason (i.e. creative status), that\nhave the specified detail.",
|
| - "id": "FilteredBidDetailRow",
|
| + "ListFilteredBidsResponse": {
|
| + "description": "Response message for listing all reasons that bids were filtered from the\nauction.",
|
| + "id": "ListFilteredBidsResponse",
|
| "properties": {
|
| - "rowDimensions": {
|
| - "$ref": "RowDimensions",
|
| - "description": "The values of all dimensions associated with metric values in this row."
|
| - },
|
| - "bidCount": {
|
| - "$ref": "MetricValue",
|
| - "description": "The number of bids with the specified detail."
|
| + "creativeStatusRows": {
|
| + "description": "List of rows, with counts of filtered bids aggregated by filtering reason\n(i.e. creative status).",
|
| + "items": {
|
| + "$ref": "CreativeStatusRow"
|
| + },
|
| + "type": "array"
|
| },
|
| - "detailId": {
|
| - "description": "The ID of the detail. The associated value can be looked up in the\ndictionary file corresponding to the DetailType in the response message.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "nextPageToken": {
|
| + "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.list\nmethod to retrieve the next page of results.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "AbsoluteDateRange": {
|
| - "description": "An absolute date range, specified by its start date and end date.\nThe supported range of dates begins 30 days before today and ends today.\nValidity checked upon filter set creation. If a filter set with an absolute\ndate range is run at a later date more than 30 days after start_date, it will\nfail.",
|
| - "id": "AbsoluteDateRange",
|
| + "SecurityContext": {
|
| + "description": "@OutputOnly A security context.",
|
| + "id": "SecurityContext",
|
| "properties": {
|
| - "startDate": {
|
| - "$ref": "Date",
|
| - "description": "The start date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor before end_date."
|
| - },
|
| - "endDate": {
|
| - "$ref": "Date",
|
| - "description": "The end date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor after start_date."
|
| + "securities": {
|
| + "description": "The security types in this context.",
|
| + "enumDescriptions": [
|
| + "Matches impressions that require insecure compatibility.",
|
| + "Matches impressions that require SSL compatibility."
|
| + ],
|
| + "items": {
|
| + "enum": [
|
| + "INSECURE",
|
| + "SSL"
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "AddDealAssociationRequest": {
|
| - "description": "A request for associating a deal and a creative.",
|
| - "id": "AddDealAssociationRequest",
|
| - "properties": {
|
| - "association": {
|
| - "$ref": "CreativeDealAssociation",
|
| - "description": "The association between a creative and a deal that should be added."
|
| + "HtmlContent": {
|
| + "description": "HTML content for a creative.",
|
| + "id": "HtmlContent",
|
| + "properties": {
|
| + "height": {
|
| + "description": "The height of the HTML snippet in pixels.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "width": {
|
| + "description": "The width of the HTML snippet in pixels.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "snippet": {
|
| + "description": "The HTML snippet that displays the ad when inserted in the web page.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "WatchCreativeRequest": {
|
| - "description": "A request for watching changes to creative Status.",
|
| - "id": "WatchCreativeRequest",
|
| + "ListCreativesResponse": {
|
| + "description": "A response for listing creatives.",
|
| + "id": "ListCreativesResponse",
|
| "properties": {
|
| - "topic": {
|
| - "description": "The Pub/Sub topic to publish notifications to.\nThis topic must already exist and must give permission to\nad-exchange-buyside-reports@google.com to write to the topic.\nThis should be the full resource name in\n\"projects/{project_id}/topics/{topic_id}\" format.",
|
| + "creatives": {
|
| + "description": "The list of creatives.",
|
| + "items": {
|
| + "$ref": "Creative"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "nextPageToken": {
|
| + "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativesRequest.page_token\nfield in the subsequent call to `ListCreatives` method to retrieve the next\npage of results.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "TimeInterval": {
|
| - "description": "An interval of time, with an absolute start and end.\nThis is included in the response, for several reasons:\n1) The request may have specified start or end times relative to the time the\n request was sent; the response indicates the corresponding absolute time\n interval.\n2) The request may have specified an end time past the latest time for which\n data was available (e.g. if requesting data for the today); the response\n indicates the latest time for which data was actually returned.\n3) The response data for a single request may be broken down into multiple\n time intervals, if a time series was requested.",
|
| - "id": "TimeInterval",
|
| + "ListFilteredBidRequestsResponse": {
|
| + "description": "Response message for listing all reasons that bid requests were filtered and\nnot sent to the buyer.",
|
| + "id": "ListFilteredBidRequestsResponse",
|
| "properties": {
|
| - "endTime": {
|
| - "description": "The timestamp marking the end of the range (exclusive) for which data is\nincluded.",
|
| - "format": "google-datetime",
|
| - "type": "string"
|
| + "calloutStatusRows": {
|
| + "description": "List of rows, with counts of filtered bid requests aggregated by callout\nstatus.",
|
| + "items": {
|
| + "$ref": "CalloutStatusRow"
|
| + },
|
| + "type": "array"
|
| },
|
| - "startTime": {
|
| - "description": "The timestamp marking the start of the range (inclusive) for which data is\nincluded.",
|
| - "format": "google-datetime",
|
| + "nextPageToken": {
|
| + "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidRequestsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBidRequests.list\nmethod to retrieve the next page of results.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "FilteredBidCreativeRow": {
|
| - "description": "The number of filtered bids with the specified dimension values that have the\nspecified creative.",
|
| - "id": "FilteredBidCreativeRow",
|
| + "ListBidMetricsResponse": {
|
| + "description": "Response message for listing the metrics that are measured in number of bids.",
|
| + "id": "ListBidMetricsResponse",
|
| "properties": {
|
| - "rowDimensions": {
|
| - "$ref": "RowDimensions",
|
| - "description": "The values of all dimensions associated with metric values in this row."
|
| - },
|
| - "bidCount": {
|
| - "$ref": "MetricValue",
|
| - "description": "The number of bids with the specified creative."
|
| + "bidMetricsRows": {
|
| + "description": "List of rows, each containing a set of bid metrics.",
|
| + "items": {
|
| + "$ref": "BidMetricsRow"
|
| + },
|
| + "type": "array"
|
| },
|
| - "creativeId": {
|
| - "description": "The ID of the creative.",
|
| + "nextPageToken": {
|
| + "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidMetricsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.bidMetrics.list\nmethod to retrieve the next page of results.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "RelativeDateRange": {
|
| - "description": "A relative date range, specified by an offset and a duration.\nThe supported range of dates begins 30 days before today and ends today.\nI.e. the limits for these values are:\noffset_days >= 0\nduration_days >= 1\noffset_days + duration_days <= 30",
|
| - "id": "RelativeDateRange",
|
| + "Reason": {
|
| + "description": "A specific filtering status and how many times it occurred.",
|
| + "id": "Reason",
|
| "properties": {
|
| - "durationDays": {
|
| - "description": "The number of days in the requested date range. E.g. for a range spanning\ntoday, 1. For a range spanning the last 7 days, 7.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "count": {
|
| + "description": "The number of times the creative was filtered for the status. The\ncount is aggregated across all publishers on the exchange.",
|
| + "format": "int64",
|
| + "type": "string"
|
| },
|
| - "offsetDays": {
|
| - "description": "The end date of the filter set, specified as the number of days before\ntoday. E.g. for a range where the last date is today, 0.",
|
| + "status": {
|
| + "description": "The filtering status code. Please refer to the\n[creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)\nfile for different statuses.",
|
| "format": "int32",
|
| "type": "integer"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "NativeContent": {
|
| - "description": "Native content for a creative.",
|
| - "id": "NativeContent",
|
| + "VideoContent": {
|
| + "description": "Video content for a creative.",
|
| + "id": "VideoContent",
|
| "properties": {
|
| - "advertiserName": {
|
| - "description": "The name of the advertiser or sponsor, to be displayed in the ad creative.",
|
| - "type": "string"
|
| - },
|
| - "storeUrl": {
|
| - "description": "The URL to the app store to purchase/download the promoted app.",
|
| - "type": "string"
|
| - },
|
| - "headline": {
|
| - "description": "A short title for the ad.",
|
| - "type": "string"
|
| - },
|
| - "appIcon": {
|
| - "$ref": "Image",
|
| - "description": "The app icon, for app download ads."
|
| - },
|
| - "callToAction": {
|
| - "description": "A label for the button that the user is supposed to click.",
|
| - "type": "string"
|
| - },
|
| - "body": {
|
| - "description": "A long description of the ad.",
|
| - "type": "string"
|
| - },
|
| - "starRating": {
|
| - "description": "The app rating in the app store. Must be in the range [0-5].",
|
| - "format": "double",
|
| - "type": "number"
|
| - },
|
| "videoUrl": {
|
| - "description": "The URL to fetch a native video ad.",
|
| - "type": "string"
|
| - },
|
| - "logo": {
|
| - "$ref": "Image",
|
| - "description": "A smaller image, for the advertiser's logo."
|
| - },
|
| - "clickLinkUrl": {
|
| - "description": "The URL that the browser/SDK will load when the user clicks the ad.",
|
| - "type": "string"
|
| - },
|
| - "priceDisplayText": {
|
| - "description": "The price of the promoted app including currency info.",
|
| + "description": "The URL to fetch a video ad.",
|
| "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ListLosingBidsResponse": {
|
| + "description": "Response message for listing all reasons that bids lost in the auction.",
|
| + "id": "ListLosingBidsResponse",
|
| + "properties": {
|
| + "creativeStatusRows": {
|
| + "description": "List of rows, with counts of losing bids aggregated by loss reason (i.e.\ncreative status).",
|
| + "items": {
|
| + "$ref": "CreativeStatusRow"
|
| + },
|
| + "type": "array"
|
| },
|
| - "clickTrackingUrl": {
|
| - "description": "The URL to use for click tracking.",
|
| + "nextPageToken": {
|
| + "description": "A token to retrieve the next page of results.\nPass this value in the\nListLosingBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.losingBids.list\nmethod to retrieve the next page of results.",
|
| "type": "string"
|
| - },
|
| - "image": {
|
| - "$ref": "Image",
|
| - "description": "A large image."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListClientsResponse": {
|
| - "id": "ListClientsResponse",
|
| + "ListNonBillableWinningBidsResponse": {
|
| + "description": "Response message for listing all reasons for which a buyer was not billed for\na winning bid.",
|
| + "id": "ListNonBillableWinningBidsResponse",
|
| "properties": {
|
| "nextPageToken": {
|
| - "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientsRequest.pageToken\nfield in the subsequent call to the\naccounts.clients.list method\nto retrieve the next page of results.",
|
| + "description": "A token to retrieve the next page of results.\nPass this value in the\nListNonBillableWinningBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.nonBillableWinningBids.list\nmethod to retrieve the next page of results.",
|
| "type": "string"
|
| },
|
| - "clients": {
|
| - "description": "The returned list of clients.",
|
| + "nonBillableWinningBidStatusRows": {
|
| + "description": "List of rows, with counts of bids not billed aggregated by reason.",
|
| "items": {
|
| - "$ref": "Client"
|
| + "$ref": "NonBillableWinningBidStatusRow"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListBidResponsesWithoutBidsResponse": {
|
| - "description": "Response message for listing all reasons that bid responses were considered\nto have no applicable bids.",
|
| - "id": "ListBidResponsesWithoutBidsResponse",
|
| + "ImpressionMetricsRow": {
|
| + "description": "The set of metrics that are measured in numbers of impressions, representing\nhow many impressions with the specified dimension values were considered\neligible at each stage of the bidding funnel.",
|
| + "id": "ImpressionMetricsRow",
|
| "properties": {
|
| - "bidResponseWithoutBidsStatusRows": {
|
| - "description": "List of rows, with counts of bid responses without bids aggregated by\nstatus.",
|
| - "items": {
|
| - "$ref": "BidResponseWithoutBidsStatusRow"
|
| - },
|
| - "type": "array"
|
| + "rowDimensions": {
|
| + "$ref": "RowDimensions",
|
| + "description": "The values of all dimensions associated with metric values in this row."
|
| },
|
| - "nextPageToken": {
|
| - "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidResponsesWithoutBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.bidResponsesWithoutBids.list\nmethod to retrieve the next page of results.",
|
| - "type": "string"
|
| + "availableImpressions": {
|
| + "$ref": "MetricValue",
|
| + "description": "The number of impressions available to the buyer on Ad Exchange.\nIn some cases this value may be unavailable."
|
| + },
|
| + "inventoryMatches": {
|
| + "$ref": "MetricValue",
|
| + "description": "The number of impressions that match the buyer's inventory pretargeting."
|
| + },
|
| + "bidRequests": {
|
| + "$ref": "MetricValue",
|
| + "description": "The number of impressions for which Ad Exchange sent the buyer a bid\nrequest."
|
| + },
|
| + "responsesWithBids": {
|
| + "$ref": "MetricValue",
|
| + "description": "The number of impressions for which Ad Exchange received a response from\nthe buyer that contained at least one applicable bid."
|
| + },
|
| + "successfulResponses": {
|
| + "$ref": "MetricValue",
|
| + "description": "The number of impressions for which the buyer successfully sent a response\nto Ad Exchange."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ServingContext": {
|
| - "description": "The serving context for this restriction.",
|
| - "id": "ServingContext",
|
| + "AuctionContext": {
|
| + "description": "@OutputOnly The auction type the restriction applies to.",
|
| + "id": "AuctionContext",
|
| "properties": {
|
| - "auctionType": {
|
| - "$ref": "AuctionContext",
|
| - "description": "Matches impressions for a particular auction type."
|
| - },
|
| - "all": {
|
| - "description": "Matches all contexts.",
|
| - "enum": [
|
| - "SIMPLE_CONTEXT"
|
| - ],
|
| + "auctionTypes": {
|
| + "description": "The auction types this restriction applies to.",
|
| "enumDescriptions": [
|
| - "A simple context."
|
| + "The restriction applies to open auction.",
|
| + "The restriction applies to direct deals."
|
| ],
|
| - "type": "string"
|
| - },
|
| - "appType": {
|
| - "$ref": "AppContext",
|
| - "description": "Matches impressions for a particular app type."
|
| - },
|
| - "securityType": {
|
| - "$ref": "SecurityContext",
|
| - "description": "Matches impressions for a particular security type."
|
| - },
|
| - "platform": {
|
| - "$ref": "PlatformContext",
|
| - "description": "Matches impressions coming from a particular platform."
|
| + "items": {
|
| + "enum": [
|
| + "OPEN_AUCTION",
|
| + "DIRECT_DEALS"
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ListImpressionMetricsResponse": {
|
| + "description": "Response message for listing the metrics that are measured in number of\nimpressions.",
|
| + "id": "ListImpressionMetricsResponse",
|
| + "properties": {
|
| + "nextPageToken": {
|
| + "description": "A token to retrieve the next page of results.\nPass this value in the\nListImpressionMetricsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.impressionMetrics.list\nmethod to retrieve the next page of results.",
|
| + "type": "string"
|
| },
|
| - "location": {
|
| - "$ref": "LocationContext",
|
| - "description": "Matches impressions coming from users *or* publishers in a specific\nlocation."
|
| + "impressionMetricsRows": {
|
| + "description": "List of rows, each containing a set of impression metrics.",
|
| + "items": {
|
| + "$ref": "ImpressionMetricsRow"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Image": {
|
| - "description": "An image resource. You may provide a larger image than was requested,\nso long as the aspect ratio is preserved.",
|
| - "id": "Image",
|
| + "BidMetricsRow": {
|
| + "description": "The set of metrics that are measured in numbers of bids, representing how\nmany bids with the specified dimension values were considered eligible at\neach stage of the bidding funnel;",
|
| + "id": "BidMetricsRow",
|
| "properties": {
|
| - "height": {
|
| - "description": "Image height in pixels.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "bidsInAuction": {
|
| + "$ref": "MetricValue",
|
| + "description": "The number of bids that were permitted to compete in the auction."
|
| },
|
| - "width": {
|
| - "description": "Image width in pixels.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "rowDimensions": {
|
| + "$ref": "RowDimensions",
|
| + "description": "The values of all dimensions associated with metric values in this row."
|
| },
|
| - "url": {
|
| - "description": "The URL of the image.",
|
| - "type": "string"
|
| + "viewableImpressions": {
|
| + "$ref": "MetricValue",
|
| + "description": "The number of bids for which the corresponding impression was viewable (as\ndefined by Active View)."
|
| + },
|
| + "impressionsWon": {
|
| + "$ref": "MetricValue",
|
| + "description": "The number of bids that won an impression."
|
| + },
|
| + "measurableImpressions": {
|
| + "$ref": "MetricValue",
|
| + "description": "The number of bids for which the corresponding impression was measurable\nfor viewability (as defined by Active View)."
|
| + },
|
| + "bids": {
|
| + "$ref": "MetricValue",
|
| + "description": "The number of bids that Ad Exchange received from the buyer."
|
| + },
|
| + "billedImpressions": {
|
| + "$ref": "MetricValue",
|
| + "description": "The number of bids for which the buyer was billed."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListFilterSetsResponse": {
|
| - "description": "Response message for listing filter sets.",
|
| - "id": "ListFilterSetsResponse",
|
| + "ListBidResponseErrorsResponse": {
|
| + "description": "Response message for listing all reasons that bid responses resulted in an\nerror.",
|
| + "id": "ListBidResponseErrorsResponse",
|
| "properties": {
|
| - "filterSets": {
|
| - "description": "The filter sets belonging to the buyer.",
|
| + "calloutStatusRows": {
|
| + "description": "List of rows, with counts of bid responses aggregated by callout status.",
|
| "items": {
|
| - "$ref": "FilterSet"
|
| + "$ref": "CalloutStatusRow"
|
| },
|
| "type": "array"
|
| },
|
| "nextPageToken": {
|
| - "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilterSetsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.list\nmethod to retrieve the next page of results.",
|
| + "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidResponseErrorsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.bidResponseErrors.list\nmethod to retrieve the next page of results.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "BidResponseWithoutBidsStatusRow": {
|
| - "description": "The number of impressions with the specified dimension values that were\nconsidered to have no applicable bids, as described by the specified status.",
|
| - "id": "BidResponseWithoutBidsStatusRow",
|
| + "CreativeStatusRow": {
|
| + "description": "The number of bids with the specified dimension values that did not win the\nauction (either were filtered pre-auction or lost the auction), as described\nby the specified creative status.",
|
| + "id": "CreativeStatusRow",
|
| "properties": {
|
| - "impressionCount": {
|
| - "$ref": "MetricValue",
|
| - "description": "The number of impressions for which there was a bid response with the\nspecified status."
|
| - },
|
| - "status": {
|
| - "description": "The status that caused the bid response to be considered to have no\napplicable bids.",
|
| - "enum": [
|
| - "STATUS_UNSPECIFIED",
|
| - "RESPONSES_WITHOUT_BIDS",
|
| - "RESPONSES_WITHOUT_BIDS_FOR_ACCOUNT",
|
| - "RESPONSES_WITHOUT_BIDS_FOR_DEAL"
|
| - ],
|
| - "enumDescriptions": [
|
| - "A placeholder for an undefined status.\nThis value will never be returned in responses.",
|
| - "The response had no bids.",
|
| - "The response had no bids for the specified account, though it may have\nincluded bids on behalf of other accounts.",
|
| - "The response had no bids for the specified deal, though it may have\nincluded bids on other deals on behalf of the account to which the deal\nbelongs."
|
| - ],
|
| - "type": "string"
|
| - },
|
| "rowDimensions": {
|
| "$ref": "RowDimensions",
|
| "description": "The values of all dimensions associated with metric values in this row."
|
| + },
|
| + "creativeStatusId": {
|
| + "description": "The ID of the creative status.\nSee [creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "bidCount": {
|
| + "$ref": "MetricValue",
|
| + "description": "The number of bids with the specified status."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ClientUserInvitation": {
|
| - "description": "An invitation for a new client user to get access to the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.",
|
| - "id": "ClientUserInvitation",
|
| + "RealtimeTimeRange": {
|
| + "description": "An open-ended realtime time range specified by the start timestamp.\nFor filter sets that specify a realtime time range RTB metrics continue to\nbe aggregated throughout the lifetime of the filter set.",
|
| + "id": "RealtimeTimeRange",
|
| "properties": {
|
| - "invitationId": {
|
| - "description": "The unique numerical ID of the invitation that is sent to the user.\nThe value of this field is ignored in create operations.",
|
| - "format": "int64",
|
| - "type": "string"
|
| - },
|
| - "email": {
|
| - "description": "The email address to which the invitation is sent. Email\naddresses should be unique among all client users under each sponsor\nbuyer.",
|
| - "type": "string"
|
| - },
|
| - "clientAccountId": {
|
| - "description": "Numerical account ID of the client buyer\nthat the invited user is associated with.\nThe value of this field is ignored in create operations.",
|
| - "format": "int64",
|
| + "startTimestamp": {
|
| + "description": "The start timestamp of the real-time RTB metrics aggregation.",
|
| + "format": "google-datetime",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListCreativeStatusBreakdownByDetailResponse": {
|
| - "description": "Response message for listing all details associated with a given filtered bid\nreason.",
|
| - "id": "ListCreativeStatusBreakdownByDetailResponse",
|
| + "NonBillableWinningBidStatusRow": {
|
| + "description": "The number of winning bids with the specified dimension values for which the\nbuyer was not billed, as described by the specified status.",
|
| + "id": "NonBillableWinningBidStatusRow",
|
| "properties": {
|
| - "detailType": {
|
| - "description": "The type of detail that the detail IDs represent.",
|
| + "bidCount": {
|
| + "$ref": "MetricValue",
|
| + "description": "The number of bids with the specified status."
|
| + },
|
| + "status": {
|
| + "description": "The status specifying why the winning bids were not billed.",
|
| "enum": [
|
| - "TYPE_UNSPECIFIED",
|
| - "CREATIVE_ATTRIBUTE",
|
| - "VENDOR",
|
| - "SENSITIVE_CATEGORY",
|
| - "PRODUCT_CATEGORY"
|
| + "STATUS_UNSPECIFIED",
|
| + "AD_NOT_RENDERED",
|
| + "INVALID_IMPRESSION"
|
| ],
|
| "enumDescriptions": [
|
| "A placeholder for an undefined status.\nThis value will never be returned in responses.",
|
| - "Indicates that the detail ID refers to a creative attribute; see\n[publisher-excludable-creative-attributes](https://developers.google.com/ad-exchange/rtb/downloads/publisher-excludable-creative-attributes).",
|
| - "Indicates that the detail ID refers to a vendor; see\n[vendors](https://developers.google.com/ad-exchange/rtb/downloads/vendors).",
|
| - "Indicates that the detail ID refers to a sensitive category; see\n[ad-sensitive-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-sensitive-categories).",
|
| - "Indicates that the detail ID refers to a product category; see\n[ad-product-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-product-categories)."
|
| + "The buyer was not billed because the ad was not rendered by the\npublisher.",
|
| + "The buyer was not billed because the impression won by the bid was\ndetermined to be invalid."
|
| ],
|
| "type": "string"
|
| },
|
| - "filteredBidDetailRows": {
|
| - "description": "List of rows, with counts of bids with a given creative status aggregated\nby detail.",
|
| - "items": {
|
| - "$ref": "FilteredBidDetailRow"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "nextPageToken": {
|
| - "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByDetailRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.details.list\nmethod to retrieve the next page of results.",
|
| - "type": "string"
|
| + "rowDimensions": {
|
| + "$ref": "RowDimensions",
|
| + "description": "The values of all dimensions associated with metric values in this row."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListClientUsersResponse": {
|
| - "id": "ListClientUsersResponse",
|
| + "FilteredBidDetailRow": {
|
| + "description": "The number of filtered bids with the specified dimension values, among those\nfiltered due to the requested filtering reason (i.e. creative status), that\nhave the specified detail.",
|
| + "id": "FilteredBidDetailRow",
|
| "properties": {
|
| - "nextPageToken": {
|
| - "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.",
|
| - "type": "string"
|
| + "bidCount": {
|
| + "$ref": "MetricValue",
|
| + "description": "The number of bids with the specified detail."
|
| },
|
| - "users": {
|
| - "description": "The returned list of client users.",
|
| - "items": {
|
| - "$ref": "ClientUser"
|
| - },
|
| - "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ListClientUserInvitationsResponse": {
|
| - "id": "ListClientUserInvitationsResponse",
|
| - "properties": {
|
| - "nextPageToken": {
|
| - "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUserInvitationsRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.",
|
| - "type": "string"
|
| + "detailId": {
|
| + "description": "The ID of the detail. The associated value can be looked up in the\ndictionary file corresponding to the DetailType in the response message.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| },
|
| - "invitations": {
|
| - "description": "The returned list of client users.",
|
| - "items": {
|
| - "$ref": "ClientUserInvitation"
|
| - },
|
| - "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "LocationContext": {
|
| - "description": "@OutputOnly The Geo criteria the restriction applies to.",
|
| - "id": "LocationContext",
|
| - "properties": {
|
| - "geoCriteriaIds": {
|
| - "description": "IDs representing the geo location for this context.\nPlease refer to the\n[geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)\nfile for different geo criteria IDs.",
|
| - "items": {
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| - "type": "array"
|
| + "rowDimensions": {
|
| + "$ref": "RowDimensions",
|
| + "description": "The values of all dimensions associated with metric values in this row."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "PlatformContext": {
|
| - "description": "@OutputOnly The type of platform the restriction applies to.",
|
| - "id": "PlatformContext",
|
| + "AbsoluteDateRange": {
|
| + "description": "An absolute date range, specified by its start date and end date.\nThe supported range of dates begins 30 days before today and ends today.\nValidity checked upon filter set creation. If a filter set with an absolute\ndate range is run at a later date more than 30 days after start_date, it will\nfail.",
|
| + "id": "AbsoluteDateRange",
|
| "properties": {
|
| - "platforms": {
|
| - "description": "The platforms this restriction applies to.",
|
| - "enumDescriptions": [
|
| - "Desktop platform.",
|
| - "Android platform.",
|
| - "iOS platform."
|
| - ],
|
| - "items": {
|
| - "enum": [
|
| - "DESKTOP",
|
| - "ANDROID",
|
| - "IOS"
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| + "startDate": {
|
| + "$ref": "Date",
|
| + "description": "The start date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor before end_date."
|
| + },
|
| + "endDate": {
|
| + "$ref": "Date",
|
| + "description": "The end date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor after start_date."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "MetricValue": {
|
| - "description": "A metric value, with an expected value and a variance; represents a count\nthat may be either exact or estimated (i.e. when sampled).",
|
| - "id": "MetricValue",
|
| + "AddDealAssociationRequest": {
|
| + "description": "A request for associating a deal and a creative.",
|
| + "id": "AddDealAssociationRequest",
|
| "properties": {
|
| - "variance": {
|
| - "description": "The variance (i.e. square of the standard deviation) of the metric value.\nIf value is exact, variance is 0.\nCan be used to calculate margin of error as a percentage of value, using\nthe following formula, where Z is the standard constant that depends on the\ndesired size of the confidence interval (e.g. for 90% confidence interval,\nuse Z = 1.645):\n\n marginOfError = 100 * Z * sqrt(variance) / value",
|
| - "format": "int64",
|
| - "type": "string"
|
| - },
|
| - "value": {
|
| - "description": "The expected value of the metric.",
|
| - "format": "int64",
|
| - "type": "string"
|
| + "association": {
|
| + "$ref": "CreativeDealAssociation",
|
| + "description": "The association between a creative and a deal that should be added."
|
| }
|
| },
|
| "type": "object"
|
|
|
Chromium Code Reviews
Issue 2973303002:
Api-Roll 51: 2017-07-10 (Closed)
