Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(123)

Issues Search
    My Issues | Starred     Open | Closed | All

Unified Diff: discovery/googleapis_beta/adexchangebuyer2__v2beta1.json

Issue 3003493002: Api-Roll 53: 2017-08-21 (Closed)
Patch Set: Created 3 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « discovery/googleapis/youtubereporting__v1.json ('k') | discovery/googleapis_beta/appengine__v1beta.json » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: discovery/googleapis_beta/adexchangebuyer2__v2beta1.json
diff --git a/discovery/googleapis_beta/adexchangebuyer2__v2beta1.json b/discovery/googleapis_beta/adexchangebuyer2__v2beta1.json
index 8dd8bd775bbd47b8fe5b03f677caf52067b7b968..121cca89a40b414368294173f15a7905254b57e3 100644
--- a/discovery/googleapis_beta/adexchangebuyer2__v2beta1.json
+++ b/discovery/googleapis_beta/adexchangebuyer2__v2beta1.json
@@ -14,7 +14,7 @@
"canonicalName": "AdExchangeBuyerII",
"description": "Accesses the latest features for managing Ad Exchange accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.",
"discoveryVersion": "v1",
- "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest/guides/client-access/",
+ "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest/reference/rest/",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
@@ -25,6 +25,33 @@
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
@@ -69,179 +96,226 @@
"location": "query",
"type": "string"
},
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query",
- "type": "string"
- },
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "location": "query",
- "type": "string"
- },
- "pp": {
- "default": "true",
- "description": "Pretty-print response.",
- "location": "query",
- "type": "boolean"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "location": "query",
- "type": "string"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
- },
- "prettyPrint": {
- "default": "true",
- "description": "Returns response with indentations and line breaks.",
- "location": "query",
- "type": "boolean"
}
},
"protocol": "rest",
"resources": {
"accounts": {
"resources": {
- "clients": {
+ "creatives": {
"methods": {
- "update": {
- "description": "Updates an existing client buyer.",
- "httpMethod": "PUT",
- "id": "adexchangebuyer2.accounts.clients.update",
+ "get": {
+ "description": "Gets a creative.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.accounts.creatives.get",
"parameterOrder": [
"accountId",
- "clientAccountId"
+ "creativeId"
],
"parameters": {
"accountId": {
- "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)",
- "format": "int64",
+ "description": "The account the creative belongs to.",
"location": "path",
"required": true,
"type": "string"
},
- "clientAccountId": {
- "description": "Unique numerical account ID of the client to update. (required)",
- "format": "int64",
+ "creativeId": {
+ "description": "The ID of the creative to retrieve.",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "watch": {
+ "description": "Watches a creative. Will result in push notifications being sent to the\ntopic when the creative changes status.",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer2.accounts.creatives.watch",
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account of the creative to watch.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "creativeId": {
+ "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.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
"request": {
- "$ref": "Client"
+ "$ref": "WatchCreativeRequest"
},
"response": {
- "$ref": "Client"
+ "$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
- "create": {
- "description": "Creates a new client buyer.",
- "httpMethod": "POST",
- "id": "adexchangebuyer2.accounts.clients.create",
+ "update": {
+ "description": "Updates a creative.",
+ "httpMethod": "PUT",
+ "id": "adexchangebuyer2.accounts.creatives.update",
"parameterOrder": [
- "accountId"
+ "accountId",
+ "creativeId"
],
"parameters": {
"accountId": {
- "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)",
- "format": "int64",
+ "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "creativeId": {
+ "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v2beta1/accounts/{accountId}/clients",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
"request": {
- "$ref": "Client"
+ "$ref": "Creative"
},
"response": {
- "$ref": "Client"
+ "$ref": "Creative"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
"list": {
- "description": "Lists all the clients for the current sponsor buyer.",
+ "description": "Lists creatives.",
"httpMethod": "GET",
- "id": "adexchangebuyer2.accounts.clients.list",
+ "id": "adexchangebuyer2.accounts.creatives.list",
"parameterOrder": [
"accountId"
],
"parameters": {
"pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientsResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.list method.",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativesResponse.next_page_token\nreturned from the previous call to 'ListCreatives' method.",
"location": "query",
"type": "string"
},
"pageSize": {
- "description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "description": "Requested page size. The server may return fewer creatives than requested\n(due to timeout constraint) even if more are available via another call.\nIf unspecified, server will pick an appropriate default.\nAcceptable values are 1 to 1000, inclusive.",
"format": "int32",
"location": "query",
"type": "integer"
},
"accountId": {
- "description": "Unique numerical account ID of the sponsor buyer to list the clients for.",
- "format": "int64",
+ "description": "The account to list the creatives from.\nSpecify \"-\" to list all creatives the current user has access to.",
"location": "path",
"required": true,
"type": "string"
+ },
+ "query": {
+ "description": "An optional query string to filter creatives. If no filter is specified,\nall active creatives will be returned.\nSupported queries are:\n<ul>\n<li>accountId=<i>account_id_string</i>\n<li>creativeId=<i>creative_id_string</i>\n<li>dealsStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n<li>openAuctionStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n<li>attribute: {a numeric attribute from the list of attributes}\n<li>disapprovalReason: {a reason from DisapprovalReason\n</ul>\nExample: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47'",
+ "location": "query",
+ "type": "string"
}
},
- "path": "v2beta1/accounts/{accountId}/clients",
+ "path": "v2beta1/accounts/{accountId}/creatives",
"response": {
- "$ref": "ListClientsResponse"
+ "$ref": "ListCreativesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
- "get": {
- "description": "Gets a client buyer with a given client account ID.",
- "httpMethod": "GET",
- "id": "adexchangebuyer2.accounts.clients.get",
+ "create": {
+ "description": "Creates a creative.",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer2.accounts.creatives.create",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "duplicateIdMode": {
+ "description": "Indicates if multiple creatives can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).",
+ "enum": [
+ "NO_DUPLICATES",
+ "FORCE_ENABLE_DUPLICATE_IDS"
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/creatives",
+ "request": {
+ "$ref": "Creative"
+ },
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "stopWatching": {
+ "description": "Stops watching a creative. Will stop push notifications being sent to the\ntopics when the creative changes status.",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer2.accounts.creatives.stopWatching",
"parameterOrder": [
"accountId",
- "clientAccountId"
+ "creativeId"
],
"parameters": {
"accountId": {
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
- "format": "int64",
+ "description": "The account of the creative to stop notifications for.",
"location": "path",
"required": true,
"type": "string"
},
- "clientAccountId": {
- "description": "Numerical account ID of the client buyer to retrieve. (required)",
- "format": "int64",
+ "creativeId": {
+ "description": "The creative ID of the creative to stop notifications for.\nSpecify \"-\" to specify stopping account level notifications.",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
+ "request": {
+ "$ref": "StopWatchingCreativeRequest"
+ },
"response": {
- "$ref": "Client"
+ "$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
@@ -249,574 +323,740 @@
}
},
"resources": {
- "invitations": {
+ "dealAssociations": {
"methods": {
"list": {
- "description": "Lists all the client users invitations for a client\nwith a given account ID.",
+ "description": "List all creative-deal associations.",
"httpMethod": "GET",
- "id": "adexchangebuyer2.accounts.clients.invitations.list",
+ "id": "adexchangebuyer2.accounts.creatives.dealAssociations.list",
"parameterOrder": [
"accountId",
- "clientAccountId"
+ "creativeId"
],
"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.",
- "location": "query",
- "type": "string"
- },
"pageSize": {
- "description": "Requested page size. Server may return fewer clients than requested.\nIf unspecified, server will pick an appropriate default.",
+ "description": "Requested page size. Server may return fewer associations than requested.\nIf unspecified, server will pick an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"accountId": {
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
- "format": "int64",
+ "description": "The account to list the associations from.\nSpecify \"-\" to list all creatives the current user has access to.",
"location": "path",
"required": true,
"type": "string"
},
- "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.",
+ "query": {
+ "description": "An optional query string to filter deal associations. If no filter is\nspecified, all associations will be returned.\nSupported queries are:\n<ul>\n<li>accountId=<i>account_id_string</i>\n<li>creativeId=<i>creative_id_string</i>\n<li>dealsId=<i>deals_id_string</i>\n<li>dealsStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n<li>openAuctionStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n</ul>\nExample: 'dealsId=12345 AND dealsStatus:disapproved'",
+ "location": "query",
+ "type": "string"
+ },
+ "creativeId": {
+ "description": "The creative ID to list the associations from.\nSpecify \"-\" to list all creatives under the above account.",
"location": "path",
"required": true,
"type": "string"
+ },
+ "pageToken": {
+ "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.",
+ "location": "query",
+ "type": "string"
}
},
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
"response": {
- "$ref": "ListClientUserInvitationsResponse"
+ "$ref": "ListDealAssociationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
- "get": {
- "description": "Retrieves an existing client user invitation.",
- "httpMethod": "GET",
- "id": "adexchangebuyer2.accounts.clients.invitations.get",
+ "remove": {
+ "description": "Remove the association between a deal and a creative.",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer2.accounts.creatives.dealAssociations.remove",
"parameterOrder": [
"accountId",
- "clientAccountId",
- "invitationId"
+ "creativeId"
],
"parameters": {
"accountId": {
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "clientAccountId": {
- "description": "Numerical account ID of the client buyer that the user invitation\nto be retrieved is associated with. (required)",
- "format": "int64",
+ "description": "The account the creative belongs to.",
"location": "path",
"required": true,
"type": "string"
},
- "invitationId": {
- "description": "Numerical identifier of the user invitation to retrieve. (required)",
- "format": "int64",
+ "creativeId": {
+ "description": "The ID of the creative associated with the deal.",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove",
+ "request": {
+ "$ref": "RemoveDealAssociationRequest"
+ },
"response": {
- "$ref": "ClientUserInvitation"
+ "$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
- "create": {
- "description": "Creates and sends out an email invitation to access\nan Ad Exchange client buyer account.",
+ "add": {
+ "description": "Associate an existing deal with a creative.",
"httpMethod": "POST",
- "id": "adexchangebuyer2.accounts.clients.invitations.create",
+ "id": "adexchangebuyer2.accounts.creatives.dealAssociations.add",
"parameterOrder": [
"accountId",
- "clientAccountId"
+ "creativeId"
],
"parameters": {
"accountId": {
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
- "format": "int64",
+ "description": "The account the creative belongs to.",
"location": "path",
"required": true,
"type": "string"
},
- "clientAccountId": {
- "description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)",
- "format": "int64",
+ "creativeId": {
+ "description": "The ID of the creative associated with the deal.",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
"request": {
- "$ref": "ClientUserInvitation"
+ "$ref": "AddDealAssociationRequest"
},
"response": {
- "$ref": "ClientUserInvitation"
+ "$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
}
}
+ }
+ }
+ },
+ "filterSets": {
+ "methods": {
+ "list": {
+ "description": "Lists all filter sets for the account with the given account ID.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.accounts.filterSets.list",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "accountId": {
+ "description": "Account ID of the buyer.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/filterSets",
+ "response": {
+ "$ref": "ListFilterSetsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
},
- "users": {
+ "get": {
+ "description": "Retrieves the requested filter set for the account with the given account\nID.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.accounts.filterSets.get",
+ "parameterOrder": [
+ "accountId",
+ "filterSetId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID of the buyer.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "filterSetId": {
+ "description": "The ID of the filter set to get.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}",
+ "response": {
+ "$ref": "FilterSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "create": {
+ "description": "Creates the specified filter set for the account with the given account ID.",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer2.accounts.filterSets.create",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "isTransient": {
+ "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.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "accountId": {
+ "description": "Account ID of the buyer.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/filterSets",
+ "request": {
+ "$ref": "FilterSet"
+ },
+ "response": {
+ "$ref": "FilterSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "delete": {
+ "description": "Deletes the requested filter set from the account with the given account\nID.",
+ "httpMethod": "DELETE",
+ "id": "adexchangebuyer2.accounts.filterSets.delete",
+ "parameterOrder": [
+ "accountId",
+ "filterSetId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Account ID of the buyer.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "filterSetId": {
+ "description": "The ID of the filter set to delete.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ },
+ "resources": {
+ "bidResponseErrors": {
"methods": {
- "get": {
- "description": "Retrieves an existing client user.",
+ "list": {
+ "description": "List all errors that occurred in bid responses, with the number of bid\nresponses affected for each reason.",
"httpMethod": "GET",
- "id": "adexchangebuyer2.accounts.clients.users.get",
+ "id": "adexchangebuyer2.accounts.filterSets.bidResponseErrors.list",
"parameterOrder": [
"accountId",
- "clientAccountId",
- "userId"
+ "filterSetId"
],
"parameters": {
- "userId": {
- "description": "Numerical identifier of the user to retrieve. (required)",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
},
"accountId": {
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "description": "Account ID of the buyer.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
- "clientAccountId": {
- "description": "Numerical account ID of the client buyer\nthat the user to be retrieved is associated with. (required)",
+ "filterSetId": {
+ "description": "The ID of the filter set to apply.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidResponseErrors.list\nmethod.",
+ "location": "query",
+ "type": "string"
}
},
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponseErrors",
"response": {
- "$ref": "ClientUser"
+ "$ref": "ListBidResponseErrorsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
- },
+ }
+ }
+ },
+ "bidResponsesWithoutBids": {
+ "methods": {
"list": {
- "description": "Lists all the known client users for a specified\nsponsor buyer account ID.",
+ "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.",
"httpMethod": "GET",
- "id": "adexchangebuyer2.accounts.clients.users.list",
+ "id": "adexchangebuyer2.accounts.filterSets.bidResponsesWithoutBids.list",
"parameterOrder": [
"accountId",
- "clientAccountId"
+ "filterSetId"
],
"parameters": {
"pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUsersResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.users.list method.",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidResponsesWithoutBids.list\nmethod.",
"location": "query",
"type": "string"
},
"pageSize": {
- "description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"accountId": {
- "description": "Numerical account ID of the sponsor buyer of the client to list users for.\n(required)",
+ "description": "Account ID of the buyer.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
- "clientAccountId": {
- "description": "The account ID of the client buyer to list users for. (required)\nYou must specify either a string representation of a\nnumerical account identifier or the `-` character\nto list all the client users for all the clients\nof a given sponsor buyer.",
+ "filterSetId": {
+ "description": "The ID of the filter set to apply.",
+ "format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponsesWithoutBids",
"response": {
- "$ref": "ListClientUsersResponse"
+ "$ref": "ListBidResponsesWithoutBidsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
- },
- "update": {
- "description": "Updates an existing client user.\nOnly the user status can be changed on update.",
- "httpMethod": "PUT",
- "id": "adexchangebuyer2.accounts.clients.users.update",
+ }
+ }
+ },
+ "filteredBidRequests": {
+ "methods": {
+ "list": {
+ "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.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.accounts.filterSets.filteredBidRequests.list",
"parameterOrder": [
"accountId",
- "clientAccountId",
- "userId"
+ "filterSetId"
],
"parameters": {
- "userId": {
- "description": "Numerical identifier of the user to retrieve. (required)",
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "accountId": {
+ "description": "Account ID of the buyer.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "filterSetId": {
+ "description": "The ID of the filter set to apply.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidRequestsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBidRequests.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBidRequests",
+ "response": {
+ "$ref": "ListFilteredBidRequestsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "nonBillableWinningBids": {
+ "methods": {
+ "list": {
+ "description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.accounts.filterSets.nonBillableWinningBids.list",
+ "parameterOrder": [
+ "accountId",
+ "filterSetId"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.nonBillableWinningBids.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
"accountId": {
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "description": "Account ID of the buyer.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
- "clientAccountId": {
- "description": "Numerical account ID of the client buyer that the user to be retrieved\nis associated with. (required)",
+ "filterSetId": {
+ "description": "The ID of the filter set to apply.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "request": {
- "$ref": "ClientUser"
- },
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/nonBillableWinningBids",
"response": {
- "$ref": "ClientUser"
+ "$ref": "ListNonBillableWinningBidsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
}
}
- }
- }
- },
- "creatives": {
- "methods": {
- "get": {
- "description": "Gets a creative.",
- "httpMethod": "GET",
- "id": "adexchangebuyer2.accounts.creatives.get",
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "parameters": {
- "accountId": {
- "description": "The account the creative belongs to.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "creativeId": {
- "description": "The ID of the creative to retrieve.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "watch": {
- "description": "Watches a creative. Will result in push notifications being sent to the\ntopic when the creative changes status.",
- "httpMethod": "POST",
- "id": "adexchangebuyer2.accounts.creatives.watch",
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "parameters": {
- "accountId": {
- "description": "The account of the creative to watch.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "creativeId": {
- "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.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
- "request": {
- "$ref": "WatchCreativeRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
},
- "update": {
- "description": "Updates a creative.",
- "httpMethod": "PUT",
- "id": "adexchangebuyer2.accounts.creatives.update",
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "parameters": {
- "accountId": {
- "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "creativeId": {
- "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "location": "path",
- "required": true,
- "type": "string"
+ "filteredBids": {
+ "methods": {
+ "list": {
+ "description": "List all reasons for which bids were filtered, with the number of bids\nfiltered for each reason.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.accounts.filterSets.filteredBids.list",
+ "parameterOrder": [
+ "accountId",
+ "filterSetId"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "accountId": {
+ "description": "Account ID of the buyer.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "filterSetId": {
+ "description": "The ID of the filter set to apply.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids",
+ "response": {
+ "$ref": "ListFilteredBidsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
}
},
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "list": {
- "description": "Lists creatives.",
- "httpMethod": "GET",
- "id": "adexchangebuyer2.accounts.creatives.list",
- "parameterOrder": [
- "accountId"
- ],
- "parameters": {
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativesResponse.next_page_token\nreturned from the previous call to 'ListCreatives' method.",
- "location": "query",
- "type": "string"
- },
- "pageSize": {
- "description": "Requested page size. The server may return fewer creatives than requested\n(due to timeout constraint) even if more are available via another call.\nIf unspecified, server will pick an appropriate default.\nAcceptable values are 1 to 1000, inclusive.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "accountId": {
- "description": "The account to list the creatives from.\nSpecify \"-\" to list all creatives the current user has access to.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "query": {
- "description": "An optional query string to filter creatives. If no filter is specified,\nall active creatives will be returned.\nSupported queries are:\n<ul>\n<li>accountId=<i>account_id_string</i>\n<li>creativeId=<i>creative_id_string</i>\n<li>dealsStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n<li>openAuctionStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n<li>attribute: {a numeric attribute from the list of attributes}\n<li>disapprovalReason: {a reason from DisapprovalReason\n</ul>\nExample: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47'",
- "location": "query",
- "type": "string"
- }
- },
- "path": "v2beta1/accounts/{accountId}/creatives",
- "response": {
- "$ref": "ListCreativesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "create": {
- "description": "Creates a creative.",
- "httpMethod": "POST",
- "id": "adexchangebuyer2.accounts.creatives.create",
- "parameterOrder": [
- "accountId"
- ],
- "parameters": {
- "duplicateIdMode": {
- "description": "Indicates if multiple creatives can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).",
- "enum": [
- "NO_DUPLICATES",
- "FORCE_ENABLE_DUPLICATE_IDS"
- ],
- "location": "query",
- "type": "string"
+ "resources": {
+ "creatives": {
+ "methods": {
+ "list": {
+ "description": "List all creatives associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.accounts.filterSets.filteredBids.creatives.list",
+ "parameterOrder": [
+ "accountId",
+ "filterSetId",
+ "creativeStatusId"
+ ],
+ "parameters": {
+ "pageToken": {
+ "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "creativeStatusId": {
+ "description": "The ID of the creative status for which to retrieve a breakdown by\ncreative.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "accountId": {
+ "description": "Account ID of the buyer.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "filterSetId": {
+ "description": "The ID of the filter set to apply.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives",
+ "response": {
+ "$ref": "ListCreativeStatusBreakdownByCreativeResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
},
- "accountId": {
- "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "location": "path",
- "required": true,
- "type": "string"
+ "details": {
+ "methods": {
+ "list": {
+ "description": "List all details associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each detail.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.accounts.filterSets.filteredBids.details.list",
+ "parameterOrder": [
+ "accountId",
+ "filterSetId",
+ "creativeStatusId"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByDetailResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.details.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ },
+ "creativeStatusId": {
+ "description": "The ID of the creative status for which to retrieve a breakdown by detail.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).\nDetails are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.",
+ "format": "int32",
+ "location": "path",
+ "required": true,
+ "type": "integer"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "accountId": {
+ "description": "Account ID of the buyer.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "filterSetId": {
+ "description": "The ID of the filter set to apply.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/details",
+ "response": {
+ "$ref": "ListCreativeStatusBreakdownByDetailResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
}
- },
- "path": "v2beta1/accounts/{accountId}/creatives",
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
+ }
},
- "stopWatching": {
- "description": "Stops watching a creative. Will stop push notifications being sent to the\ntopics when the creative changes status.",
- "httpMethod": "POST",
- "id": "adexchangebuyer2.accounts.creatives.stopWatching",
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "parameters": {
- "creativeId": {
- "description": "The creative ID of the creative to stop notifications for.\nSpecify \"-\" to specify stopping account level notifications.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "accountId": {
- "description": "The account of the creative to stop notifications for.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
- "request": {
- "$ref": "StopWatchingCreativeRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- },
- "resources": {
- "dealAssociations": {
+ "losingBids": {
"methods": {
- "remove": {
- "description": "Remove the association between a deal and a creative.",
- "httpMethod": "POST",
- "id": "adexchangebuyer2.accounts.creatives.dealAssociations.remove",
+ "list": {
+ "description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.accounts.filterSets.losingBids.list",
"parameterOrder": [
"accountId",
- "creativeId"
+ "filterSetId"
],
"parameters": {
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
"accountId": {
- "description": "The account the creative belongs to.",
+ "description": "Account ID of the buyer.",
+ "format": "int64",
"location": "path",
"required": true,
"type": "string"
},
- "creativeId": {
- "description": "The ID of the creative associated with the deal.",
+ "filterSetId": {
+ "description": "The ID of the filter set to apply.",
+ "format": "int64",
"location": "path",
"required": true,
"type": "string"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListLosingBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.losingBids.list\nmethod.",
+ "location": "query",
+ "type": "string"
}
},
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove",
- "request": {
- "$ref": "RemoveDealAssociationRequest"
- },
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/losingBids",
"response": {
- "$ref": "Empty"
+ "$ref": "ListLosingBidsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
- },
- "add": {
- "description": "Associate an existing deal with a creative.",
- "httpMethod": "POST",
- "id": "adexchangebuyer2.accounts.creatives.dealAssociations.add",
+ }
+ }
+ },
+ "impressionMetrics": {
+ "methods": {
+ "list": {
+ "description": "Lists all metrics that are measured in terms of number of impressions.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.accounts.filterSets.impressionMetrics.list",
"parameterOrder": [
"accountId",
- "creativeId"
+ "filterSetId"
],
"parameters": {
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.impressionMetrics.list\nmethod.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
"accountId": {
- "description": "The account the creative belongs to.",
+ "description": "Account ID of the buyer.",
+ "format": "int64",
"location": "path",
"required": true,
"type": "string"
},
- "creativeId": {
- "description": "The ID of the creative associated with the deal.",
+ "filterSetId": {
+ "description": "The ID of the filter set to apply.",
+ "format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
- "request": {
- "$ref": "AddDealAssociationRequest"
- },
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/impressionMetrics",
"response": {
- "$ref": "Empty"
+ "$ref": "ListImpressionMetricsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
- },
+ }
+ }
+ },
+ "bidMetrics": {
+ "methods": {
"list": {
- "description": "List all creative-deal associations.",
+ "description": "Lists all metrics that are measured in terms of number of bids.",
"httpMethod": "GET",
- "id": "adexchangebuyer2.accounts.creatives.dealAssociations.list",
+ "id": "adexchangebuyer2.accounts.filterSets.bidMetrics.list",
"parameterOrder": [
"accountId",
- "creativeId"
+ "filterSetId"
],
"parameters": {
- "creativeId": {
- "description": "The creative ID to list the associations from.\nSpecify \"-\" to list all creatives under the above account.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListDealAssociationsResponse.next_page_token\nreturned from the previous call to 'ListDealAssociations' method.",
- "location": "query",
- "type": "string"
- },
"pageSize": {
- "description": "Requested page size. Server may return fewer associations than requested.\nIf unspecified, server will pick an appropriate default.",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"accountId": {
- "description": "The account to list the associations from.\nSpecify \"-\" to list all creatives the current user has access to.",
+ "description": "Account ID of the buyer.",
+ "format": "int64",
"location": "path",
"required": true,
"type": "string"
},
- "query": {
- "description": "An optional query string to filter deal associations. If no filter is\nspecified, all associations will be returned.\nSupported queries are:\n<ul>\n<li>accountId=<i>account_id_string</i>\n<li>creativeId=<i>creative_id_string</i>\n<li>dealsId=<i>deals_id_string</i>\n<li>dealsStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n<li>openAuctionStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n</ul>\nExample: 'dealsId=12345 AND dealsStatus:disapproved'",
+ "filterSetId": {
+ "description": "The ID of the filter set to apply.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidMetricsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidMetrics.list\nmethod.",
"location": "query",
"type": "string"
}
},
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidMetrics",
"response": {
- "$ref": "ListDealAssociationsResponse"
+ "$ref": "ListBidMetricsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
@@ -826,134 +1066,132 @@
}
}
},
- "filterSets": {
+ "clients": {
"methods": {
- "delete": {
- "description": "Deletes the requested filter set from the account with the given account\nID.",
- "httpMethod": "DELETE",
- "id": "adexchangebuyer2.accounts.filterSets.delete",
+ "list": {
+ "description": "Lists all the clients for the current sponsor buyer.",
+ "httpMethod": "GET",
+ "id": "adexchangebuyer2.accounts.clients.list",
"parameterOrder": [
- "accountId",
- "filterSetId"
+ "accountId"
],
"parameters": {
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
"accountId": {
- "description": "Account ID of the buyer.",
+ "description": "Unique numerical account ID of the sponsor buyer to list the clients for.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
- "filterSetId": {
- "description": "The ID of the filter set to delete.",
- "format": "int64",
- "location": "path",
- "required": true,
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientsResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.list method.",
+ "location": "query",
"type": "string"
}
},
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}",
+ "path": "v2beta1/accounts/{accountId}/clients",
"response": {
- "$ref": "Empty"
+ "$ref": "ListClientsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
- "list": {
- "description": "Lists all filter sets for the account with the given account ID.",
+ "get": {
+ "description": "Gets a client buyer with a given client account ID.",
"httpMethod": "GET",
- "id": "adexchangebuyer2.accounts.filterSets.list",
+ "id": "adexchangebuyer2.accounts.clients.get",
"parameterOrder": [
- "accountId"
+ "accountId",
+ "clientAccountId"
],
"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.",
- "location": "query",
+ "accountId": {
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "format": "int64",
+ "location": "path",
+ "required": true,
"type": "string"
},
- "pageSize": {
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "accountId": {
- "description": "Account ID of the buyer.",
+ "clientAccountId": {
+ "description": "Numerical account ID of the client buyer to retrieve. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v2beta1/accounts/{accountId}/filterSets",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
"response": {
- "$ref": "ListFilterSetsResponse"
+ "$ref": "Client"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
- "get": {
- "description": "Retrieves the requested filter set for the account with the given account\nID.",
- "httpMethod": "GET",
- "id": "adexchangebuyer2.accounts.filterSets.get",
+ "update": {
+ "description": "Updates an existing client buyer.",
+ "httpMethod": "PUT",
+ "id": "adexchangebuyer2.accounts.clients.update",
"parameterOrder": [
"accountId",
- "filterSetId"
+ "clientAccountId"
],
"parameters": {
- "filterSetId": {
- "description": "The ID of the filter set to get.",
+ "accountId": {
+ "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)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
- "accountId": {
- "description": "Account ID of the buyer.",
+ "clientAccountId": {
+ "description": "Unique numerical account ID of the client to update. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
+ "request": {
+ "$ref": "Client"
+ },
"response": {
- "$ref": "FilterSet"
+ "$ref": "Client"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
"create": {
- "description": "Creates the specified filter set for the account with the given account ID.",
+ "description": "Creates a new client buyer.",
"httpMethod": "POST",
- "id": "adexchangebuyer2.accounts.filterSets.create",
+ "id": "adexchangebuyer2.accounts.clients.create",
"parameterOrder": [
"accountId"
],
"parameters": {
- "isTransient": {
- "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.",
- "location": "query",
- "type": "boolean"
- },
"accountId": {
- "description": "Account ID of the buyer.",
+ "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)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v2beta1/accounts/{accountId}/filterSets",
+ "path": "v2beta1/accounts/{accountId}/clients",
"request": {
- "$ref": "FilterSet"
+ "$ref": "Client"
},
"response": {
- "$ref": "FilterSet"
+ "$ref": "Client"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
@@ -961,346 +1199,128 @@
}
},
"resources": {
- "filteredBidRequests": {
- "methods": {
- "list": {
- "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.",
- "httpMethod": "GET",
- "id": "adexchangebuyer2.accounts.filterSets.filteredBidRequests.list",
- "parameterOrder": [
- "accountId",
- "filterSetId"
- ],
- "parameters": {
- "filterSetId": {
- "description": "The ID of the filter set to apply.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidRequestsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBidRequests.list\nmethod.",
- "location": "query",
- "type": "string"
- },
- "pageSize": {
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "accountId": {
- "description": "Account ID of the buyer.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBidRequests",
- "response": {
- "$ref": "ListFilteredBidRequestsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "nonBillableWinningBids": {
- "methods": {
- "list": {
- "description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason.",
- "httpMethod": "GET",
- "id": "adexchangebuyer2.accounts.filterSets.nonBillableWinningBids.list",
- "parameterOrder": [
- "accountId",
- "filterSetId"
- ],
- "parameters": {
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.nonBillableWinningBids.list\nmethod.",
- "location": "query",
- "type": "string"
- },
- "pageSize": {
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "accountId": {
- "description": "Account ID of the buyer.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "filterSetId": {
- "description": "The ID of the filter set to apply.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/nonBillableWinningBids",
- "response": {
- "$ref": "ListNonBillableWinningBidsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "filteredBids": {
+ "users": {
"methods": {
- "list": {
- "description": "List all reasons for which bids were filtered, with the number of bids\nfiltered for each reason.",
+ "get": {
+ "description": "Retrieves an existing client user.",
"httpMethod": "GET",
- "id": "adexchangebuyer2.accounts.filterSets.filteredBids.list",
+ "id": "adexchangebuyer2.accounts.clients.users.get",
"parameterOrder": [
"accountId",
- "filterSetId"
+ "clientAccountId",
+ "userId"
],
"parameters": {
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.list\nmethod.",
- "location": "query",
- "type": "string"
- },
- "pageSize": {
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
"accountId": {
- "description": "Account ID of the buyer.",
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
- "filterSetId": {
- "description": "The ID of the filter set to apply.",
+ "clientAccountId": {
+ "description": "Numerical account ID of the client buyer\nthat the user to be retrieved is associated with. (required)",
"format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids",
- "response": {
- "$ref": "ListFilteredBidsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- },
- "resources": {
- "details": {
- "methods": {
- "list": {
- "description": "List all details associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each detail.",
- "httpMethod": "GET",
- "id": "adexchangebuyer2.accounts.filterSets.filteredBids.details.list",
- "parameterOrder": [
- "accountId",
- "filterSetId",
- "creativeStatusId"
- ],
- "parameters": {
- "filterSetId": {
- "description": "The ID of the filter set to apply.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByDetailResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.details.list\nmethod.",
- "location": "query",
- "type": "string"
- },
- "creativeStatusId": {
- "description": "The ID of the creative status for which to retrieve a breakdown by detail.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).\nDetails are only available for statuses 14, 15, 17, 18, 19, 86, and 87.",
- "format": "int32",
- "location": "path",
- "required": true,
- "type": "integer"
- },
- "pageSize": {
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "accountId": {
- "description": "Account ID of the buyer.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/details",
- "response": {
- "$ref": "ListCreativeStatusBreakdownByDetailResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- }
- }
- },
- "creatives": {
- "methods": {
- "list": {
- "description": "List all creatives associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative.",
- "httpMethod": "GET",
- "id": "adexchangebuyer2.accounts.filterSets.filteredBids.creatives.list",
- "parameterOrder": [
- "accountId",
- "filterSetId",
- "creativeStatusId"
- ],
- "parameters": {
- "filterSetId": {
- "description": "The ID of the filter set to apply.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByCreativeResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.creatives.list\nmethod.",
- "location": "query",
- "type": "string"
- },
- "creativeStatusId": {
- "description": "The ID of the creative status for which to retrieve a breakdown by\ncreative.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
- "format": "int32",
- "location": "path",
- "required": true,
- "type": "integer"
- },
- "pageSize": {
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "accountId": {
- "description": "Account ID of the buyer.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives",
- "response": {
- "$ref": "ListCreativeStatusBreakdownByCreativeResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "Numerical identifier of the user to retrieve. (required)",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
}
- }
- }
- }
- },
- "losingBids": {
- "methods": {
+ },
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
+ "response": {
+ "$ref": "ClientUser"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
"list": {
- "description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason.",
+ "description": "Lists all the known client users for a specified\nsponsor buyer account ID.",
"httpMethod": "GET",
- "id": "adexchangebuyer2.accounts.filterSets.losingBids.list",
+ "id": "adexchangebuyer2.accounts.clients.users.list",
"parameterOrder": [
"accountId",
- "filterSetId"
+ "clientAccountId"
],
"parameters": {
- "pageToken": {
- "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.",
- "location": "query",
- "type": "string"
- },
"pageSize": {
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"accountId": {
- "description": "Account ID of the buyer.",
+ "description": "Numerical account ID of the sponsor buyer of the client to list users for.\n(required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
- "filterSetId": {
- "description": "The ID of the filter set to apply.",
- "format": "int64",
+ "clientAccountId": {
+ "description": "The account ID of the client buyer to list users for. (required)\nYou must specify either a string representation of a\nnumerical account identifier or the `-` character\nto list all the client users for all the clients\nof a given sponsor buyer.",
"location": "path",
"required": true,
"type": "string"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUsersResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.users.list method.",
+ "location": "query",
+ "type": "string"
}
},
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/losingBids",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
"response": {
- "$ref": "ListLosingBidsResponse"
+ "$ref": "ListClientUsersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
- }
- }
- },
- "impressionMetrics": {
- "methods": {
- "list": {
- "description": "Lists all metrics that are measured in terms of number of impressions.",
- "httpMethod": "GET",
- "id": "adexchangebuyer2.accounts.filterSets.impressionMetrics.list",
+ },
+ "update": {
+ "description": "Updates an existing client user.\nOnly the user status can be changed on update.",
+ "httpMethod": "PUT",
+ "id": "adexchangebuyer2.accounts.clients.users.update",
"parameterOrder": [
"accountId",
- "filterSetId"
+ "clientAccountId",
+ "userId"
],
"parameters": {
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.impressionMetrics.list\nmethod.",
- "location": "query",
+ "accountId": {
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "format": "int64",
+ "location": "path",
+ "required": true,
"type": "string"
},
- "pageSize": {
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "accountId": {
- "description": "Account ID of the buyer.",
+ "clientAccountId": {
+ "description": "Numerical account ID of the client buyer that the user to be retrieved\nis associated with. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
- "filterSetId": {
- "description": "The ID of the filter set to apply.",
+ "userId": {
+ "description": "Numerical identifier of the user to retrieve. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/impressionMetrics",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
+ "request": {
+ "$ref": "ClientUser"
+ },
"response": {
- "$ref": "ListImpressionMetricsResponse"
+ "$ref": "ClientUser"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
@@ -1308,140 +1328,120 @@
}
}
},
- "bidMetrics": {
+ "invitations": {
"methods": {
"list": {
- "description": "Lists all metrics that are measured in terms of number of bids.",
+ "description": "Lists all the client users invitations for a client\nwith a given account ID.",
"httpMethod": "GET",
- "id": "adexchangebuyer2.accounts.filterSets.bidMetrics.list",
+ "id": "adexchangebuyer2.accounts.clients.invitations.list",
"parameterOrder": [
"accountId",
- "filterSetId"
+ "clientAccountId"
],
"parameters": {
"pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidMetricsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidMetrics.list\nmethod.",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUserInvitationsResponse.nextPageToken\nreturned from the previous call to the\nclients.invitations.list\nmethod.",
"location": "query",
"type": "string"
},
"pageSize": {
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "description": "Requested page size. Server may return fewer clients than requested.\nIf unspecified, server will pick an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"accountId": {
- "description": "Account ID of the buyer.",
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
- "filterSetId": {
- "description": "The ID of the filter set to apply.",
- "format": "int64",
+ "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.",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidMetrics",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
"response": {
- "$ref": "ListBidMetricsResponse"
+ "$ref": "ListClientUserInvitationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
- }
- }
- },
- "bidResponseErrors": {
- "methods": {
- "list": {
- "description": "List all errors that occurred in bid responses, with the number of bid\nresponses affected for each reason.",
+ },
+ "get": {
+ "description": "Retrieves an existing client user invitation.",
"httpMethod": "GET",
- "id": "adexchangebuyer2.accounts.filterSets.bidResponseErrors.list",
+ "id": "adexchangebuyer2.accounts.clients.invitations.get",
"parameterOrder": [
"accountId",
- "filterSetId"
+ "clientAccountId",
+ "invitationId"
],
"parameters": {
- "filterSetId": {
- "description": "The ID of the filter set to apply.",
+ "invitationId": {
+ "description": "Numerical identifier of the user invitation to retrieve. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidResponseErrors.list\nmethod.",
- "location": "query",
+ "accountId": {
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "format": "int64",
+ "location": "path",
+ "required": true,
"type": "string"
},
- "pageSize": {
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "accountId": {
- "description": "Account ID of the buyer.",
+ "clientAccountId": {
+ "description": "Numerical account ID of the client buyer that the user invitation\nto be retrieved is associated with. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponseErrors",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
"response": {
- "$ref": "ListBidResponseErrorsResponse"
+ "$ref": "ClientUserInvitation"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
- }
- }
- },
- "bidResponsesWithoutBids": {
- "methods": {
- "list": {
- "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.",
- "httpMethod": "GET",
- "id": "adexchangebuyer2.accounts.filterSets.bidResponsesWithoutBids.list",
+ },
+ "create": {
+ "description": "Creates and sends out an email invitation to access\nan Ad Exchange client buyer account.",
+ "httpMethod": "POST",
+ "id": "adexchangebuyer2.accounts.clients.invitations.create",
"parameterOrder": [
"accountId",
- "filterSetId"
+ "clientAccountId"
],
"parameters": {
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidResponsesWithoutBids.list\nmethod.",
- "location": "query",
- "type": "string"
- },
- "pageSize": {
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
"accountId": {
- "description": "Account ID of the buyer.",
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
- "filterSetId": {
- "description": "The ID of the filter set to apply.",
+ "clientAccountId": {
+ "description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponsesWithoutBids",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
+ "request": {
+ "$ref": "ClientUserInvitation"
+ },
"response": {
- "$ref": "ListBidResponsesWithoutBidsResponse"
+ "$ref": "ClientUserInvitation"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
@@ -1451,12 +1451,201 @@
}
}
}
- }
- }
- },
- "revision": "20170720",
- "rootUrl": "https://adexchangebuyer.googleapis.com/",
- "schemas": {
+ }
+ }
+ },
+ "revision": "20170815",
+ "rootUrl": "https://adexchangebuyer.googleapis.com/",
+ "schemas": {
+ "AuctionContext": {
+ "description": "@OutputOnly The auction type the restriction applies to.",
+ "id": "AuctionContext",
+ "properties": {
+ "auctionTypes": {
+ "description": "The auction types this restriction applies to.",
+ "enumDescriptions": [
+ "The restriction applies to open auction.",
+ "The restriction applies to direct deals."
+ ],
+ "items": {
+ "enum": [
+ "OPEN_AUCTION",
+ "DIRECT_DEALS"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListImpressionMetricsResponse": {
+ "description": "Response message for listing the metrics that are measured in number of\nimpressions.",
+ "id": "ListImpressionMetricsResponse",
+ "properties": {
+ "impressionMetricsRows": {
+ "description": "List of rows, each containing a set of impression metrics.",
+ "items": {
+ "$ref": "ImpressionMetricsRow"
+ },
+ "type": "array"
+ },
+ "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"
+ }
+ },
+ "type": "object"
+ },
+ "BidMetricsRow": {
+ "description": "The set of metrics that are measured in numbers of bids, representing how\nmany bids with the specified dimension values were considered eligible at\neach stage of the bidding funnel;",
+ "id": "BidMetricsRow",
+ "properties": {
+ "bids": {
+ "$ref": "MetricValue",
+ "description": "The number of bids that Ad Exchange received from the buyer."
+ },
+ "billedImpressions": {
+ "$ref": "MetricValue",
+ "description": "The number of bids for which the buyer was billed."
+ },
+ "bidsInAuction": {
+ "$ref": "MetricValue",
+ "description": "The number of bids that were permitted to compete in the auction."
+ },
+ "rowDimensions": {
+ "$ref": "RowDimensions",
+ "description": "The values of all dimensions associated with metric values in this row."
+ },
+ "viewableImpressions": {
+ "$ref": "MetricValue",
+ "description": "The number of bids for which the corresponding impression was viewable (as\ndefined by Active View)."
+ },
+ "impressionsWon": {
+ "$ref": "MetricValue",
+ "description": "The number of bids that won an impression."
+ },
+ "measurableImpressions": {
+ "$ref": "MetricValue",
+ "description": "The number of bids for which the corresponding impression was measurable\nfor viewability (as defined by Active View)."
+ }
+ },
+ "type": "object"
+ },
+ "ListBidResponseErrorsResponse": {
+ "description": "Response message for listing all reasons that bid responses resulted in an\nerror.",
+ "id": "ListBidResponseErrorsResponse",
+ "properties": {
+ "calloutStatusRows": {
+ "description": "List of rows, with counts of bid responses aggregated by callout status.",
+ "items": {
+ "$ref": "CalloutStatusRow"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidResponseErrorsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.bidResponseErrors.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CreativeStatusRow": {
+ "description": "The number of bids with the specified dimension values that did not win the\nauction (either were filtered pre-auction or lost the auction), as described\nby the specified creative status.",
+ "id": "CreativeStatusRow",
+ "properties": {
+ "bidCount": {
+ "$ref": "MetricValue",
+ "description": "The number of bids with the specified status."
+ },
+ "rowDimensions": {
+ "$ref": "RowDimensions",
+ "description": "The values of all dimensions associated with metric values in this row."
+ },
+ "creativeStatusId": {
+ "description": "The ID of the creative status.\nSee [creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "RealtimeTimeRange": {
+ "description": "An open-ended realtime time range specified by the start timestamp.\nFor filter sets that specify a realtime time range RTB metrics continue to\nbe aggregated throughout the lifetime of the filter set.",
+ "id": "RealtimeTimeRange",
+ "properties": {
+ "startTimestamp": {
+ "description": "The start timestamp of the real-time RTB metrics aggregation.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "NonBillableWinningBidStatusRow": {
+ "description": "The number of winning bids with the specified dimension values for which the\nbuyer was not billed, as described by the specified status.",
+ "id": "NonBillableWinningBidStatusRow",
+ "properties": {
+ "bidCount": {
+ "$ref": "MetricValue",
+ "description": "The number of bids with the specified status."
+ },
+ "status": {
+ "description": "The status specifying why the winning bids were not billed.",
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "AD_NOT_RENDERED",
+ "INVALID_IMPRESSION"
+ ],
+ "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."
+ ],
+ "type": "string"
+ },
+ "rowDimensions": {
+ "$ref": "RowDimensions",
+ "description": "The values of all dimensions associated with metric values in this row."
+ }
+ },
+ "type": "object"
+ },
+ "FilteredBidDetailRow": {
+ "description": "The number of filtered bids with the specified dimension values, among those\nfiltered due to the requested filtering reason (i.e. creative status), that\nhave the specified detail.",
+ "id": "FilteredBidDetailRow",
+ "properties": {
+ "detailId": {
+ "description": "The ID of the detail. The associated value can be looked up in the\ndictionary file corresponding to the DetailType in the response message.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "bidCount": {
+ "$ref": "MetricValue",
+ "description": "The number of bids with the specified detail."
+ },
+ "rowDimensions": {
+ "$ref": "RowDimensions",
+ "description": "The values of all dimensions associated with metric values in this row."
+ }
+ },
+ "type": "object"
+ },
+ "AbsoluteDateRange": {
+ "description": "An absolute date range, specified by its start date and end date.\nThe supported range of dates begins 30 days before today and ends today.\nValidity checked upon filter set creation. If a filter set with an absolute\ndate range is run at a later date more than 30 days after start_date, it will\nfail.",
+ "id": "AbsoluteDateRange",
+ "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": {
+ "$ref": "Date",
+ "description": "The start date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor before end_date."
+ }
+ },
+ "type": "object"
+ },
"AddDealAssociationRequest": {
"description": "A request for associating a deal and a creative.",
"id": "AddDealAssociationRequest",
@@ -1519,23 +1708,44 @@
"description": "A relative date range, specified by an offset and a duration.\nThe supported range of dates begins 30 days before today and ends today.\nI.e. the limits for these values are:\noffset_days >= 0\nduration_days >= 1\noffset_days + duration_days <= 30",
"id": "RelativeDateRange",
"properties": {
- "durationDays": {
- "description": "The number of days in the requested date range. E.g. for a range spanning\ntoday, 1. For a range spanning the last 7 days, 7.",
+ "offsetDays": {
+ "description": "The end date of the filter set, specified as the number of days before\ntoday. E.g. for a range where the last date is today, 0.",
"format": "int32",
"type": "integer"
},
- "offsetDays": {
- "description": "The end date of the filter set, specified as the number of days before\ntoday. E.g. for a range where the last date is today, 0.",
+ "durationDays": {
+ "description": "The number of days in the requested date range. E.g. for a range spanning\ntoday, 1. For a range spanning the last 7 days, 7.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
+ "ListClientsResponse": {
+ "id": "ListClientsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientsRequest.pageToken\nfield in the subsequent call to the\naccounts.clients.list method\nto retrieve the next page of results.",
+ "type": "string"
+ },
+ "clients": {
+ "description": "The returned list of clients.",
+ "items": {
+ "$ref": "Client"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
"NativeContent": {
"description": "Native content for a creative.",
"id": "NativeContent",
"properties": {
+ "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"
@@ -1573,38 +1783,17 @@
"description": "The price of the promoted app including currency info.",
"type": "string"
},
- "clickTrackingUrl": {
- "description": "The URL to use for click tracking.",
- "type": "string"
- },
"image": {
"$ref": "Image",
"description": "A large image."
},
- "advertiserName": {
- "description": "The name of the advertiser or sponsor, to be displayed in the ad creative.",
+ "clickTrackingUrl": {
+ "description": "The URL to use for click tracking.",
"type": "string"
},
- "storeUrl": {
- "description": "The URL to the app store to purchase/download the promoted app.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ListClientsResponse": {
- "id": "ListClientsResponse",
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientsRequest.pageToken\nfield in the subsequent call to the\naccounts.clients.list method\nto retrieve the next page of results.",
+ "advertiserName": {
+ "description": "The name of the advertiser or sponsor, to be displayed in the ad creative.",
"type": "string"
- },
- "clients": {
- "description": "The returned list of clients.",
- "items": {
- "$ref": "Client"
- },
- "type": "array"
}
},
"type": "object"
@@ -1631,10 +1820,6 @@
"description": "The serving context for this restriction.",
"id": "ServingContext",
"properties": {
- "appType": {
- "$ref": "AppContext",
- "description": "Matches impressions for a particular app type."
- },
"securityType": {
"$ref": "SecurityContext",
"description": "Matches impressions for a particular security type."
@@ -1660,6 +1845,10 @@
"A simple context."
],
"type": "string"
+ },
+ "appType": {
+ "$ref": "AppContext",
+ "description": "Matches impressions for a particular app type."
}
},
"type": "object"
@@ -1668,6 +1857,11 @@
"description": "An image resource. You may provide a larger image than was requested,\nso long as the aspect ratio is preserved.",
"id": "Image",
"properties": {
+ "height": {
+ "description": "Image height in pixels.",
+ "format": "int32",
+ "type": "integer"
+ },
"width": {
"description": "Image width in pixels.",
"format": "int32",
@@ -1676,11 +1870,6 @@
"url": {
"description": "The URL of the image.",
"type": "string"
- },
- "height": {
- "description": "Image height in pixels.",
- "format": "int32",
- "type": "integer"
}
},
"type": "object"
@@ -1707,10 +1896,6 @@
"description": "The number of impressions with the specified dimension values that were\nconsidered to have no applicable bids, as described by the specified status.",
"id": "BidResponseWithoutBidsStatusRow",
"properties": {
- "rowDimensions": {
- "$ref": "RowDimensions",
- "description": "The values of all dimensions associated with metric values in this row."
- },
"impressionCount": {
"$ref": "MetricValue",
"description": "The number of impressions for which there was a bid response with the\nspecified status."
@@ -1730,6 +1915,10 @@
"The response had no bids for the specified deal, though it may have\nincluded bids on other deals on behalf of the account to which the deal\nbelongs."
],
"type": "string"
+ },
+ "rowDimensions": {
+ "$ref": "RowDimensions",
+ "description": "The values of all dimensions associated with metric values in this row."
}
},
"type": "object"
@@ -1738,6 +1927,11 @@
"description": "An invitation for a new client user to get access to the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.",
"id": "ClientUserInvitation",
"properties": {
+ "clientAccountId": {
+ "description": "Numerical account ID of the client buyer\nthat the invited user is associated with.\nThe value of this field is ignored in create operations.",
+ "format": "int64",
+ "type": "string"
+ },
"invitationId": {
"description": "The unique numerical ID of the invitation that is sent to the user.\nThe value of this field is ignored in create operations.",
"format": "int64",
@@ -1746,11 +1940,6 @@
"email": {
"description": "The email address to which the invitation is sent. Email\naddresses should be unique among all client users under each sponsor\nbuyer.",
"type": "string"
- },
- "clientAccountId": {
- "description": "Numerical account ID of the client buyer\nthat the invited user is associated with.\nThe value of this field is ignored in create operations.",
- "format": "int64",
- "type": "string"
}
},
"type": "object"
@@ -1759,17 +1948,6 @@
"description": "Response message for listing all details associated with a given filtered bid\nreason.",
"id": "ListCreativeStatusBreakdownByDetailResponse",
"properties": {
- "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"
- },
"detailType": {
"description": "The type of detail that the detail IDs represent.",
"enum": [
@@ -1777,16 +1955,29 @@
"CREATIVE_ATTRIBUTE",
"VENDOR",
"SENSITIVE_CATEGORY",
- "PRODUCT_CATEGORY"
+ "PRODUCT_CATEGORY",
+ "DISAPPROVAL_REASON"
],
"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 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)."
],
"type": "string"
+ },
+ "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"
}
},
"type": "object"
@@ -1937,18 +2128,115 @@
},
"type": "object"
},
+ "FilteringStats": {
+ "description": "@OutputOnly Filtering reasons for this creative during a period of a single\nday (from midnight to midnight Pacific).",
+ "id": "FilteringStats",
+ "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."
+ }
+ },
+ "type": "object"
+ },
"Creative": {
"description": "A creative and its classification data.",
"id": "Creative",
"properties": {
+ "filteringStats": {
+ "$ref": "FilteringStats",
+ "description": "@OutputOnly The filtering stats for this creative."
+ },
+ "attributes": {
+ "description": "All attributes for the ads that may be shown from this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "enumDescriptions": [
+ "Do not use. This is a placeholder value only.",
+ "The creative is tagged.",
+ "The creative is cookie targeted.",
+ "The creative is user interest targeted.",
+ "The creative does not expand.",
+ "The creative expands up.",
+ "The creative expands down.",
+ "The creative expands left.",
+ "The creative expands right.",
+ "The creative expands up and left.",
+ "The creative expands up and right.",
+ "The creative expands down and left.",
+ "The creative expands down and right.",
+ "The creative expands up or down.",
+ "The creative expands left or right.",
+ "The creative expands on any diagonal.",
+ "The creative expands when rolled over.",
+ "The instream vast video type is vpaid flash.",
+ "The creative is MRAID",
+ "The creative is SSL.",
+ "The creative is an interstitial.",
+ "The creative is eligible for native.",
+ "The creative is not eligible for native.",
+ "The creative can dynamically resize to fill a variety of slot sizes."
+ ],
+ "items": {
+ "enum": [
+ "ATTRIBUTE_UNSPECIFIED",
+ "IS_TAGGED",
+ "IS_COOKIE_TARGETED",
+ "IS_USER_INTEREST_TARGETED",
+ "EXPANDING_DIRECTION_NONE",
+ "EXPANDING_DIRECTION_UP",
+ "EXPANDING_DIRECTION_DOWN",
+ "EXPANDING_DIRECTION_LEFT",
+ "EXPANDING_DIRECTION_RIGHT",
+ "EXPANDING_DIRECTION_UP_LEFT",
+ "EXPANDING_DIRECTION_UP_RIGHT",
+ "EXPANDING_DIRECTION_DOWN_LEFT",
+ "EXPANDING_DIRECTION_DOWN_RIGHT",
+ "EXPANDING_DIRECTION_UP_OR_DOWN",
+ "EXPANDING_DIRECTION_LEFT_OR_RIGHT",
+ "EXPANDING_DIRECTION_ANY_DIAGONAL",
+ "EXPANDING_ACTION_ROLLOVER_TO_EXPAND",
+ "INSTREAM_VAST_VIDEO_TYPE_VPAID_FLASH",
+ "RICH_MEDIA_CAPABILITY_TYPE_MRAID",
+ "RICH_MEDIA_CAPABILITY_TYPE_SSL",
+ "RICH_MEDIA_CAPABILITY_TYPE_INTERSTITIAL",
+ "NATIVE_ELIGIBILITY_ELIGIBLE",
+ "NATIVE_ELIGIBILITY_NOT_ELIGIBLE",
+ "RENDERING_SIZELESS_ADX"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "apiUpdateTime": {
+ "description": "@OutputOnly The last update timestamp of the creative via API.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "detectedLanguages": {
+ "description": "@OutputOnly\nThe detected languages for this creative. The order is arbitrary. The codes\nare 2 or 5 characters and are documented at\nhttps://developers.google.com/adwords/api/docs/appendix/languagecodes.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "creativeId": {
+ "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "type": "string"
+ },
+ "accountId": {
+ "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "type": "string"
+ },
"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": {
@@ -1956,6 +2244,10 @@
},
"type": "array"
},
+ "video": {
+ "$ref": "VideoContent",
+ "description": "A video creative."
+ },
"agencyId": {
"description": "The agency ID for this creative.",
"format": "int64",
@@ -2008,187 +2300,86 @@
"type": "integer"
},
"vendorIds": {
- "description": "All vendor IDs for the ads that may be shown from this creative.\nSee https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt\nfor possible values.",
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "impressionTrackingUrls": {
- "description": "The set of URLs to be called to record an impression.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "html": {
- "$ref": "HtmlContent",
- "description": "An HTML creative."
- },
- "dealsStatus": {
- "description": "@OutputOnly The top-level deals status of this creative.\nIf disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "enum": [
- "STATUS_UNSPECIFIED",
- "NOT_CHECKED",
- "CONDITIONALLY_APPROVED",
- "APPROVED",
- "DISAPPROVED"
- ],
- "enumDescriptions": [
- "The status is unknown.",
- "The creative has not been checked.",
- "The creative has been conditionally approved.\nSee serving_restrictions for details.",
- "The creative has been approved.",
- "The creative has been disapproved."
- ],
- "type": "string"
- },
- "detectedProductCategories": {
- "description": "@OutputOnly Detected product categories, if any.\nSee the ad-product-categories.txt file in the technical documentation\nfor a list of IDs.",
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "openAuctionStatus": {
- "description": "@OutputOnly The top-level open auction status of this creative.\nIf disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "enum": [
- "STATUS_UNSPECIFIED",
- "NOT_CHECKED",
- "CONDITIONALLY_APPROVED",
- "APPROVED",
- "DISAPPROVED"
- ],
- "enumDescriptions": [
- "The status is unknown.",
- "The creative has not been checked.",
- "The creative has been conditionally approved.\nSee serving_restrictions for details.",
- "The creative has been approved.",
- "The creative has been disapproved."
- ],
- "type": "string"
- },
- "advertiserName": {
- "description": "The name of the company being advertised in the creative.",
- "type": "string"
- },
- "detectedDomains": {
- "description": "@OutputOnly\nThe detected domains for this creative.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "detectedAdvertiserIds": {
- "description": "@OutputOnly Detected advertiser IDs, if any.",
- "items": {
- "format": "int64",
- "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.",
- "enumDescriptions": [
- "Do not use. This is a placeholder value only.",
- "The creative is tagged.",
- "The creative is cookie targeted.",
- "The creative is user interest targeted.",
- "The creative does not expand.",
- "The creative expands up.",
- "The creative expands down.",
- "The creative expands left.",
- "The creative expands right.",
- "The creative expands up and left.",
- "The creative expands up and right.",
- "The creative expands down and left.",
- "The creative expands down and right.",
- "The creative expands up or down.",
- "The creative expands left or right.",
- "The creative expands on any diagonal.",
- "The creative expands when rolled over.",
- "The instream vast video type is vpaid flash.",
- "The creative is MRAID",
- "The creative is SSL.",
- "The creative is an interstitial.",
- "The creative is eligible for native.",
- "The creative is not eligible for native.",
- "The creative can dynamically resize to fill a variety of slot sizes."
- ],
- "items": {
- "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"
- ],
+ "description": "All vendor IDs for the ads that may be shown from this creative.\nSee https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt\nfor possible values.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "impressionTrackingUrls": {
+ "description": "The set of URLs to be called to record an impression.",
+ "items": {
"type": "string"
},
"type": "array"
},
- "apiUpdateTime": {
- "description": "@OutputOnly The last update timestamp of the creative via API.",
- "format": "google-datetime",
- "type": "string"
+ "html": {
+ "$ref": "HtmlContent",
+ "description": "An HTML creative."
},
- "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.",
+ "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": {
- "type": "string"
+ "format": "int32",
+ "type": "integer"
},
"type": "array"
},
- "creativeId": {
- "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "dealsStatus": {
+ "description": "@OutputOnly The top-level deals status of this creative.\nIf disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "NOT_CHECKED",
+ "CONDITIONALLY_APPROVED",
+ "APPROVED",
+ "DISAPPROVED"
+ ],
+ "enumDescriptions": [
+ "The status is unknown.",
+ "The creative has not been checked.",
+ "The creative has been conditionally approved.\nSee serving_restrictions for details.",
+ "The creative has been approved.",
+ "The creative has been disapproved."
+ ],
"type": "string"
},
- "accountId": {
- "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "openAuctionStatus": {
+ "description": "@OutputOnly The top-level open auction status of this creative.\nIf disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "NOT_CHECKED",
+ "CONDITIONALLY_APPROVED",
+ "APPROVED",
+ "DISAPPROVED"
+ ],
+ "enumDescriptions": [
+ "The status is unknown.",
+ "The creative has not been checked.",
+ "The creative has been conditionally approved.\nSee serving_restrictions for details.",
+ "The creative has been approved.",
+ "The creative has been disapproved."
+ ],
"type": "string"
- }
- },
- "type": "object"
- },
- "FilteringStats": {
- "description": "@OutputOnly Filtering reasons for this creative during a period of a single\nday (from midnight to midnight Pacific).",
- "id": "FilteringStats",
- "properties": {
- "reasons": {
- "description": "The set of filtering reasons for this date.",
+ },
+ "advertiserName": {
+ "description": "The name of the company being advertised in the creative.",
+ "type": "string"
+ },
+ "detectedAdvertiserIds": {
+ "description": "@OutputOnly Detected advertiser IDs, if any.",
"items": {
- "$ref": "Reason"
+ "format": "int64",
+ "type": "string"
},
"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."
+ "detectedDomains": {
+ "description": "@OutputOnly\nThe detected domains for this creative.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
"type": "object"
@@ -2204,24 +2395,6 @@
},
"type": "object"
},
- "ListCreativeStatusBreakdownByCreativeResponse": {
- "description": "Response message for listing all creatives associated with a given filtered\nbid reason.",
- "id": "ListCreativeStatusBreakdownByCreativeResponse",
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByCreativeRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.creatives.list\nmethod to retrieve the next page of results.",
- "type": "string"
- },
- "filteredBidCreativeRows": {
- "description": "List of rows, with counts of bids with a given creative status aggregated\nby creative.",
- "items": {
- "$ref": "FilteredBidCreativeRow"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
"Client": {
"description": "A client resource represents a client buyer&mdash;an agency,\na brand, or an advertiser customer of the sponsor buyer.\nUsers associated with the client buyer have restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the client buyer.\nAll fields are required unless otherwise specified.",
"id": "Client",
@@ -2297,24 +2470,28 @@
},
"type": "object"
},
- "Correction": {
- "description": "@OutputOnly Shows any corrections that were applied to this creative.",
- "id": "Correction",
+ "ListCreativeStatusBreakdownByCreativeResponse": {
+ "description": "Response message for listing all creatives associated with a given filtered\nbid reason.",
+ "id": "ListCreativeStatusBreakdownByCreativeResponse",
"properties": {
- "contexts": {
- "description": "The contexts for the correction.",
- "items": {
- "$ref": "ServingContext"
- },
- "type": "array"
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByCreativeRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.creatives.list\nmethod to retrieve the next page of results.",
+ "type": "string"
},
- "details": {
- "description": "Additional details about what was corrected.",
+ "filteredBidCreativeRows": {
+ "description": "List of rows, with counts of bids with a given creative status aggregated\nby creative.",
"items": {
- "type": "string"
+ "$ref": "FilteredBidCreativeRow"
},
"type": "array"
- },
+ }
+ },
+ "type": "object"
+ },
+ "Correction": {
+ "description": "@OutputOnly Shows any corrections that were applied to this creative.",
+ "id": "Correction",
+ "properties": {
"type": {
"description": "The type of correction that was applied to the creative.",
"enum": [
@@ -2346,6 +2523,20 @@
"The ad contains video content."
],
"type": "string"
+ },
+ "contexts": {
+ "description": "The contexts for the correction.",
+ "items": {
+ "$ref": "ServingContext"
+ },
+ "type": "array"
+ },
+ "details": {
+ "description": "Additional details about what was corrected.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
"type": "object"
@@ -2354,6 +2545,29 @@
"description": "A set of filters that is applied to a request for data.\nWithin a filter set, an AND operation is performed across the filters\nrepresented by each field. An OR operation is performed across the filters\nrepresented by the multiple values of a repeated field. E.g.\n\"format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR\nseller_network_id=56)\"",
"id": "FilterSet",
"properties": {
+ "relativeDateRange": {
+ "$ref": "RelativeDateRange",
+ "description": "A relative date range, defined by an offset from today and a duration.\nInterpreted relative to Pacific time zone."
+ },
+ "platforms": {
+ "description": "The list of platforms on which to filter; may be empty. The filters\nrepresented by multiple platforms are ORed together (i.e. if non-empty,\nresults must match any one of the platforms).",
+ "enumDescriptions": [
+ "A placeholder for an undefined platform; indicates that no platform\nfilter will be applied.",
+ "The ad impression appears on a desktop.",
+ "The ad impression appears on a tablet.",
+ "The ad impression appears on a mobile device."
+ ],
+ "items": {
+ "enum": [
+ "PLATFORM_UNSPECIFIED",
+ "DESKTOP",
+ "TABLET",
+ "MOBILE"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
"sellerNetworkIds": {
"description": "The list of IDs of the seller (publisher) networks on which to filter;\nmay be empty. The filters represented by multiple seller network IDs are\nORed together (i.e. if non-empty, results must match any one of the\npublisher networks).\nSee [seller-network-ids](https://developers.google.com/ad-exchange/rtb/downloads/seller-network-ids)\nfile for the set of existing seller network IDs.",
"items": {
@@ -2367,15 +2581,15 @@
"format": "int64",
"type": "string"
},
+ "absoluteDateRange": {
+ "$ref": "AbsoluteDateRange",
+ "description": "An absolute date range, defined by a start date and an end date.\nInterpreted relative to Pacific time zone."
+ },
"buyerAccountId": {
"description": "The ID of the buyer account on which to filter; optional.",
"format": "int64",
"type": "string"
},
- "absoluteDateRange": {
- "$ref": "AbsoluteDateRange",
- "description": "An absolute date range, defined by a start date and an end date.\nInterpreted relative to Pacific time zone."
- },
"environment": {
"description": "The environment on which to filter; optional.",
"enum": [
@@ -2435,29 +2649,26 @@
"creativeId": {
"description": "The ID of the creative on which to filter; optional.",
"type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CalloutStatusRow": {
+ "description": "The number of impressions with the specified dimension values where the\ncorresponding bid request or bid response was not successful, as described by\nthe specified callout status.",
+ "id": "CalloutStatusRow",
+ "properties": {
+ "impressionCount": {
+ "$ref": "MetricValue",
+ "description": "The number of impressions for which there was a bid request or bid response\nwith the specified callout status."
},
- "platforms": {
- "description": "The list of platforms on which to filter; may be empty. The filters\nrepresented by multiple platforms are ORed together (i.e. if non-empty,\nresults must match any one of the platforms).",
- "enumDescriptions": [
- "A placeholder for an undefined platform; indicates that no platform\nfilter will be applied.",
- "The ad impression appears on a desktop.",
- "The ad impression appears on a tablet.",
- "The ad impression appears on a mobile device."
- ],
- "items": {
- "enum": [
- "PLATFORM_UNSPECIFIED",
- "DESKTOP",
- "TABLET",
- "MOBILE"
- ],
- "type": "string"
- },
- "type": "array"
+ "rowDimensions": {
+ "$ref": "RowDimensions",
+ "description": "The values of all dimensions associated with metric values in this row."
},
- "relativeDateRange": {
- "$ref": "RelativeDateRange",
- "description": "A relative date range, defined by an offset from today and a duration.\nInterpreted relative to Pacific time zone."
+ "calloutStatusId": {
+ "description": "The ID of the callout status.\nSee [callout-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/callout-status-codes).",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
@@ -2480,24 +2691,10 @@
},
"type": "object"
},
- "CalloutStatusRow": {
- "description": "The number of impressions with the specified dimension values where the\ncorresponding bid request or bid response was not successful, as described by\nthe specified callout status.",
- "id": "CalloutStatusRow",
- "properties": {
- "impressionCount": {
- "$ref": "MetricValue",
- "description": "The number of impressions for which there was a bid request or bid response\nwith the specified callout status."
- },
- "rowDimensions": {
- "$ref": "RowDimensions",
- "description": "The values of all dimensions associated with metric values in this row."
- },
- "calloutStatusId": {
- "description": "The ID of the callout status.\nSee [callout-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/callout-status-codes).",
- "format": "int32",
- "type": "integer"
- }
- },
+ "StopWatchingCreativeRequest": {
+ "description": "A request for stopping notifications for changes to creative Status.",
+ "id": "StopWatchingCreativeRequest",
+ "properties": {},
"type": "object"
},
"Disapproval": {
@@ -2710,23 +2907,10 @@
},
"type": "object"
},
- "StopWatchingCreativeRequest": {
- "description": "A request for stopping notifications for changes to creative Status.",
- "id": "StopWatchingCreativeRequest",
- "properties": {},
- "type": "object"
- },
"ServingRestriction": {
"description": "@OutputOnly A representation of the status of an ad in a\nspecific context. A context here relates to where something ultimately serves\n(for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,\nor the type of auction).",
"id": "ServingRestriction",
"properties": {
- "contexts": {
- "description": "The contexts for the restriction.",
- "items": {
- "$ref": "ServingContext"
- },
- "type": "array"
- },
"status": {
"description": "The status of the creative in this context (for example, it has been\nexplicitly disapproved or is pending review).",
"enum": [
@@ -2747,6 +2931,13 @@
"$ref": "Disapproval"
},
"type": "array"
+ },
+ "contexts": {
+ "description": "The contexts for the restriction.",
+ "items": {
+ "$ref": "ServingContext"
+ },
+ "type": "array"
}
},
"type": "object"
@@ -2870,24 +3061,6 @@
},
"type": "object"
},
- "ListCreativesResponse": {
- "description": "A response for listing creatives.",
- "id": "ListCreativesResponse",
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativesRequest.page_token\nfield in the subsequent call to `ListCreatives` method to retrieve the next\npage of results.",
- "type": "string"
- },
- "creatives": {
- "description": "The list of creatives.",
- "items": {
- "$ref": "Creative"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
"HtmlContent": {
"description": "HTML content for a creative.",
"id": "HtmlContent",
@@ -2909,6 +3082,24 @@
},
"type": "object"
},
+ "ListCreativesResponse": {
+ "description": "A response for listing creatives.",
+ "id": "ListCreativesResponse",
+ "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"
+ }
+ },
+ "type": "object"
+ },
"ListBidMetricsResponse": {
"description": "Response message for listing the metrics that are measured in number of bids.",
"id": "ListBidMetricsResponse",
@@ -2959,16 +3150,16 @@
"description": "Response message for listing all reasons that bids lost in the auction.",
"id": "ListLosingBidsResponse",
"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"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListLosingBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.losingBids.list\nmethod to retrieve the next page of results.",
+ "type": "string"
}
},
"type": "object"
@@ -2977,16 +3168,16 @@
"description": "Response message for listing all reasons for which a buyer was not billed for\na winning bid.",
"id": "ListNonBillableWinningBidsResponse",
"properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListNonBillableWinningBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.nonBillableWinningBids.list\nmethod to retrieve the next page of results.",
- "type": "string"
- },
"nonBillableWinningBidStatusRows": {
"description": "List of rows, with counts of bids not billed aggregated by reason.",
"items": {
"$ref": "NonBillableWinningBidStatusRow"
},
"type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListNonBillableWinningBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.nonBillableWinningBids.list\nmethod to retrieve the next page of results.",
+ "type": "string"
}
},
"type": "object"
@@ -3003,14 +3194,14 @@
"$ref": "MetricValue",
"description": "The number of impressions available to the buyer on Ad Exchange.\nIn some cases this value may be unavailable."
},
- "bidRequests": {
- "$ref": "MetricValue",
- "description": "The number of impressions for which Ad Exchange sent the buyer a bid\nrequest."
- },
"inventoryMatches": {
"$ref": "MetricValue",
"description": "The number of impressions that match the buyer's inventory pretargeting."
},
+ "bidRequests": {
+ "$ref": "MetricValue",
+ "description": "The number of impressions for which Ad Exchange sent the buyer a bid\nrequest."
+ },
"responsesWithBids": {
"$ref": "MetricValue",
"description": "The number of impressions for which Ad Exchange received a response from\nthe buyer that contained at least one applicable bid."
@@ -3021,195 +3212,6 @@
}
},
"type": "object"
- },
- "AuctionContext": {
- "description": "@OutputOnly The auction type the restriction applies to.",
- "id": "AuctionContext",
- "properties": {
- "auctionTypes": {
- "description": "The auction types this restriction applies to.",
- "enumDescriptions": [
- "The restriction applies to open auction.",
- "The restriction applies to direct deals."
- ],
- "items": {
- "enum": [
- "OPEN_AUCTION",
- "DIRECT_DEALS"
- ],
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ListImpressionMetricsResponse": {
- "description": "Response message for listing the metrics that are measured in number of\nimpressions.",
- "id": "ListImpressionMetricsResponse",
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListImpressionMetricsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.impressionMetrics.list\nmethod to retrieve the next page of results.",
- "type": "string"
- },
- "impressionMetricsRows": {
- "description": "List of rows, each containing a set of impression metrics.",
- "items": {
- "$ref": "ImpressionMetricsRow"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "BidMetricsRow": {
- "description": "The set of metrics that are measured in numbers of bids, representing how\nmany bids with the specified dimension values were considered eligible at\neach stage of the bidding funnel;",
- "id": "BidMetricsRow",
- "properties": {
- "measurableImpressions": {
- "$ref": "MetricValue",
- "description": "The number of bids for which the corresponding impression was measurable\nfor viewability (as defined by Active View)."
- },
- "bids": {
- "$ref": "MetricValue",
- "description": "The number of bids that Ad Exchange received from the buyer."
- },
- "billedImpressions": {
- "$ref": "MetricValue",
- "description": "The number of bids for which the buyer was billed."
- },
- "bidsInAuction": {
- "$ref": "MetricValue",
- "description": "The number of bids that were permitted to compete in the auction."
- },
- "rowDimensions": {
- "$ref": "RowDimensions",
- "description": "The values of all dimensions associated with metric values in this row."
- },
- "impressionsWon": {
- "$ref": "MetricValue",
- "description": "The number of bids that won an impression."
- },
- "viewableImpressions": {
- "$ref": "MetricValue",
- "description": "The number of bids for which the corresponding impression was viewable (as\ndefined by Active View)."
- }
- },
- "type": "object"
- },
- "ListBidResponseErrorsResponse": {
- "description": "Response message for listing all reasons that bid responses resulted in an\nerror.",
- "id": "ListBidResponseErrorsResponse",
- "properties": {
- "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"
- },
- "calloutStatusRows": {
- "description": "List of rows, with counts of bid responses aggregated by callout status.",
- "items": {
- "$ref": "CalloutStatusRow"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "CreativeStatusRow": {
- "description": "The number of bids with the specified dimension values that did not win the\nauction (either were filtered pre-auction or lost the auction), as described\nby the specified creative status.",
- "id": "CreativeStatusRow",
- "properties": {
- "rowDimensions": {
- "$ref": "RowDimensions",
- "description": "The values of all dimensions associated with metric values in this row."
- },
- "creativeStatusId": {
- "description": "The ID of the creative status.\nSee [creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
- "format": "int32",
- "type": "integer"
- },
- "bidCount": {
- "$ref": "MetricValue",
- "description": "The number of bids with the specified status."
- }
- },
- "type": "object"
- },
- "RealtimeTimeRange": {
- "description": "An open-ended realtime time range specified by the start timestamp.\nFor filter sets that specify a realtime time range RTB metrics continue to\nbe aggregated throughout the lifetime of the filter set.",
- "id": "RealtimeTimeRange",
- "properties": {
- "startTimestamp": {
- "description": "The start timestamp of the real-time RTB metrics aggregation.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "type": "object"
- },
- "NonBillableWinningBidStatusRow": {
- "description": "The number of winning bids with the specified dimension values for which the\nbuyer was not billed, as described by the specified status.",
- "id": "NonBillableWinningBidStatusRow",
- "properties": {
- "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 status."
- },
- "status": {
- "description": "The status specifying why the winning bids were not billed.",
- "enum": [
- "STATUS_UNSPECIFIED",
- "AD_NOT_RENDERED",
- "INVALID_IMPRESSION"
- ],
- "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."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "FilteredBidDetailRow": {
- "description": "The number of filtered bids with the specified dimension values, among those\nfiltered due to the requested filtering reason (i.e. creative status), that\nhave the specified detail.",
- "id": "FilteredBidDetailRow",
- "properties": {
- "rowDimensions": {
- "$ref": "RowDimensions",
- "description": "The values of all dimensions associated with metric values in this row."
- },
- "detailId": {
- "description": "The ID of the detail. The associated value can be looked up in the\ndictionary file corresponding to the DetailType in the response message.",
- "format": "int32",
- "type": "integer"
- },
- "bidCount": {
- "$ref": "MetricValue",
- "description": "The number of bids with 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.",
- "id": "AbsoluteDateRange",
- "properties": {
- "startDate": {
- "$ref": "Date",
- "description": "The start date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor before end_date."
- },
- "endDate": {
- "$ref": "Date",
- "description": "The end date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor after start_date."
- }
- },
- "type": "object"
}
},
"servicePath": "",
« no previous file with comments | « discovery/googleapis/youtubereporting__v1.json ('k') | discovery/googleapis_beta/appengine__v1beta.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698