Google Git
Sign in
code / google-api-go-client / 9e2045da407b8bc1df9bc5c14d4d1a7e7e182e05 / . / adexchangebuyer2 / v2beta1 / adexchangebuyer2-api.json
blob: 1a716bb95c396c28a5e12ebff096d9aa0a967c4f [file] [log] [blame]
{
"canonicalName": "AdExchangeBuyerII",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/adexchange.buyer": {
"description": "Manage your Ad Exchange buyer account configuration"
}
}
}
},
"rootUrl": "https://adexchangebuyer.googleapis.com/",
"ownerDomain": "google.com",
"name": "adexchangebuyer2",
"batchPath": "batch",
"title": "Ad Exchange Buyer API II",
"ownerName": "Google",
"resources": {
"accounts": {
"resources": {
"creatives": {
"methods": {
"get": {
"path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
"id": "adexchangebuyer2.accounts.creatives.get",
"description": "Gets a creative.",
"httpMethod": "GET",
"parameterOrder": [
"accountId",
"creativeId"
],
"response": {
"$ref": "Creative"
},
"parameters": {
"accountId": {
"location": "path",
"description": "The account the creative belongs to.",
"type": "string",
"required": true
},
"creativeId": {
"location": "path",
"description": "The ID of the creative to retrieve.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}"
},
"watch": {
"description": "Watches a creative. Will result in push notifications being sent to the\ntopic when the creative changes status.",
"request": {
"$ref": "WatchCreativeRequest"
},
"httpMethod": "POST",
"parameterOrder": [
"accountId",
"creativeId"
],
"response": {
"$ref": "Empty"
},
"parameters": {
"accountId": {
"description": "The account of the creative to watch.",
"type": "string",
"required": true,
"location": "path"
},
"creativeId": {
"location": "path",
"description": "The creative ID to watch for status changes.\nSpecify \"-\" to watch all creatives under the above account.\nIf both creative-level and account-level notifications are\nsent, only a single notification will be sent to the\ncreative-level notification topic.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
"path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
"id": "adexchangebuyer2.accounts.creatives.watch"
},
"update": {
"response": {
"$ref": "Creative"
},
"parameterOrder": [
"accountId",
"creativeId"
],
"httpMethod": "PUT",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
"creativeId": {
"description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
"type": "string",
"required": true,
"location": "path"
},
"accountId": {
"description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
"type": "string",
"required": true,
"location": "path"
}
},
"flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
"id": "adexchangebuyer2.accounts.creatives.update",
"path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
"request": {
"$ref": "Creative"
},
"description": "Updates a creative."
},
"list": {
"response": {
"$ref": "ListCreativesResponse"
},
"parameterOrder": [
"accountId"
],
"httpMethod": "GET",
"parameters": {
"pageToken": {
"location": "query",
"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.",
"type": "string"
},
"pageSize": {
"format": "int32",
"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.",
"type": "integer",
"location": "query"
},
"accountId": {
"location": "path",
"description": "The account to list the creatives from.\nSpecify \"-\" to list all creatives the current user has access to.",
"type": "string",
"required": true
},
"query": {
"location": "query",
"description": "An optional query string to filter creatives. If no filter is specified,\nall active creatives will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eattribute: {a numeric attribute from the list of attributes}\n\u003cli\u003edisapprovalReason: {a reason from\nDisapprovalReason\n\u003c/ul\u003e\nExample: 'accountId=12345 AND (dealsStatus:disapproved AND\ndisapprovalReason:unacceptable_content) OR attribute:47'",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"flatPath": "v2beta1/accounts/{accountId}/creatives",
"id": "adexchangebuyer2.accounts.creatives.list",
"path": "v2beta1/accounts/{accountId}/creatives",
"description": "Lists creatives."
},
"create": {
"httpMethod": "POST",
"parameterOrder": [
"accountId"
],
"response": {
"$ref": "Creative"
},
"parameters": {
"accountId": {
"location": "path",
"description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
"type": "string",
"required": true
},
"duplicateIdMode": {
"enum": [
"NO_DUPLICATES",
"FORCE_ENABLE_DUPLICATE_IDS"
],
"description": "Indicates if multiple creatives can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).",
"type": "string",
"location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"flatPath": "v2beta1/accounts/{accountId}/creatives",
"path": "v2beta1/accounts/{accountId}/creatives",
"id": "adexchangebuyer2.accounts.creatives.create",
"description": "Creates a creative.",
"request": {
"$ref": "Creative"
}
},
"stopWatching": {
"id": "adexchangebuyer2.accounts.creatives.stopWatching",
"path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
"description": "Stops watching a creative. Will stop push notifications being sent to the\ntopics when the creative changes status.",
"request": {
"$ref": "StopWatchingCreativeRequest"
},
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"accountId",
"creativeId"
],
"httpMethod": "POST",
"parameters": {
"accountId": {
"description": "The account of the creative to stop notifications for.",
"type": "string",
"required": true,
"location": "path"
},
"creativeId": {
"location": "path",
"description": "The creative ID of the creative to stop notifications for.\nSpecify \"-\" to specify stopping account level notifications.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching"
}
},
"resources": {
"dealAssociations": {
"methods": {
"remove": {
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"accountId",
"creativeId"
],
"httpMethod": "POST",
"parameters": {
"accountId": {
"location": "path",
"description": "The account the creative belongs to.",
"type": "string",
"required": true
},
"creativeId": {
"location": "path",
"description": "The ID of the creative associated with the deal.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove",
"id": "adexchangebuyer2.accounts.creatives.dealAssociations.remove",
"path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove",
"description": "Remove the association between a deal and a creative.",
"request": {
"$ref": "RemoveDealAssociationRequest"
}
},
"add": {
"httpMethod": "POST",
"parameterOrder": [
"accountId",
"creativeId"
],
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
"creativeId": {
"description": "The ID of the creative associated with the deal.",
"type": "string",
"required": true,
"location": "path"
},
"accountId": {
"description": "The account the creative belongs to.",
"type": "string",
"required": true,
"location": "path"
}
},
"flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
"path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
"id": "adexchangebuyer2.accounts.creatives.dealAssociations.add",
"request": {
"$ref": "AddDealAssociationRequest"
},
"description": "Associate an existing deal with a creative."
},
"list": {
"description": "List all creative-deal associations.",
"response": {
"$ref": "ListDealAssociationsResponse"
},
"parameterOrder": [
"accountId",
"creativeId"
],
"httpMethod": "GET",
"parameters": {
"pageSize": {
"format": "int32",
"description": "Requested page size. Server may return fewer associations than requested.\nIf unspecified, server will pick an appropriate default.",
"type": "integer",
"location": "query"
},
"accountId": {
"location": "path",
"description": "The account to list the associations from.\nSpecify \"-\" to list all creatives the current user has access to.",
"type": "string",
"required": true
},
"query": {
"location": "query",
"description": "An optional query string to filter deal associations. If no filter is\nspecified, all associations will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsId=\u003ci\u003edeals_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n\u003c/ul\u003e\nExample: 'dealsId=12345 AND dealsStatus:disapproved'",
"type": "string"
},
"creativeId": {
"description": "The creative ID to list the associations from.\nSpecify \"-\" to list all creatives under the above account.",
"type": "string",
"required": true,
"location": "path"
},
"pageToken": {
"location": "query",
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListDealAssociationsResponse.next_page_token\nreturned from the previous call to 'ListDealAssociations' method.",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
"id": "adexchangebuyer2.accounts.creatives.dealAssociations.list",
"path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations"
}
}
}
}
},
"filterSets": {
"methods": {
"create": {
"response": {
"$ref": "FilterSet"
},
"parameterOrder": [
"accountId"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
"isTransient": {
"location": "query",
"description": "Whether the filter set is transient, or should be persisted indefinitely.\nBy default, filter sets are not transient.\nIf transient, it will be available for at least 1 hour after creation.",
"type": "boolean"
},
"accountId": {
"location": "path",
"format": "int64",
"description": "Account ID of the buyer.",
"type": "string",
"required": true
}
},
"flatPath": "v2beta1/accounts/{accountId}/filterSets",
"id": "adexchangebuyer2.accounts.filterSets.create",
"path": "v2beta1/accounts/{accountId}/filterSets",
"request": {
"$ref": "FilterSet"
},
"description": "Creates the specified filter set for the account with the given account ID."
},
"delete": {
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"accountId",
"filterSetId"
],
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
"filterSetId": {
"type": "string",
"required": true,
"location": "path",
"format": "int64",
"description": "The ID of the filter set to delete."
},
"accountId": {
"location": "path",
"format": "int64",
"description": "Account ID of the buyer.",
"type": "string",
"required": true
}
},
"flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}",
"id": "adexchangebuyer2.accounts.filterSets.delete",
"path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}",
"description": "Deletes the requested filter set from the account with the given account\nID."
},
"list": {
"description": "Lists all filter sets for the account with the given account ID.",
"response": {
"$ref": "ListFilterSetsResponse"
},
"parameterOrder": [
"accountId"
],
"httpMethod": "GET",
"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.filterSets.list\nmethod.",
"type": "string",
"location": "query"
},
"pageSize": {
"format": "int32",
"description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"type": "integer",
"location": "query"
},
"accountId": {
"format": "int64",
"description": "Account ID of the buyer.",
"type": "string",
"required": true,
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"flatPath": "v2beta1/accounts/{accountId}/filterSets",
"id": "adexchangebuyer2.accounts.filterSets.list",
"path": "v2beta1/accounts/{accountId}/filterSets"
},
"get": {
"response": {
"$ref": "FilterSet"
},
"parameterOrder": [
"accountId",
"filterSetId"
],
"httpMethod": "GET",
"parameters": {
"accountId": {
"location": "path",
"format": "int64",
"description": "Account ID of the buyer.",
"type": "string",
"required": true
},
"filterSetId": {
"type": "string",
"required": true,
"location": "path",
"format": "int64",
"description": "The ID of the filter set to get."
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}",
"id": "adexchangebuyer2.accounts.filterSets.get",
"path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}",
"description": "Retrieves the requested filter set for the account with the given account\nID."
}
},
"resources": {
"nonBillableWinningBids": {
"methods": {
"list": {
"path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/nonBillableWinningBids",
"id": "adexchangebuyer2.accounts.filterSets.nonBillableWinningBids.list",
"description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason.",
"httpMethod": "GET",
"parameterOrder": [
"accountId",
"filterSetId"
],
"response": {
"$ref": "ListNonBillableWinningBidsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
"filterSetId": {
"location": "path",
"format": "int64",
"description": "The ID of the filter set to apply.",
"type": "string",
"required": true
},
"pageToken": {
"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.",
"type": "string",
"location": "query"
},
"pageSize": {
"type": "integer",
"location": "query",
"format": "int32",
"description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default."
},
"accountId": {
"location": "path",
"format": "int64",
"description": "Account ID of the buyer.",
"type": "string",
"required": true
}
},
"flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/nonBillableWinningBids"
}
}
},
"filteredBids": {
"methods": {
"list": {
"httpMethod": "GET",
"parameterOrder": [
"accountId",
"filterSetId"
],
"response": {
"$ref": "ListFilteredBidsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
"filterSetId": {
"location": "path",
"format": "int64",
"description": "The ID of the filter set to apply.",
"type": "string",
"required": true
},
"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.",
"type": "string",
"location": "query"
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"type": "integer"
},
"accountId": {
"location": "path",
"format": "int64",
"description": "Account ID of the buyer.",
"type": "string",
"required": true
}
},
"flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids",
"path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids",
"id": "adexchangebuyer2.accounts.filterSets.filteredBids.list",
"description": "List all reasons for which bids were filtered, with the number of bids\nfiltered for each reason."
}
},
"resources": {
"creatives": {
"methods": {
"list": {
"response": {
"$ref": "ListCreativeStatusBreakdownByCreativeResponse"
},
"parameterOrder": [
"accountId",
"filterSetId",
"creativeStatusId"
],
"httpMethod": "GET",
"parameters": {
"filterSetId": {
"location": "path",
"format": "int64",
"description": "The ID of the filter set to apply.",
"type": "string",
"required": true
},
"pageToken": {
"location": "query",
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByCreativeResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.creatives.list\nmethod.",
"type": "string"
},
"creativeStatusId": {
"format": "int32",
"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).",
"type": "integer",
"required": true,
"location": "path"
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"type": "integer"
},
"accountId": {
"type": "string",
"required": true,
"location": "path",
"format": "int64",
"description": "Account ID of the buyer."
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives",
"id": "adexchangebuyer2.accounts.filterSets.filteredBids.creatives.list",
"path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives",
"description": "List all creatives associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative."
}
}
},
"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.",
"response": {
"$ref": "ListCreativeStatusBreakdownByDetailResponse"
},
"parameterOrder": [
"accountId",
"filterSetId",
"creativeStatusId"
],
"httpMethod": "GET",
"parameters": {
"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.",
"type": "string",
"location": "query"
},
"creativeStatusId": {
"format": "int32",
"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).\nDetails are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.",
"type": "integer",
"required": true,
"location": "path"
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"type": "integer"
},
"accountId": {
"format": "int64",
"description": "Account ID of the buyer.",
"type": "string",
"required": true,
"location": "path"
},
"filterSetId": {
"format": "int64",
"description": "The ID of the filter set to apply.",
"type": "string",
"required": true,
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/details",
"id": "adexchangebuyer2.accounts.filterSets.filteredBids.details.list",
"path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/details"
}
}
}
}
},
"losingBids": {
"methods": {
"list": {
"flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/losingBids",
"path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/losingBids",
"id": "adexchangebuyer2.accounts.filterSets.losingBids.list",
"description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason.",
"httpMethod": "GET",
"parameterOrder": [
"accountId",
"filterSetId"
],
"response": {
"$ref": "ListLosingBidsResponse"
},
"parameters": {
"pageToken": {
"location": "query",
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListLosingBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.losingBids.list\nmethod.",
"type": "string"
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"type": "integer"
},
"accountId": {
"type": "string",
"required": true,
"location": "path",
"format": "int64",
"description": "Account ID of the buyer."
},
"filterSetId": {
"format": "int64",
"description": "The ID of the filter set to apply.",
"type": "string",
"required": true,
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
}
}
},
"impressionMetrics": {
"methods": {
"list": {
"description": "Lists all metrics that are measured in terms of number of impressions.",
"response": {
"$ref": "ListImpressionMetricsResponse"
},
"parameterOrder": [
"accountId",
"filterSetId"
],
"httpMethod": "GET",
"parameters": {
"pageToken": {
"type": "string",
"location": "query",
"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."
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"type": "integer"
},
"accountId": {
"format": "int64",
"description": "Account ID of the buyer.",
"type": "string",
"required": true,
"location": "path"
},
"filterSetId": {
"location": "path",
"format": "int64",
"description": "The ID of the filter set to apply.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/impressionMetrics",
"id": "adexchangebuyer2.accounts.filterSets.impressionMetrics.list",
"path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/impressionMetrics"
}
}
},
"bidMetrics": {
"methods": {
"list": {
"flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidMetrics",
"path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidMetrics",
"id": "adexchangebuyer2.accounts.filterSets.bidMetrics.list",
"description": "Lists all metrics that are measured in terms of number of bids.",
"httpMethod": "GET",
"parameterOrder": [
"accountId",
"filterSetId"
],
"response": {
"$ref": "ListBidMetricsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
"pageToken": {
"location": "query",
"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.",
"type": "string"
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"type": "integer"
},
"accountId": {
"location": "path",
"format": "int64",
"description": "Account ID of the buyer.",
"type": "string",
"required": true
},
"filterSetId": {
"location": "path",
"format": "int64",
"description": "The ID of the filter set to apply.",
"type": "string",
"required": true
}
}
}
}
},
"bidResponseErrors": {
"methods": {
"list": {
"description": "List all errors that occurred in bid responses, with the number of bid\nresponses affected for each reason.",
"response": {
"$ref": "ListBidResponseErrorsResponse"
},
"parameterOrder": [
"accountId",
"filterSetId"
],
"httpMethod": "GET",
"parameters": {
"filterSetId": {
"format": "int64",
"description": "The ID of the filter set to apply.",
"type": "string",
"required": true,
"location": "path"
},
"pageToken": {
"location": "query",
"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.",
"type": "string"
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"type": "integer"
},
"accountId": {
"format": "int64",
"description": "Account ID of the buyer.",
"type": "string",
"required": true,
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponseErrors",
"id": "adexchangebuyer2.accounts.filterSets.bidResponseErrors.list",
"path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponseErrors"
}
}
},
"bidResponsesWithoutBids": {
"methods": {
"list": {
"flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponsesWithoutBids",
"id": "adexchangebuyer2.accounts.filterSets.bidResponsesWithoutBids.list",
"path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponsesWithoutBids",
"description": "List all reasons for which bid responses were considered to have no\napplicable bids, with the number of bid responses affected for each reason.",
"response": {
"$ref": "ListBidResponsesWithoutBidsResponse"
},
"parameterOrder": [
"accountId",
"filterSetId"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
"pageToken": {
"type": "string",
"location": "query",
"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."
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"type": "integer"
},
"accountId": {
"location": "path",
"format": "int64",
"description": "Account ID of the buyer.",
"type": "string",
"required": true
},
"filterSetId": {
"location": "path",
"format": "int64",
"description": "The ID of the filter set to apply.",
"type": "string",
"required": true
}
}
}
}
},
"filteredBidRequests": {
"methods": {
"list": {
"flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBidRequests",
"id": "adexchangebuyer2.accounts.filterSets.filteredBidRequests.list",
"path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBidRequests",
"description": "List all reasons that caused a bid request not to be sent for an\nimpression, with the number of bid requests not sent for each reason.",
"response": {
"$ref": "ListFilteredBidRequestsResponse"
},
"parameterOrder": [
"accountId",
"filterSetId"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
"pageToken": {
"location": "query",
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidRequestsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBidRequests.list\nmethod.",
"type": "string"
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"type": "integer"
},
"accountId": {
"type": "string",
"required": true,
"location": "path",
"format": "int64",
"description": "Account ID of the buyer."
},
"filterSetId": {
"type": "string",
"required": true,
"location": "path",
"format": "int64",
"description": "The ID of the filter set to apply."
}
}
}
}
}
}
},
"clients": {
"methods": {
"list": {
"description": "Lists all the clients for the current sponsor buyer.",
"httpMethod": "GET",
"parameterOrder": [
"accountId"
],
"response": {
"$ref": "ListClientsResponse"
},
"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.",
"type": "string",
"location": "query"
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
"type": "integer"
},
"accountId": {
"location": "path",
"format": "int64",
"description": "Unique numerical account ID of the sponsor buyer to list the clients for.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"flatPath": "v2beta1/accounts/{accountId}/clients",
"path": "v2beta1/accounts/{accountId}/clients",
"id": "adexchangebuyer2.accounts.clients.list"
},
"get": {
"description": "Gets a client buyer with a given client account ID.",
"httpMethod": "GET",
"parameterOrder": [
"accountId",
"clientAccountId"
],
"response": {
"$ref": "Client"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
"accountId": {
"type": "string",
"required": true,
"location": "path",
"format": "int64",
"description": "Numerical account ID of the client's sponsor buyer. (required)"
},
"clientAccountId": {
"location": "path",
"format": "int64",
"description": "Numerical account ID of the client buyer to retrieve. (required)",
"type": "string",
"required": true
}
},
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
"id": "adexchangebuyer2.accounts.clients.get"
},
"update": {
"response": {
"$ref": "Client"
},
"parameterOrder": [
"accountId",
"clientAccountId"
],
"httpMethod": "PUT",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
"accountId": {
"type": "string",
"required": true,
"location": "path",
"format": "int64",
"description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to update a client for. (required)"
},
"clientAccountId": {
"location": "path",
"format": "int64",
"description": "Unique numerical account ID of the client to update. (required)",
"type": "string",
"required": true
}
},
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
"id": "adexchangebuyer2.accounts.clients.update",
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
"request": {
"$ref": "Client"
},
"description": "Updates an existing client buyer."
},
"create": {
"response": {
"$ref": "Client"
},
"parameterOrder": [
"accountId"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
"accountId": {
"format": "int64",
"description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to create a client for. (required)",
"type": "string",
"required": true,
"location": "path"
}
},
"flatPath": "v2beta1/accounts/{accountId}/clients",
"id": "adexchangebuyer2.accounts.clients.create",
"path": "v2beta1/accounts/{accountId}/clients",
"request": {
"$ref": "Client"
},
"description": "Creates a new client buyer."
}
},
"resources": {
"invitations": {
"methods": {
"list": {
"response": {
"$ref": "ListClientUserInvitationsResponse"
},
"parameterOrder": [
"accountId",
"clientAccountId"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
"pageToken": {
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUserInvitationsResponse.nextPageToken\nreturned from the previous call to the\nclients.invitations.list\nmethod.",
"type": "string",
"location": "query"
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "Requested page size. Server may return fewer clients than requested.\nIf unspecified, server will pick an appropriate default.",
"type": "integer"
},
"accountId": {
"location": "path",
"format": "int64",
"description": "Numerical account ID of the client's sponsor buyer. (required)",
"type": "string",
"required": true
},
"clientAccountId": {
"description": "Numerical account ID of the client buyer to list invitations for.\n(required)\nYou must either specify a string representation of a\nnumerical account identifier or the `-` character\nto list all the invitations for all the clients\nof a given sponsor buyer.",
"type": "string",
"required": true,
"location": "path"
}
},
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
"id": "adexchangebuyer2.accounts.clients.invitations.list",
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
"description": "Lists all the client users invitations for a client\nwith a given account ID."
},
"get": {
"description": "Retrieves an existing client user invitation.",
"response": {
"$ref": "ClientUserInvitation"
},
"parameterOrder": [
"accountId",
"clientAccountId",
"invitationId"
],
"httpMethod": "GET",
"parameters": {
"invitationId": {
"type": "string",
"required": true,
"location": "path",
"format": "int64",
"description": "Numerical identifier of the user invitation to retrieve. (required)"
},
"accountId": {
"format": "int64",
"description": "Numerical account ID of the client's sponsor buyer. (required)",
"type": "string",
"required": true,
"location": "path"
},
"clientAccountId": {
"location": "path",
"format": "int64",
"description": "Numerical account ID of the client buyer that the user invitation\nto be retrieved is associated with. (required)",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
"id": "adexchangebuyer2.accounts.clients.invitations.get",
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}"
},
"create": {
"id": "adexchangebuyer2.accounts.clients.invitations.create",
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
"request": {
"$ref": "ClientUserInvitation"
},
"description": "Creates and sends out an email invitation to access\nan Ad Exchange client buyer account.",
"response": {
"$ref": "ClientUserInvitation"
},
"parameterOrder": [
"accountId",
"clientAccountId"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
"accountId": {
"location": "path",
"format": "int64",
"description": "Numerical account ID of the client's sponsor buyer. (required)",
"type": "string",
"required": true
},
"clientAccountId": {
"format": "int64",
"description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)",
"type": "string",
"required": true,
"location": "path"
}
},
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations"
}
}
},
"users": {
"methods": {
"update": {
"response": {
"$ref": "ClientUser"
},
"parameterOrder": [
"accountId",
"clientAccountId",
"userId"
],
"httpMethod": "PUT",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
"userId": {
"type": "string",
"required": true,
"location": "path",
"format": "int64",
"description": "Numerical identifier of the user to retrieve. (required)"
},
"accountId": {
"format": "int64",
"description": "Numerical account ID of the client's sponsor buyer. (required)",
"type": "string",
"required": true,
"location": "path"
},
"clientAccountId": {
"location": "path",
"format": "int64",
"description": "Numerical account ID of the client buyer that the user to be retrieved\nis associated with. (required)",
"type": "string",
"required": true
}
},
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
"id": "adexchangebuyer2.accounts.clients.users.update",
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
"request": {
"$ref": "ClientUser"
},
"description": "Updates an existing client user.\nOnly the user status can be changed on update."
},
"get": {
"description": "Retrieves an existing client user.",
"response": {
"$ref": "ClientUser"
},
"parameterOrder": [
"accountId",
"clientAccountId",
"userId"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
"userId": {
"type": "string",
"required": true,
"location": "path",
"format": "int64",
"description": "Numerical identifier of the user to retrieve. (required)"
},
"accountId": {
"format": "int64",
"description": "Numerical account ID of the client's sponsor buyer. (required)",
"type": "string",
"required": true,
"location": "path"
},
"clientAccountId": {
"location": "path",
"format": "int64",
"description": "Numerical account ID of the client buyer\nthat the user to be retrieved is associated with. (required)",
"type": "string",
"required": true
}
},
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
"id": "adexchangebuyer2.accounts.clients.users.get",
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}"
},
"list": {
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
"id": "adexchangebuyer2.accounts.clients.users.list",
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
"description": "Lists all the known client users for a specified\nsponsor buyer account ID.",
"response": {
"$ref": "ListClientUsersResponse"
},
"parameterOrder": [
"accountId",
"clientAccountId"
],
"httpMethod": "GET",
"parameters": {
"pageToken": {
"location": "query",
"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.",
"type": "string"
},
"pageSize": {
"format": "int32",
"description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
"type": "integer",
"location": "query"
},
"accountId": {
"location": "path",
"format": "int64",
"description": "Numerical account ID of the sponsor buyer of the client to list users for.\n(required)",
"type": "string",
"required": true
},
"clientAccountId": {
"type": "string",
"required": true,
"location": "path",
"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."
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
}
}
}
}
}
}
}
},
"parameters": {
"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.",
"type": "string",
"location": "query"
},
"pp": {
"location": "query",
"description": "Pretty-print response.",
"default": "true",
"type": "boolean"
},
"bearer_token": {
"type": "string",
"location": "query",
"description": "OAuth bearer token."
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean",
"location": "query"
},
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"fields": {
"type": "string",
"location": "query",
"description": "Selector specifying which fields to include in a partial response."
},
"$.xgafv": {
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"enum": [
"1",
"2"
]
},
"callback": {
"location": "query",
"description": "JSONP",
"type": "string"
},
"alt": {
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"description": "Data format for response.",
"default": "json",
"enum": [
"json",
"media",
"proto"
]
},
"access_token": {
"type": "string",
"location": "query",
"description": "OAuth access 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.",
"type": "string",
"location": "query"
}
},
"version": "v2beta1",
"baseUrl": "https://adexchangebuyer.googleapis.com/",
"servicePath": "",
"kind": "discovery#restDescription",
"description": "Accesses the latest features for managing Ad Exchange accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.",
"basePath": "",
"revision": "20171012",
"documentationLink": "https://developers.google.com/ad-exchange/buyer-rest/reference/rest/",
"id": "adexchangebuyer2:v2beta1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
"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.",
"type": "object",
"properties": {
"bidCount": {
"$ref": "MetricValue",
"description": "The number of bids with the specified status."
},
"status": {
"description": "The status specifying why the winning bids were not billed.",
"type": "string",
"enumDescriptions": [
"A placeholder for an undefined status.\nThis value will never be returned in responses.",
"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."
],
"enum": [
"STATUS_UNSPECIFIED",
"AD_NOT_RENDERED",
"INVALID_IMPRESSION"
]
},
"rowDimensions": {
"$ref": "RowDimensions",
"description": "The values of all dimensions associated with metric values in this row."
}
},
"id": "NonBillableWinningBidStatusRow"
},
"FilteredBidDetailRow": {
"properties": {
"rowDimensions": {
"$ref": "RowDimensions",
"description": "The values of all dimensions associated with metric values in this row."
},
"detailId": {
"type": "integer",
"format": "int32",
"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."
},
"bidCount": {
"$ref": "MetricValue",
"description": "The number of bids with the specified detail."
}
},
"id": "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.",
"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.",
"type": "object",
"properties": {
"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."
},
"startDate": {
"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.",
"$ref": "Date"
}
},
"id": "AbsoluteDateRange"
},
"AddDealAssociationRequest": {
"description": "A request for associating a deal and a creative.",
"type": "object",
"properties": {
"association": {
"$ref": "CreativeDealAssociation",
"description": "The association between a creative and a deal that should be added."
}
},
"id": "AddDealAssociationRequest"
},
"WatchCreativeRequest": {
"properties": {
"topic": {
"type": "string",
"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."
}
},
"id": "WatchCreativeRequest",
"description": "A request for watching changes to creative Status.",
"type": "object"
},
"TimeInterval": {
"properties": {
"startTime": {
"format": "google-datetime",
"description": "The timestamp marking the start of the range (inclusive) for which data is\nincluded.",
"type": "string"
},
"endTime": {
"format": "google-datetime",
"description": "The timestamp marking the end of the range (exclusive) for which data is\nincluded.",
"type": "string"
}
},
"id": "TimeInterval",
"description": "An interval of time, with an absolute start and end.",
"type": "object"
},
"FilteredBidCreativeRow": {
"description": "The number of filtered bids with the specified dimension values that have the\nspecified creative.",
"type": "object",
"properties": {
"creativeId": {
"description": "The ID of the creative.",
"type": "string"
},
"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."
}
},
"id": "FilteredBidCreativeRow"
},
"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 \u003e= 0\nduration_days \u003e= 1\noffset_days + duration_days \u003c= 30",
"type": "object",
"properties": {
"offsetDays": {
"format": "int32",
"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.",
"type": "integer"
},
"durationDays": {
"format": "int32",
"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.",
"type": "integer"
}
},
"id": "RelativeDateRange"
},
"ListClientsResponse": {
"type": "object",
"properties": {
"clients": {
"description": "The returned list of clients.",
"items": {
"$ref": "Client"
},
"type": "array"
},
"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"
}
},
"id": "ListClientsResponse"
},
"NativeContent": {
"description": "Native content for a creative.",
"type": "object",
"properties": {
"starRating": {
"format": "double",
"description": "The app rating in the app store. Must be in the range [0-5].",
"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": {
"description": "A smaller image, for the advertiser's logo.",
"$ref": "Image"
},
"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 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": {
"description": "The app icon, for app download ads.",
"$ref": "Image"
},
"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"
}
},
"id": "NativeContent"
},
"ListBidResponsesWithoutBidsResponse": {
"id": "ListBidResponsesWithoutBidsResponse",
"description": "Response message for listing all reasons that bid responses were considered\nto have no applicable bids.",
"type": "object",
"properties": {
"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"
},
"bidResponseWithoutBidsStatusRows": {
"description": "List of rows, with counts of bid responses without bids aggregated by\nstatus.",
"items": {
"$ref": "BidResponseWithoutBidsStatusRow"
},
"type": "array"
}
}
},
"ServingContext": {
"id": "ServingContext",
"description": "The serving context for this restriction.",
"type": "object",
"properties": {
"securityType": {
"description": "Matches impressions for a particular security type.",
"$ref": "SecurityContext"
},
"platform": {
"description": "Matches impressions coming from a particular platform.",
"$ref": "PlatformContext"
},
"location": {
"$ref": "LocationContext",
"description": "Matches impressions coming from users *or* publishers in a specific\nlocation."
},
"auctionType": {
"description": "Matches impressions for a particular auction type.",
"$ref": "AuctionContext"
},
"all": {
"enumDescriptions": [
"A simple context."
],
"enum": [
"SIMPLE_CONTEXT"
],
"description": "Matches all contexts.",
"type": "string"
},
"appType": {
"description": "Matches impressions for a particular app type.",
"$ref": "AppContext"
}
}
},
"Image": {
"type": "object",
"properties": {
"width": {
"format": "int32",
"description": "Image width in pixels.",
"type": "integer"
},
"url": {
"description": "The URL of the image.",
"type": "string"
},
"height": {
"type": "integer",
"format": "int32",
"description": "Image height in pixels."
}
},
"id": "Image",
"description": "An image resource. You may provide a larger image than was requested,\nso long as the aspect ratio is preserved."
},
"ListFilterSetsResponse": {
"properties": {
"filterSets": {
"description": "The filter sets belonging to the buyer.",
"items": {
"$ref": "FilterSet"
},
"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.",
"type": "string"
}
},
"id": "ListFilterSetsResponse",
"description": "Response message for listing filter sets.",
"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.",
"type": "object",
"properties": {
"impressionCount": {
"$ref": "MetricValue",
"description": "The number of impressions for which there was a bid response with the\nspecified status."
},
"status": {
"type": "string",
"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."
],
"enum": [
"STATUS_UNSPECIFIED",
"RESPONSES_WITHOUT_BIDS",
"RESPONSES_WITHOUT_BIDS_FOR_ACCOUNT",
"RESPONSES_WITHOUT_BIDS_FOR_DEAL"
],
"description": "The status specifying why the bid responses were considered to have no\napplicable bids."
},
"rowDimensions": {
"$ref": "RowDimensions",
"description": "The values of all dimensions associated with metric values in this row."
}
},
"id": "BidResponseWithoutBidsStatusRow"
},
"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.",
"type": "object",
"properties": {
"invitationId": {
"format": "int64",
"description": "The unique numerical ID of the invitation that is sent to the user.\nThe value of this field is ignored in create operations.",
"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": {
"format": "int64",
"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.",
"type": "string"
}
},
"id": "ClientUserInvitation"
},
"ListCreativeStatusBreakdownByDetailResponse": {
"description": "Response message for listing all details associated with a given filtered bid\nreason.",
"type": "object",
"properties": {
"detailType": {
"enum": [
"DETAIL_TYPE_UNSPECIFIED",
"CREATIVE_ATTRIBUTE",
"VENDOR",
"SENSITIVE_CATEGORY",
"PRODUCT_CATEGORY",
"DISAPPROVAL_REASON"
],
"description": "The type of detail that the detail IDs represent.",
"type": "string",
"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).",
"Indicates that the detail ID refers to a disapproval reason; see\nDisapprovalReason enum in [snippet-status-report-proto](https://developers.google.com/ad-exchange/rtb/downloads/snippet-status-report-proto)."
]
},
"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"
},
"filteredBidDetailRows": {
"description": "List of rows, with counts of bids with a given creative status aggregated\nby detail.",
"items": {
"$ref": "FilteredBidDetailRow"
},
"type": "array"
}
},
"id": "ListCreativeStatusBreakdownByDetailResponse"
},
"ListClientUsersResponse": {
"id": "ListClientUsersResponse",
"type": "object",
"properties": {
"users": {
"description": "The returned list of client users.",
"items": {
"$ref": "ClientUser"
},
"type": "array"
},
"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"
}
}
},
"ListClientUserInvitationsResponse": {
"type": "object",
"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"
},
"invitations": {
"description": "The returned list of client users.",
"items": {
"$ref": "ClientUserInvitation"
},
"type": "array"
}
},
"id": "ListClientUserInvitationsResponse"
},
"LocationContext": {
"description": "@OutputOnly The Geo criteria the restriction applies to.",
"type": "object",
"properties": {
"geoCriteriaIds": {
"items": {
"format": "int32",
"type": "integer"
},
"type": "array",
"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."
}
},
"id": "LocationContext"
},
"PlatformContext": {
"id": "PlatformContext",
"description": "@OutputOnly The type of platform the restriction applies to.",
"type": "object",
"properties": {
"platforms": {
"enumDescriptions": [
"Desktop platform.",
"Android platform.",
"iOS platform."
],
"description": "The platforms this restriction applies to.",
"items": {
"enum": [
"DESKTOP",
"ANDROID",
"IOS"
],
"type": "string"
},
"type": "array"
}
}
},
"MetricValue": {
"properties": {
"variance": {
"format": "int64",
"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",
"type": "string"
},
"value": {
"type": "string",
"format": "int64",
"description": "The expected value of the metric."
}
},
"id": "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).",
"type": "object"
},
"ClientUser": {
"type": "object",
"properties": {
"email": {
"description": "User's email address. The value of this field\nis ignored in an update operation.",
"type": "string"
},
"userId": {
"format": "int64",
"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.",
"type": "string"
},
"clientAccountId": {
"type": "string",
"format": "int64",
"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."
},
"status": {
"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."
],
"enum": [
"USER_STATUS_UNSPECIFIED",
"PENDING",
"ACTIVE",
"DISABLED"
],
"description": "The status of the client user.",
"type": "string"
}
},
"id": "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."
},
"CreativeDealAssociation": {
"description": "The association between a creative and a deal.",
"type": "object",
"properties": {
"accountId": {
"description": "The account the creative belongs to.",
"type": "string"
},
"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"
}
},
"id": "CreativeDealAssociation"
},
"FilteringStats": {
"id": "FilteringStats",
"description": "@OutputOnly Filtering reasons for this creative during a period of a single\nday (from midnight to midnight Pacific).",
"type": "object",
"properties": {
"reasons": {
"description": "The set of filtering reasons for this date.",
"items": {
"$ref": "Reason"
},
"type": "array"
},
"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."
}
}
},
"Creative": {
"description": "A creative and its classification data.",
"type": "object",
"properties": {
"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"
},
"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": {
"format": "int64",
"description": "The agency ID for this creative.",
"type": "string"
},
"clickThroughUrls": {
"description": "The set of destination URLs for the creative.",
"items": {
"type": "string"
},
"type": "array"
},
"adChoicesDestinationUrl": {
"description": "The link to AdChoices destination page.",
"type": "string"
},
"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": {
"enumDescriptions": [
"The ad has no restricted categories",
"The alcohol restricted category."
],
"description": "All restricted categories for the ads that may be shown from this creative.",
"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": {
"format": "int32",
"description": "@OutputOnly The version of this creative.",
"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": {
"type": "integer",
"format": "int32"
},
"type": "array"
},
"impressionTrackingUrls": {
"description": "The set of URLs to be called to record an impression.",
"items": {
"type": "string"
},
"type": "array"
},
"html": {
"description": "An HTML creative.",
"$ref": "HtmlContent"
},
"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.",
"type": "string",
"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."
],
"enum": [
"STATUS_UNSPECIFIED",
"NOT_CHECKED",
"CONDITIONALLY_APPROVED",
"APPROVED",
"DISAPPROVED"
]
},
"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": {
"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."
],
"enum": [
"STATUS_UNSPECIFIED",
"NOT_CHECKED",
"CONDITIONALLY_APPROVED",
"APPROVED",
"DISAPPROVED"
],
"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.",
"type": "string"
},
"advertiserName": {
"description": "The name of the company being advertised in the creative.",
"type": "string"
},
"detectedAdvertiserIds": {
"items": {
"format": "int64",
"type": "string"
},
"type": "array",
"description": "@OutputOnly Detected advertiser IDs, if any."
},
"detectedDomains": {
"description": "@OutputOnly\nThe detected domains for this creative.",
"items": {
"type": "string"
},
"type": "array"
},
"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.",
"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",
"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."
]
},
"apiUpdateTime": {
"format": "google-datetime",
"description": "@OutputOnly The last update timestamp of the creative via API.",
"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"
}
},
"id": "Creative"
},
"RemoveDealAssociationRequest": {
"description": "A request for removing the association between a deal and a creative.",
"type": "object",
"properties": {
"association": {
"$ref": "CreativeDealAssociation",
"description": "The association between a creative and a deal that should be removed."
}
},
"id": "RemoveDealAssociationRequest"
},
"ListCreativeStatusBreakdownByCreativeResponse": {
"properties": {
"nextPageToken": {
"type": "string",
"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."
},
"filteredBidCreativeRows": {
"description": "List of rows, with counts of bids with a given creative status aggregated\nby creative.",
"items": {
"$ref": "FilteredBidCreativeRow"
},
"type": "array"
}
},
"id": "ListCreativeStatusBreakdownByCreativeResponse",
"description": "Response message for listing all creatives associated with a given filtered\nbid reason.",
"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.",
"type": "object",
"properties": {
"visibleToSeller": {
"description": "Whether the client buyer will be visible to sellers.",
"type": "boolean"
},
"entityId": {
"format": "int64",
"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.",
"type": "string"
},
"clientAccountId": {
"type": "string",
"format": "int64",
"description": "The globally-unique numerical ID of the client.\nThe value of this field is ignored in create and update operations."
},
"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": {
"enumDescriptions": [
"A placeholder for an undefined client status.",
"A client that is currently disabled.",
"A client that is currently active."
],
"enum": [
"CLIENT_STATUS_UNSPECIFIED",
"DISABLED",
"ACTIVE"
],
"description": "The status of the client buyer.",
"type": "string"
},
"entityType": {
"description": "The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.",
"type": "string",
"enumDescriptions": [
"A placeholder for an undefined client entity type. Should not be used.",
"An advertiser.",
"A brand.",
"An advertising agency."
],
"enum": [
"ENTITY_TYPE_UNSPECIFIED",
"ADVERTISER",
"BRAND",
"AGENCY"
]
},
"clientName": {
"type": "string",
"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."
},
"role": {
"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."
],
"enum": [
"CLIENT_ROLE_UNSPECIFIED",
"CLIENT_DEAL_VIEWER",
"CLIENT_DEAL_NEGOTIATOR",
"CLIENT_DEAL_APPROVER"
],
"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`.",
"type": "string"
}
},
"id": "Client"
},
"Correction": {
"description": "@OutputOnly Shows any corrections that were applied to this creative.",
"type": "object",
"properties": {
"details": {
"description": "Additional details about what was corrected.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"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"
],
"description": "The type of correction that was applied to the creative.",
"type": "string",
"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."
]
},
"contexts": {
"description": "The contexts for the correction.",
"items": {
"$ref": "ServingContext"
},
"type": "array"
}
},
"id": "Correction"
},
"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)\"",
"type": "object",
"properties": {
"creativeId": {
"description": "The ID of the creative on which to filter; optional.",
"type": "string"
},
"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."
],
"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).",
"items": {
"type": "string",
"enum": [
"PLATFORM_UNSPECIFIED",
"DESKTOP",
"TABLET",
"MOBILE"
]
},
"type": "array"
},
"relativeDateRange": {
"$ref": "RelativeDateRange",
"description": "A relative date range, defined by an offset from today and a duration.\nInterpreted relative to Pacific time zone."
},
"name": {
"description": "A user-defined name of the filter set. Filter set names must be unique\nglobally and match one of the patterns:\n\n- `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting\ndata)\n- `bidders/*/accounts/*/filterSets/*` (for accessing buyer-level\ntroubleshooting data)",
"type": "string"
},
"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": {
"type": "string",
"format": "int64",
"description": "The account ID of the buyer who owns this filter set.\nThe value of this field is ignored in create operations."
},
"buyerAccountId": {
"format": "int64",
"description": "The ID of the buyer account on which to filter; optional.",
"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."
},
"environment": {
"enum": [
"ENVIRONMENT_UNSPECIFIED",
"WEB",
"APP"
],
"description": "The environment on which to filter; optional.",
"type": "string",
"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."
]
},
"dealId": {
"format": "int64",
"description": "The ID of the deal on which to filter; optional.",
"type": "string"
},
"format": {
"type": "string",
"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."
],
"enum": [
"FORMAT_UNSPECIFIED",
"DISPLAY",
"VIDEO"
],
"description": "The format on which to filter; optional."
},
"timeSeriesGranularity": {
"type": "string",
"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."
],
"enum": [
"TIME_SERIES_GRANULARITY_UNSPECIFIED",
"HOURLY",
"DAILY"
],
"description": "The granularity of time intervals if a time series breakdown is desired;\noptional."
},
"filterSetId": {
"format": "int64",
"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.",
"type": "string"
},
"realtimeTimeRange": {
"$ref": "RealtimeTimeRange",
"description": "An open-ended realtime time range, defined by the aggregation start\ntimestamp."
}
},
"id": "FilterSet"
},
"ListDealAssociationsResponse": {
"description": "A response for listing creative and deal associations",
"type": "object",
"properties": {
"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"
}
},
"id": "ListDealAssociationsResponse"
},
"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.",
"type": "object",
"properties": {
"calloutStatusId": {
"format": "int32",
"description": "The ID of the callout status.\nSee [callout-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/callout-status-codes).",
"type": "integer"
},
"impressionCount": {
"description": "The number of impressions for which there was a bid request or bid response\nwith the specified callout status.",
"$ref": "MetricValue"
},
"rowDimensions": {
"description": "The values of all dimensions associated with metric values in this row.",
"$ref": "RowDimensions"
}
},
"id": "CalloutStatusRow"
},
"StopWatchingCreativeRequest": {
"type": "object",
"properties": {},
"id": "StopWatchingCreativeRequest",
"description": "A request for stopping notifications for changes to creative Status."
},
"Disapproval": {
"type": "object",
"properties": {
"details": {
"description": "Additional details about the reason for disapproval.",
"items": {
"type": "string"
},
"type": "array"
},
"reason": {
"type": "string",
"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."
],
"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"
],
"description": "The categorized reason for disapproval."
}
},
"id": "Disapproval",
"description": "@OutputOnly The reason and details for a disapproval."
},
"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).",
"type": "object",
"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.",
"items": {
"$ref": "Disapproval"
},
"type": "array"
},
"contexts": {
"description": "The contexts for the restriction.",
"items": {
"$ref": "ServingContext"
},
"type": "array"
},
"status": {
"enumDescriptions": [
"The status is not known.",
"The ad was disapproved in this context.",
"The ad is pending review in this context."
],
"enum": [
"STATUS_UNSPECIFIED",
"DISAPPROVAL",
"PENDING_REVIEW"
],
"description": "The status of the creative in this context (for example, it has been\nexplicitly disapproved or is pending review).",
"type": "string"
}
},
"id": "ServingRestriction"
},
"Date": {
"type": "object",
"properties": {
"day": {
"format": "int32",
"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.",
"type": "integer"
},
"year": {
"format": "int32",
"description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
"type": "integer"
},
"month": {
"type": "integer",
"format": "int32",
"description": "Month of year. Must be from 1 to 12."
}
},
"id": "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`."
},
"RowDimensions": {
"description": "A response may include multiple rows, breaking down along various dimensions.\nEncapsulates the values of all dimensions for a given row.",
"type": "object",
"properties": {
"timeInterval": {
"$ref": "TimeInterval",
"description": "The time interval that this row represents."
}
},
"id": "RowDimensions"
},
"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 `{}`.",
"type": "object",
"properties": {},
"id": "Empty"
},
"AppContext": {
"description": "@OutputOnly The app type the restriction applies to for mobile device.",
"type": "object",
"properties": {
"appTypes": {
"description": "The app types this restriction applies to.",
"items": {
"enum": [
"NATIVE",
"WEB"
],
"type": "string"
},
"type": "array",
"enumDescriptions": [
"Native app context.",
"Mobile web app context."
]
}
},
"id": "AppContext"
},
"ListFilteredBidsResponse": {
"description": "Response message for listing all reasons that bids were filtered from the\nauction.",
"type": "object",
"properties": {
"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"
},
"creativeStatusRows": {
"description": "List of rows, with counts of filtered bids aggregated by filtering reason\n(i.e. creative status).",
"items": {
"$ref": "CreativeStatusRow"
},
"type": "array"
}
},
"id": "ListFilteredBidsResponse"
},
"SecurityContext": {
"type": "object",
"properties": {
"securities": {
"enumDescriptions": [
"Matches impressions that require insecure compatibility.",
"Matches impressions that require SSL compatibility."
],
"description": "The security types in this context.",
"items": {
"enum": [
"INSECURE",
"SSL"
],
"type": "string"
},
"type": "array"
}
},
"id": "SecurityContext",
"description": "@OutputOnly A security context."
},
"ListFilteredBidRequestsResponse": {
"description": "Response message for listing all reasons that bid requests were filtered and\nnot sent to the buyer.",
"type": "object",
"properties": {
"calloutStatusRows": {
"description": "List of rows, with counts of filtered bid requests aggregated by callout\nstatus.",
"items": {
"$ref": "CalloutStatusRow"
},
"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.",
"type": "string"
}
},
"id": "ListFilteredBidRequestsResponse"
},
"ListCreativesResponse": {
"description": "A response for listing creatives.",
"type": "object",
"properties": {
"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"
}
},
"id": "ListCreativesResponse"
},
"HtmlContent": {
"description": "HTML content for a creative.",
"type": "object",
"properties": {
"height": {
"format": "int32",
"description": "The height of the HTML snippet in pixels.",
"type": "integer"
},
"width": {
"type": "integer",
"format": "int32",
"description": "The width of the HTML snippet in pixels."
},
"snippet": {
"description": "The HTML snippet that displays the ad when inserted in the web page.",
"type": "string"
}
},
"id": "HtmlContent"
},
"ListBidMetricsResponse": {
"description": "Response message for listing the metrics that are measured in number of bids.",
"type": "object",
"properties": {
"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"
},
"bidMetricsRows": {
"description": "List of rows, each containing a set of bid metrics.",
"items": {
"$ref": "BidMetricsRow"
},
"type": "array"
}
},
"id": "ListBidMetricsResponse"
},
"Reason": {
"properties": {
"status": {
"format": "int32",
"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.",
"type": "integer"
},
"count": {
"format": "int64",
"description": "The number of times the creative was filtered for the status. The\ncount is aggregated across all publishers on the exchange.",
"type": "string"
}
},
"id": "Reason",
"description": "A specific filtering status and how many times it occurred.",
"type": "object"
},
"ListNonBillableWinningBidsResponse": {
"type": "object",
"properties": {
"nextPageToken": {
"type": "string",
"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."
},
"nonBillableWinningBidStatusRows": {
"description": "List of rows, with counts of bids not billed aggregated by reason.",
"items": {
"$ref": "NonBillableWinningBidStatusRow"
},
"type": "array"
}
},
"id": "ListNonBillableWinningBidsResponse",
"description": "Response message for listing all reasons for which a buyer was not billed for\na winning bid."
},
"ListLosingBidsResponse": {
"description": "Response message for listing all reasons that bids lost in the auction.",
"type": "object",
"properties": {
"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"
},
"creativeStatusRows": {
"description": "List of rows, with counts of losing bids aggregated by loss reason (i.e.\ncreative status).",
"items": {
"$ref": "CreativeStatusRow"
},
"type": "array"
}
},
"id": "ListLosingBidsResponse"
},
"VideoContent": {
"type": "object",
"properties": {
"videoUrl": {
"description": "The URL to fetch a video ad.",
"type": "string"
}
},
"id": "VideoContent",
"description": "Video content for a creative."
},
"ImpressionMetricsRow": {
"id": "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.",
"type": "object",
"properties": {
"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."
},
"successfulResponses": {
"$ref": "MetricValue",
"description": "The number of impressions for which the buyer successfully sent a response\nto Ad Exchange."
},
"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."
}
}
},
"AuctionContext": {
"id": "AuctionContext",
"description": "@OutputOnly The auction type the restriction applies to.",
"type": "object",
"properties": {
"auctionTypes": {
"items": {
"type": "string",
"enum": [
"OPEN_AUCTION",
"DIRECT_DEALS"
]
},
"type": "array",
"enumDescriptions": [
"The restriction applies to open auction.",
"The restriction applies to direct deals."
],
"description": "The auction types this restriction applies to."
}
}
},
"ListImpressionMetricsResponse": {
"description": "Response message for listing the metrics that are measured in number of\nimpressions.",
"type": "object",
"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"
}
},
"id": "ListImpressionMetricsResponse"
},
"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;",
"type": "object",
"properties": {
"viewableImpressions": {
"description": "The number of bids for which the corresponding impression was viewable (as\ndefined by Active View).",
"$ref": "MetricValue"
},
"impressionsWon": {
"$ref": "MetricValue",
"description": "The number of bids that won an impression."
},
"measurableImpressions": {
"description": "The number of bids for which the corresponding impression was measurable\nfor viewability (as defined by Active View).",
"$ref": "MetricValue"
},
"bids": {
"description": "The number of bids that Ad Exchange received from the buyer.",
"$ref": "MetricValue"
},
"billedImpressions": {
"$ref": "MetricValue",
"description": "The number of bids for which the buyer was billed."
},
"bidsInAuction": {
"$ref": "MetricValue",
"description": "The number of bids that were permitted to compete in the auction."
},
"rowDimensions": {
"description": "The values of all dimensions associated with metric values in this row.",
"$ref": "RowDimensions"
}
},
"id": "BidMetricsRow"
},
"ListBidResponseErrorsResponse": {
"description": "Response message for listing all reasons that bid responses resulted in an\nerror.",
"type": "object",
"properties": {
"calloutStatusRows": {
"items": {
"$ref": "CalloutStatusRow"
},
"type": "array",
"description": "List of rows, with counts of bid responses aggregated by callout status."
},
"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"
}
},
"id": "ListBidResponseErrorsResponse"
},
"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.",
"type": "object",
"properties": {
"rowDimensions": {
"$ref": "RowDimensions",
"description": "The values of all dimensions associated with metric values in this row."
},
"creativeStatusId": {
"format": "int32",
"description": "The ID of the creative status.\nSee [creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
"type": "integer"
},
"bidCount": {
"$ref": "MetricValue",
"description": "The number of bids with the specified status."
}
},
"id": "CreativeStatusRow"
},
"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.",
"type": "object",
"properties": {
"startTimestamp": {
"format": "google-datetime",
"description": "The start timestamp of the real-time RTB metrics aggregation.",
"type": "string"
}
},
"id": "RealtimeTimeRange"
}
},
"protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
}
}