Index: discovery/googleapis_beta/adexchangebuyer2__v2beta1.json |
diff --git a/discovery/googleapis_beta/adexchangebuyer2__v2beta1.json b/discovery/googleapis_beta/adexchangebuyer2__v2beta1.json |
index 5f2779a92836202cbc175b30c99f406ee708f827..7bc2955692e6609492b0009f0a61a4b78e4f60f9 100644 |
--- a/discovery/googleapis_beta/adexchangebuyer2__v2beta1.json |
+++ b/discovery/googleapis_beta/adexchangebuyer2__v2beta1.json |
@@ -25,16 +25,48 @@ |
"ownerDomain": "google.com", |
"ownerName": "Google", |
"parameters": { |
- "uploadType": { |
- "description": "Legacy upload protocol for media (e.g. \"media\", \"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" |
+ }, |
+ "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" |
+ }, |
"fields": { |
"description": "Selector specifying which fields to include in a partial response.", |
"location": "query", |
"type": "string" |
}, |
+ "uploadType": { |
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
+ "location": "query", |
+ "type": "string" |
+ }, |
"$.xgafv": { |
"description": "V1 error format.", |
"enum": [ |
@@ -78,38 +110,6 @@ |
"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" |
- }, |
- "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" |
- }, |
- "oauth_token": { |
- "description": "OAuth 2.0 token for the current user.", |
- "location": "query", |
- "type": "string" |
- }, |
- "bearer_token": { |
- "description": "OAuth bearer token.", |
- "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" |
} |
}, |
"protocol": "rest", |
@@ -118,33 +118,6 @@ |
"resources": { |
"clients": { |
"methods": { |
- "create": { |
- "description": "Creates a new client buyer.", |
- "httpMethod": "POST", |
- "id": "adexchangebuyer2.accounts.clients.create", |
- "parameterOrder": [ |
- "accountId" |
- ], |
- "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", |
- "location": "path", |
- "required": true, |
- "type": "string" |
- } |
- }, |
- "path": "v2beta1/accounts/{accountId}/clients", |
- "request": { |
- "$ref": "Client" |
- }, |
- "response": { |
- "$ref": "Client" |
- }, |
- "scopes": [ |
- "https://www.googleapis.com/auth/adexchange.buyer" |
- ] |
- }, |
"get": { |
"description": "Gets a client buyer with a given client account ID.", |
"httpMethod": "GET", |
@@ -246,6 +219,33 @@ |
"scopes": [ |
"https://www.googleapis.com/auth/adexchange.buyer" |
] |
+ }, |
+ "create": { |
+ "description": "Creates a new client buyer.", |
+ "httpMethod": "POST", |
+ "id": "adexchangebuyer2.accounts.clients.create", |
+ "parameterOrder": [ |
+ "accountId" |
+ ], |
+ "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", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "path": "v2beta1/accounts/{accountId}/clients", |
+ "request": { |
+ "$ref": "Client" |
+ }, |
+ "response": { |
+ "$ref": "Client" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/adexchange.buyer" |
+ ] |
} |
}, |
"resources": { |
@@ -300,6 +300,11 @@ |
"clientAccountId" |
], |
"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" |
+ }, |
"accountId": { |
"description": "Numerical account ID of the client's sponsor buyer. (required)", |
"format": "int64", |
@@ -318,11 +323,6 @@ |
"location": "path", |
"required": true, |
"type": "string" |
- }, |
- "pageToken": { |
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUserInvitationsResponse.nextPageToken\nreturned from the previous call to the\nclients.invitations.list\nmethod.", |
- "location": "query", |
- "type": "string" |
} |
}, |
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations", |
@@ -342,15 +342,15 @@ |
"clientAccountId" |
], |
"parameters": { |
- "clientAccountId": { |
- "description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)", |
+ "accountId": { |
+ "description": "Numerical account ID of the client's sponsor buyer. (required)", |
"format": "int64", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
- "accountId": { |
- "description": "Numerical account ID of the client's sponsor buyer. (required)", |
+ "clientAccountId": { |
+ "description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)", |
"format": "int64", |
"location": "path", |
"required": true, |
@@ -381,12 +381,6 @@ |
"clientAccountId" |
], |
"parameters": { |
- "clientAccountId": { |
- "description": "The account ID of the client buyer to list users for. (required)\nYou must specify either a string representation of a\nnumerical account identifier or the `-` character\nto list all the client users for all the clients\nof a given sponsor buyer.", |
- "location": "path", |
- "required": true, |
- "type": "string" |
- }, |
"pageToken": { |
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUsersResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.users.list method.", |
"location": "query", |
@@ -404,6 +398,12 @@ |
"format": "int32", |
"location": "query", |
"type": "integer" |
+ }, |
+ "clientAccountId": { |
+ "description": "The account ID of the client buyer to list users for. (required)\nYou must specify either a string representation of a\nnumerical account identifier or the `-` character\nto list all the client users for all the clients\nof a given sponsor buyer.", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
} |
}, |
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users", |
@@ -424,22 +424,22 @@ |
"userId" |
], |
"parameters": { |
- "accountId": { |
- "description": "Numerical account ID of the client's sponsor buyer. (required)", |
+ "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" |
}, |
- "clientAccountId": { |
- "description": "Numerical account ID of the client buyer\nthat the user to be retrieved is associated with. (required)", |
+ "userId": { |
+ "description": "Numerical identifier of the user to retrieve. (required)", |
"format": "int64", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
- "userId": { |
- "description": "Numerical identifier of the user to retrieve. (required)", |
+ "accountId": { |
+ "description": "Numerical account ID of the client's sponsor buyer. (required)", |
"format": "int64", |
"location": "path", |
"required": true, |
@@ -503,74 +503,6 @@ |
}, |
"creatives": { |
"methods": { |
- "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", |
- "creativeId" |
- ], |
- "parameters": { |
- "accountId": { |
- "description": "The account of the creative to stop notifications for.", |
- "location": "path", |
- "required": true, |
- "type": "string" |
- }, |
- "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}/creatives/{creativeId}:stopWatching", |
- "request": { |
- "$ref": "StopWatchingCreativeRequest" |
- }, |
- "response": { |
- "$ref": "Empty" |
- }, |
- "scopes": [ |
- "https://www.googleapis.com/auth/adexchange.buyer" |
- ] |
- }, |
"get": { |
"description": "Gets a creative.", |
"httpMethod": "GET", |
@@ -705,30 +637,98 @@ |
"scopes": [ |
"https://www.googleapis.com/auth/adexchange.buyer" |
] |
- } |
- }, |
- "resources": { |
- "dealAssociations": { |
- "methods": { |
- "list": { |
- "description": "List all creative-deal associations.", |
- "httpMethod": "GET", |
- "id": "adexchangebuyer2.accounts.creatives.dealAssociations.list", |
- "parameterOrder": [ |
- "accountId", |
- "creativeId" |
- ], |
- "parameters": { |
- "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" |
- }, |
- "accountId": { |
- "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" |
+ }, |
+ "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", |
+ "creativeId" |
+ ], |
+ "parameters": { |
+ "accountId": { |
+ "description": "The account of the creative to stop notifications for.", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ }, |
+ "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}/creatives/{creativeId}:stopWatching", |
+ "request": { |
+ "$ref": "StopWatchingCreativeRequest" |
+ }, |
+ "response": { |
+ "$ref": "Empty" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/adexchange.buyer" |
+ ] |
+ } |
+ }, |
+ "resources": { |
+ "dealAssociations": { |
+ "methods": { |
+ "list": { |
+ "description": "List all creative-deal associations.", |
+ "httpMethod": "GET", |
+ "id": "adexchangebuyer2.accounts.creatives.dealAssociations.list", |
+ "parameterOrder": [ |
+ "accountId", |
+ "creativeId" |
+ ], |
+ "parameters": { |
+ "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" |
+ }, |
+ "accountId": { |
+ "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" |
}, |
"pageSize": { |
"description": "Requested page size. Server may return fewer associations than requested.\nIf unspecified, server will pick an appropriate default.", |
@@ -829,99 +829,523 @@ |
} |
} |
}, |
- "revision": "20170323", |
+ "revision": "20170413", |
"rootUrl": "https://adexchangebuyer.googleapis.com/", |
"schemas": { |
- "ClientUser": { |
- "description": "A client user is created under a client buyer and has restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the associated client buyer.\n\nThe only way a new client user can be created is via accepting an\nemail invitation\n(see the\naccounts.clients.invitations.create\nmethod).\n\nAll fields are required unless otherwise specified.", |
- "id": "ClientUser", |
+ "Empty": { |
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
+ "id": "Empty", |
+ "properties": {}, |
+ "type": "object" |
+ }, |
+ "WatchCreativeRequest": { |
+ "description": "A request for watching changes to creative Status.", |
+ "id": "WatchCreativeRequest", |
"properties": { |
- "userId": { |
- "description": "The unique numerical ID of the client user\nthat has accepted an invitation.\nThe value of this field is ignored in an update operation.", |
- "format": "int64", |
- "type": "string" |
- }, |
- "email": { |
- "description": "User's email address. The value of this field\nis ignored in an update operation.", |
- "type": "string" |
- }, |
- "clientAccountId": { |
- "description": "Numerical account ID of the client buyer\nwith which the user is associated; the\nbuyer must be a client of the current sponsor buyer.\nThe value of this field is ignored in an update operation.", |
- "format": "int64", |
+ "topic": { |
+ "description": "The Pub/Sub topic to publish notifications to.\nThis topic must already exist and must give permission to\nad-exchange-buyside-reports@google.com to write to the topic.\nThis should be the full resource name in\n\"projects/{project_id}/topics/{topic_id}\" format.", |
"type": "string" |
- }, |
- "status": { |
- "description": "The status of the client user.", |
- "enum": [ |
- "USER_STATUS_UNSPECIFIED", |
- "PENDING", |
- "ACTIVE", |
- "DISABLED" |
- ], |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "AppContext": { |
+ "description": "@OutputOnly The app type the restriction applies to for mobile device.", |
+ "id": "AppContext", |
+ "properties": { |
+ "appTypes": { |
+ "description": "The app types this restriction applies to.", |
"enumDescriptions": [ |
- "A placeholder for an undefined user status.", |
- "A user who was already created but hasn't accepted the invitation yet.", |
- "A user that is currently active.", |
- "A user that is currently disabled." |
+ "Native app context.", |
+ "Mobile web app context." |
], |
- "type": "string" |
+ "items": { |
+ "enum": [ |
+ "NATIVE", |
+ "WEB" |
+ ], |
+ "type": "string" |
+ }, |
+ "type": "array" |
} |
}, |
"type": "object" |
}, |
- "CreativeDealAssociation": { |
- "description": "The association between a creative and a deal.", |
- "id": "CreativeDealAssociation", |
+ "NativeContent": { |
+ "description": "Native content for a creative.", |
+ "id": "NativeContent", |
"properties": { |
- "creativeId": { |
- "description": "The ID of the creative associated with the deal.", |
+ "videoUrl": { |
+ "description": "The URL to fetch a native video ad.", |
"type": "string" |
}, |
- "dealsId": { |
- "description": "The externalDealId for the deal associated with the creative.", |
+ "logo": { |
+ "$ref": "Image", |
+ "description": "A smaller image, for the advertiser's logo." |
+ }, |
+ "clickLinkUrl": { |
+ "description": "The URL that the browser/SDK will load when the user clicks the ad.", |
"type": "string" |
}, |
- "accountId": { |
- "description": "The account the creative belongs to.", |
+ "priceDisplayText": { |
+ "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.", |
+ "type": "string" |
+ }, |
+ "storeUrl": { |
+ "description": "The URL to the app store to purchase/download the promoted app.", |
+ "type": "string" |
+ }, |
+ "headline": { |
+ "description": "A short title for the ad.", |
+ "type": "string" |
+ }, |
+ "appIcon": { |
+ "$ref": "Image", |
+ "description": "The app icon, for app download ads." |
+ }, |
+ "callToAction": { |
+ "description": "A label for the button that the user is supposed to click.", |
+ "type": "string" |
+ }, |
+ "body": { |
+ "description": "A long description of the ad.", |
"type": "string" |
+ }, |
+ "starRating": { |
+ "description": "The app rating in the app store. Must be in the range [0-5].", |
+ "format": "double", |
+ "type": "number" |
} |
}, |
"type": "object" |
}, |
- "Creative": { |
- "description": "A creative and its classification data.", |
- "id": "Creative", |
+ "ListClientsResponse": { |
+ "id": "ListClientsResponse", |
"properties": { |
- "detectedSensitiveCategories": { |
- "description": "@OutputOnly Detected sensitive categories, if any.\nSee the ad-sensitive-categories.txt file in the technical documentation for\na list of IDs. You should use these IDs along with the\nexcluded-sensitive-category field in the bid request to filter your bids.", |
+ "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": { |
- "format": "int32", |
- "type": "integer" |
+ "$ref": "Client" |
}, |
"type": "array" |
- }, |
- "adChoicesDestinationUrl": { |
- "description": "The link to AdChoices destination page.", |
- "type": "string" |
- }, |
- "restrictedCategories": { |
- "description": "All restricted categories for the ads that may be shown from this creative.", |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "SecurityContext": { |
+ "description": "@OutputOnly A security context.", |
+ "id": "SecurityContext", |
+ "properties": { |
+ "securities": { |
+ "description": "The security types in this context.", |
"enumDescriptions": [ |
- "The ad has no restricted categories", |
- "The alcohol restricted category." |
+ "Matches impressions that require insecure compatibility.", |
+ "Matches impressions that require SSL compatibility." |
], |
"items": { |
"enum": [ |
- "NO_RESTRICTED_CATEGORIES", |
- "ALCOHOL" |
+ "INSECURE", |
+ "SSL" |
], |
"type": "string" |
}, |
"type": "array" |
- }, |
- "corrections": { |
- "description": "@OutputOnly Shows any corrections that were applied to this creative.", |
- "items": { |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "HtmlContent": { |
+ "description": "HTML content for a creative.", |
+ "id": "HtmlContent", |
+ "properties": { |
+ "width": { |
+ "description": "The width of the HTML snippet in pixels.", |
+ "format": "int32", |
+ "type": "integer" |
+ }, |
+ "snippet": { |
+ "description": "The HTML snippet that displays the ad when inserted in the web page.", |
+ "type": "string" |
+ }, |
+ "height": { |
+ "description": "The height of the HTML snippet in pixels.", |
+ "format": "int32", |
+ "type": "integer" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "ListCreativesResponse": { |
+ "description": "A response for listing creatives.", |
+ "id": "ListCreativesResponse", |
+ "properties": { |
+ "nextPageToken": { |
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativesRequest.page_token\nfield in the subsequent call to `ListCreatives` method to retrieve the next\npage of results.", |
+ "type": "string" |
+ }, |
+ "creatives": { |
+ "description": "The list of creatives.", |
+ "items": { |
+ "$ref": "Creative" |
+ }, |
+ "type": "array" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "ServingContext": { |
+ "description": "The serving context for this restriction.", |
+ "id": "ServingContext", |
+ "properties": { |
+ "auctionType": { |
+ "$ref": "AuctionContext", |
+ "description": "Matches impressions for a particular auction type." |
+ }, |
+ "all": { |
+ "description": "Matches all contexts.", |
+ "enum": [ |
+ "SIMPLE_CONTEXT" |
+ ], |
+ "enumDescriptions": [ |
+ "A simple context." |
+ ], |
+ "type": "string" |
+ }, |
+ "appType": { |
+ "$ref": "AppContext", |
+ "description": "Matches impressions for a particular app type." |
+ }, |
+ "securityType": { |
+ "$ref": "SecurityContext", |
+ "description": "Matches impressions for a particular security type." |
+ }, |
+ "platform": { |
+ "$ref": "PlatformContext", |
+ "description": "Matches impressions coming from a particular platform." |
+ }, |
+ "location": { |
+ "$ref": "LocationContext", |
+ "description": "Matches impressions coming from users *or* publishers in a specific\nlocation." |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "Image": { |
+ "description": "An image resource. You may provide a larger image than was requested,\nso long as the aspect ratio is preserved.", |
+ "id": "Image", |
+ "properties": { |
+ "width": { |
+ "description": "Image width in pixels.", |
+ "format": "int32", |
+ "type": "integer" |
+ }, |
+ "url": { |
+ "description": "The URL of the image.", |
+ "type": "string" |
+ }, |
+ "height": { |
+ "description": "Image height in pixels.", |
+ "format": "int32", |
+ "type": "integer" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "Reason": { |
+ "description": "A specific filtering status and how many times it occurred.", |
+ "id": "Reason", |
+ "properties": { |
+ "status": { |
+ "description": "The filtering status code. Please refer to the\n[creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)\nfile for different statuses.", |
+ "format": "int32", |
+ "type": "integer" |
+ }, |
+ "count": { |
+ "description": "The number of times the creative was filtered for the status. The\ncount is aggregated across all publishers on the exchange.", |
+ "format": "int64", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "VideoContent": { |
+ "description": "Video content for a creative.", |
+ "id": "VideoContent", |
+ "properties": { |
+ "videoUrl": { |
+ "description": "The URL to fetch a video ad.", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "ClientUserInvitation": { |
+ "description": "An invitation for a new client user to get access to the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.", |
+ "id": "ClientUserInvitation", |
+ "properties": { |
+ "invitationId": { |
+ "description": "The unique numerical ID of the invitation that is sent to the user.\nThe value of this field is ignored in create operations.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "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" |
+ }, |
+ "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" |
+ }, |
+ "ListClientUsersResponse": { |
+ "id": "ListClientUsersResponse", |
+ "properties": { |
+ "nextPageToken": { |
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.", |
+ "type": "string" |
+ }, |
+ "users": { |
+ "description": "The returned list of client users.", |
+ "items": { |
+ "$ref": "ClientUser" |
+ }, |
+ "type": "array" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "ListClientUserInvitationsResponse": { |
+ "id": "ListClientUserInvitationsResponse", |
+ "properties": { |
+ "invitations": { |
+ "description": "The returned list of client users.", |
+ "items": { |
+ "$ref": "ClientUserInvitation" |
+ }, |
+ "type": "array" |
+ }, |
+ "nextPageToken": { |
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUserInvitationsRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "LocationContext": { |
+ "description": "@OutputOnly The Geo criteria the restriction applies to.", |
+ "id": "LocationContext", |
+ "properties": { |
+ "geoCriteriaIds": { |
+ "description": "IDs representing the geo location for this context.\nPlease refer to the\n[geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)\nfile for different geo criteria IDs.", |
+ "items": { |
+ "format": "int32", |
+ "type": "integer" |
+ }, |
+ "type": "array" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "PlatformContext": { |
+ "description": "@OutputOnly The type of platform the restriction applies to.", |
+ "id": "PlatformContext", |
+ "properties": { |
+ "platforms": { |
+ "description": "The platforms this restriction applies to.", |
+ "enumDescriptions": [ |
+ "Desktop platform.", |
+ "Android platform.", |
+ "iOS platform." |
+ ], |
+ "items": { |
+ "enum": [ |
+ "DESKTOP", |
+ "ANDROID", |
+ "IOS" |
+ ], |
+ "type": "string" |
+ }, |
+ "type": "array" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "ClientUser": { |
+ "description": "A client user is created under a client buyer and has restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the associated client buyer.\n\nThe only way a new client user can be created is via accepting an\nemail invitation\n(see the\naccounts.clients.invitations.create\nmethod).\n\nAll fields are required unless otherwise specified.", |
+ "id": "ClientUser", |
+ "properties": { |
+ "clientAccountId": { |
+ "description": "Numerical account ID of the client buyer\nwith which the user is associated; the\nbuyer must be a client of the current sponsor buyer.\nThe value of this field is ignored in an update operation.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "status": { |
+ "description": "The status of the client user.", |
+ "enum": [ |
+ "USER_STATUS_UNSPECIFIED", |
+ "PENDING", |
+ "ACTIVE", |
+ "DISABLED" |
+ ], |
+ "enumDescriptions": [ |
+ "A placeholder for an undefined user status.", |
+ "A user who was already created but hasn't accepted the invitation yet.", |
+ "A user that is currently active.", |
+ "A user that is currently disabled." |
+ ], |
+ "type": "string" |
+ }, |
+ "userId": { |
+ "description": "The unique numerical ID of the client user\nthat has accepted an invitation.\nThe value of this field is ignored in an update operation.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "email": { |
+ "description": "User's email address. The value of this field\nis ignored in an update operation.", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "CreativeDealAssociation": { |
+ "description": "The association between a creative and a deal.", |
+ "id": "CreativeDealAssociation", |
+ "properties": { |
+ "accountId": { |
+ "description": "The account the creative belongs to.", |
+ "type": "string" |
+ }, |
+ "creativeId": { |
+ "description": "The ID of the creative associated with the deal.", |
+ "type": "string" |
+ }, |
+ "dealsId": { |
+ "description": "The externalDealId for the deal associated with the creative.", |
+ "type": "string" |
+ } |
+ }, |
+ "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": { |
+ "native": { |
+ "$ref": "NativeContent", |
+ "description": "A native creative." |
+ }, |
+ "video": { |
+ "$ref": "VideoContent", |
+ "description": "A video creative." |
+ }, |
+ "servingRestrictions": { |
+ "description": "@OutputOnly The granular status of this ad in specific contexts.\nA context here relates to where something ultimately serves (for example,\na physical location, a platform, an HTTPS vs HTTP request, or the type\nof auction).", |
+ "items": { |
+ "$ref": "ServingRestriction" |
+ }, |
+ "type": "array" |
+ }, |
+ "agencyId": { |
+ "description": "The agency ID for this creative.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "clickThroughUrls": { |
+ "description": "The set of destination URLs for the creative.", |
+ "items": { |
+ "type": "string" |
+ }, |
+ "type": "array" |
+ }, |
+ "adChoicesDestinationUrl": { |
+ "description": "The link to AdChoices destination page.", |
+ "type": "string" |
+ }, |
+ "detectedSensitiveCategories": { |
+ "description": "@OutputOnly Detected sensitive categories, if any.\nSee the ad-sensitive-categories.txt file in the technical documentation for\na list of IDs. You should use these IDs along with the\nexcluded-sensitive-category field in the bid request to filter your bids.", |
+ "items": { |
+ "format": "int32", |
+ "type": "integer" |
+ }, |
+ "type": "array" |
+ }, |
+ "restrictedCategories": { |
+ "description": "All restricted categories for the ads that may be shown from this creative.", |
+ "enumDescriptions": [ |
+ "The ad has no restricted categories", |
+ "The alcohol restricted category." |
+ ], |
+ "items": { |
+ "enum": [ |
+ "NO_RESTRICTED_CATEGORIES", |
+ "ALCOHOL" |
+ ], |
+ "type": "string" |
+ }, |
+ "type": "array" |
+ }, |
+ "corrections": { |
+ "description": "@OutputOnly Shows any corrections that were applied to this creative.", |
+ "items": { |
"$ref": "Correction" |
}, |
"type": "array" |
@@ -998,17 +1422,17 @@ |
"description": "The name of the company being advertised in the creative.", |
"type": "string" |
}, |
- "detectedAdvertiserIds": { |
- "description": "@OutputOnly Detected advertiser IDs, if any.", |
+ "detectedDomains": { |
+ "description": "@OutputOnly\nThe detected domains for this creative.", |
"items": { |
- "format": "int64", |
"type": "string" |
}, |
"type": "array" |
}, |
- "detectedDomains": { |
- "description": "@OutputOnly\nThe detected domains for this creative.", |
+ "detectedAdvertiserIds": { |
+ "description": "@OutputOnly Detected advertiser IDs, if any.", |
"items": { |
+ "format": "int64", |
"type": "string" |
}, |
"type": "array" |
@@ -1095,51 +1519,6 @@ |
"accountId": { |
"description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.", |
"type": "string" |
- }, |
- "native": { |
- "$ref": "NativeContent", |
- "description": "A native creative." |
- }, |
- "video": { |
- "$ref": "VideoContent", |
- "description": "A video creative." |
- }, |
- "servingRestrictions": { |
- "description": "@OutputOnly The granular status of this ad in specific contexts.\nA context here relates to where something ultimately serves (for example,\na physical location, a platform, an HTTPS vs HTTP request, or the type\nof auction).", |
- "items": { |
- "$ref": "ServingRestriction" |
- }, |
- "type": "array" |
- }, |
- "agencyId": { |
- "description": "The agency ID for this creative.", |
- "format": "int64", |
- "type": "string" |
- }, |
- "clickThroughUrls": { |
- "description": "The set of destination URLs for the creative.", |
- "items": { |
- "type": "string" |
- }, |
- "type": "array" |
- } |
- }, |
- "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": { |
- "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." |
- }, |
- "reasons": { |
- "description": "The set of filtering reasons for this date.", |
- "items": { |
- "$ref": "Reason" |
- }, |
- "type": "array" |
} |
}, |
"type": "object" |
@@ -1159,6 +1538,24 @@ |
"description": "A client resource represents a client buyer—an agency,\na brand, or an advertiser customer of the sponsor buyer.\nUsers associated with the client buyer have restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the client buyer.\nAll fields are required unless otherwise specified.", |
"id": "Client", |
"properties": { |
+ "entityName": { |
+ "description": "The name of the entity. This field is automatically fetched based on\nthe type and ID.\nThe value of this field is ignored in create and update operations.", |
+ "type": "string" |
+ }, |
+ "status": { |
+ "description": "The status of the client buyer.", |
+ "enum": [ |
+ "CLIENT_STATUS_UNSPECIFIED", |
+ "DISABLED", |
+ "ACTIVE" |
+ ], |
+ "enumDescriptions": [ |
+ "A placeholder for an undefined client status.", |
+ "A client that is currently disabled.", |
+ "A client that is currently active." |
+ ], |
+ "type": "string" |
+ }, |
"entityType": { |
"description": "The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.", |
"enum": [ |
@@ -1208,24 +1605,6 @@ |
"description": "The globally-unique numerical ID of the client.\nThe value of this field is ignored in create and update operations.", |
"format": "int64", |
"type": "string" |
- }, |
- "entityName": { |
- "description": "The name of the entity. This field is automatically fetched based on\nthe type and ID.\nThe value of this field is ignored in create and update operations.", |
- "type": "string" |
- }, |
- "status": { |
- "description": "The status of the client buyer.", |
- "enum": [ |
- "CLIENT_STATUS_UNSPECIFIED", |
- "DISABLED", |
- "ACTIVE" |
- ], |
- "enumDescriptions": [ |
- "A placeholder for an undefined client status.", |
- "A client that is currently disabled.", |
- "A client that is currently active." |
- ], |
- "type": "string" |
} |
}, |
"type": "object" |
@@ -1234,6 +1613,13 @@ |
"description": "@OutputOnly Shows any corrections that were applied to this creative.", |
"id": "Correction", |
"properties": { |
+ "details": { |
+ "description": "Additional details about what was corrected.", |
+ "items": { |
+ "type": "string" |
+ }, |
+ "type": "array" |
+ }, |
"type": { |
"description": "The type of correction that was applied to the creative.", |
"enum": [ |
@@ -1272,13 +1658,6 @@ |
"$ref": "ServingContext" |
}, |
"type": "array" |
- }, |
- "details": { |
- "description": "Additional details about what was corrected.", |
- "items": { |
- "type": "string" |
- }, |
- "type": "array" |
} |
}, |
"type": "object" |
@@ -1287,16 +1666,16 @@ |
"description": "A response for listing creative and deal associations", |
"id": "ListDealAssociationsResponse", |
"properties": { |
- "nextPageToken": { |
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of results.", |
- "type": "string" |
- }, |
"associations": { |
"description": "The list of associations.", |
"items": { |
"$ref": "CreativeDealAssociation" |
}, |
"type": "array" |
+ }, |
+ "nextPageToken": { |
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of results.", |
+ "type": "string" |
} |
}, |
"type": "object" |
@@ -1312,6 +1691,12 @@ |
}, |
"type": "object" |
}, |
+ "StopWatchingCreativeRequest": { |
+ "description": "A request for stopping notifications for changes to creative Status.", |
+ "id": "StopWatchingCreativeRequest", |
+ "properties": {}, |
+ "type": "object" |
+ }, |
"Disapproval": { |
"description": "@OutputOnly The reason and details for a disapproval.", |
"id": "Disapproval", |
@@ -1511,458 +1896,73 @@ |
"Restricted in China.", |
"Unacceptable content: Korean healthcare.", |
"Non-family safe or adult content.", |
- "Clinical trial recruitment.", |
- "Maximum number of HTTP calls exceeded.", |
- "Maximum number of cookies exceeded.", |
- "Financial service ad does not adhere to specifications.", |
- "Flash content was found in an unsupported context." |
- ], |
- "type": "string" |
- } |
- }, |
- "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": { |
- "status": { |
- "description": "The status of the creative in this context (for example, it has been\nexplicitly disapproved or is pending review).", |
- "enum": [ |
- "STATUS_UNSPECIFIED", |
- "DISAPPROVAL", |
- "PENDING_REVIEW" |
- ], |
- "enumDescriptions": [ |
- "The status is not known.", |
- "The ad was disapproved in this context.", |
- "The ad is pending review in this context." |
- ], |
- "type": "string" |
- }, |
- "disapprovalReasons": { |
- "description": "Any disapprovals bound to this restriction.\nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\ncreatives.list\nmethod.", |
- "items": { |
- "$ref": "Disapproval" |
- }, |
- "type": "array" |
- }, |
- "contexts": { |
- "description": "The contexts for the restriction.", |
- "items": { |
- "$ref": "ServingContext" |
- }, |
- "type": "array" |
- } |
- }, |
- "type": "object" |
- }, |
- "Date": { |
- "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.", |
- "id": "Date", |
- "properties": { |
- "year": { |
- "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.", |
- "format": "int32", |
- "type": "integer" |
- }, |
- "day": { |
- "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.", |
- "format": "int32", |
- "type": "integer" |
- }, |
- "month": { |
- "description": "Month of year. Must be from 1 to 12.", |
- "format": "int32", |
- "type": "integer" |
- } |
- }, |
- "type": "object" |
- }, |
- "Empty": { |
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
- "id": "Empty", |
- "properties": {}, |
- "type": "object" |
- }, |
- "WatchCreativeRequest": { |
- "description": "A request for watching changes to creative Status.", |
- "id": "WatchCreativeRequest", |
- "properties": { |
- "topic": { |
- "description": "The Pub/Sub topic to publish notifications to.\nThis topic must already exist and must give permission to\nad-exchange-buyside-reports@google.com to write to the topic.\nThis should be the full resource name in\n\"projects/{project_id}/topics/{topic_id}\" format.", |
- "type": "string" |
- } |
- }, |
- "type": "object" |
- }, |
- "AppContext": { |
- "description": "@OutputOnly The app type the restriction applies to for mobile device.", |
- "id": "AppContext", |
- "properties": { |
- "appTypes": { |
- "description": "The app types this restriction applies to.", |
- "enumDescriptions": [ |
- "Native app context.", |
- "Mobile web app context." |
- ], |
- "items": { |
- "enum": [ |
- "NATIVE", |
- "WEB" |
- ], |
- "type": "string" |
- }, |
- "type": "array" |
- } |
- }, |
- "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": { |
- "videoUrl": { |
- "description": "The URL to fetch a native video ad.", |
- "type": "string" |
- }, |
- "logo": { |
- "$ref": "Image", |
- "description": "A smaller image, for the advertiser's logo." |
- }, |
- "clickLinkUrl": { |
- "description": "The URL that the browser/SDK will load when the user clicks the ad.", |
- "type": "string" |
- }, |
- "priceDisplayText": { |
- "description": "The price of the promoted app including currency info.", |
- "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.", |
- "type": "string" |
- }, |
- "storeUrl": { |
- "description": "The URL to the app store to purchase/download the promoted app.", |
- "type": "string" |
- }, |
- "headline": { |
- "description": "A short title for the ad.", |
- "type": "string" |
- }, |
- "appIcon": { |
- "$ref": "Image", |
- "description": "The app icon, for app download ads." |
- }, |
- "callToAction": { |
- "description": "A label for the button that the user is supposed to click.", |
- "type": "string" |
- }, |
- "body": { |
- "description": "A long description of the ad.", |
- "type": "string" |
- }, |
- "starRating": { |
- "description": "The app rating in the app store. Must be in the range [0-5].", |
- "format": "double", |
- "type": "number" |
- } |
- }, |
- "type": "object" |
- }, |
- "SecurityContext": { |
- "description": "@OutputOnly A security context.", |
- "id": "SecurityContext", |
- "properties": { |
- "securities": { |
- "description": "The security types in this context.", |
- "enumDescriptions": [ |
- "Matches impressions that require insecure compatibility.", |
- "Matches impressions that require SSL compatibility." |
+ "Clinical trial recruitment.", |
+ "Maximum number of HTTP calls exceeded.", |
+ "Maximum number of cookies exceeded.", |
+ "Financial service ad does not adhere to specifications.", |
+ "Flash content was found in an unsupported context." |
], |
- "items": { |
- "enum": [ |
- "INSECURE", |
- "SSL" |
- ], |
- "type": "string" |
- }, |
- "type": "array" |
+ "type": "string" |
} |
}, |
"type": "object" |
}, |
- "ListCreativesResponse": { |
- "description": "A response for listing creatives.", |
- "id": "ListCreativesResponse", |
+ "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": { |
- "creatives": { |
- "description": "The list of creatives.", |
+ "disapprovalReasons": { |
+ "description": "Any disapprovals bound to this restriction.\nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\ncreatives.list\nmethod.", |
"items": { |
- "$ref": "Creative" |
+ "$ref": "Disapproval" |
}, |
"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" |
- }, |
- "HtmlContent": { |
- "description": "HTML content for a creative.", |
- "id": "HtmlContent", |
- "properties": { |
- "height": { |
- "description": "The height of the HTML snippet in pixels.", |
- "format": "int32", |
- "type": "integer" |
- }, |
- "width": { |
- "description": "The width of the HTML snippet in pixels.", |
- "format": "int32", |
- "type": "integer" |
- }, |
- "snippet": { |
- "description": "The HTML snippet that displays the ad when inserted in the web page.", |
- "type": "string" |
- } |
- }, |
- "type": "object" |
- }, |
- "ServingContext": { |
- "description": "The serving context for this restriction.", |
- "id": "ServingContext", |
- "properties": { |
- "auctionType": { |
- "$ref": "AuctionContext", |
- "description": "Matches impressions for a particular auction type." |
+ "contexts": { |
+ "description": "The contexts for the restriction.", |
+ "items": { |
+ "$ref": "ServingContext" |
+ }, |
+ "type": "array" |
}, |
- "all": { |
- "description": "Matches all contexts.", |
+ "status": { |
+ "description": "The status of the creative in this context (for example, it has been\nexplicitly disapproved or is pending review).", |
"enum": [ |
- "SIMPLE_CONTEXT" |
+ "STATUS_UNSPECIFIED", |
+ "DISAPPROVAL", |
+ "PENDING_REVIEW" |
], |
"enumDescriptions": [ |
- "A simple context." |
+ "The status is not known.", |
+ "The ad was disapproved in this context.", |
+ "The ad is pending review in this context." |
], |
"type": "string" |
- }, |
- "appType": { |
- "$ref": "AppContext", |
- "description": "Matches impressions for a particular app type." |
- }, |
- "securityType": { |
- "$ref": "SecurityContext", |
- "description": "Matches impressions for a particular security type." |
- }, |
- "platform": { |
- "$ref": "PlatformContext", |
- "description": "Matches impressions coming from a particular platform." |
- }, |
- "location": { |
- "$ref": "LocationContext", |
- "description": "Matches impressions coming from users *or* publishers in a specific\nlocation." |
} |
}, |
"type": "object" |
}, |
- "Image": { |
- "description": "An image resource. You may provide a larger image than was requested,\nso long as the aspect ratio is preserved.", |
- "id": "Image", |
+ "Date": { |
+ "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.", |
+ "id": "Date", |
"properties": { |
- "width": { |
- "description": "Image width in pixels.", |
+ "month": { |
+ "description": "Month of year. Must be from 1 to 12.", |
"format": "int32", |
"type": "integer" |
}, |
- "url": { |
- "description": "The URL of the image.", |
- "type": "string" |
- }, |
- "height": { |
- "description": "Image height in pixels.", |
+ "year": { |
+ "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.", |
"format": "int32", |
"type": "integer" |
- } |
- }, |
- "type": "object" |
- }, |
- "Reason": { |
- "description": "A specific filtering status and how many times it occurred.", |
- "id": "Reason", |
- "properties": { |
- "count": { |
- "description": "The number of times the creative was filtered for the status. The\ncount is aggregated across all publishers on the exchange.", |
- "format": "int64", |
- "type": "string" |
}, |
- "status": { |
- "description": "The filtering status code. Please refer to the\n[creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)\nfile for different statuses.", |
+ "day": { |
+ "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.", |
"format": "int32", |
"type": "integer" |
} |
}, |
"type": "object" |
- }, |
- "VideoContent": { |
- "description": "Video content for a creative.", |
- "id": "VideoContent", |
- "properties": { |
- "videoUrl": { |
- "description": "The URL to fetch a video ad.", |
- "type": "string" |
- } |
- }, |
- "type": "object" |
- }, |
- "ClientUserInvitation": { |
- "description": "An invitation for a new client user to get access to the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.", |
- "id": "ClientUserInvitation", |
- "properties": { |
- "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" |
- }, |
- "invitationId": { |
- "description": "The unique numerical ID of the invitation that is sent to the user.\nThe value of this field is ignored in create operations.", |
- "format": "int64", |
- "type": "string" |
- } |
- }, |
- "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" |
- }, |
- "ListClientUserInvitationsResponse": { |
- "id": "ListClientUserInvitationsResponse", |
- "properties": { |
- "nextPageToken": { |
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUserInvitationsRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.", |
- "type": "string" |
- }, |
- "invitations": { |
- "description": "The returned list of client users.", |
- "items": { |
- "$ref": "ClientUserInvitation" |
- }, |
- "type": "array" |
- } |
- }, |
- "type": "object" |
- }, |
- "ListClientUsersResponse": { |
- "id": "ListClientUsersResponse", |
- "properties": { |
- "nextPageToken": { |
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.", |
- "type": "string" |
- }, |
- "users": { |
- "description": "The returned list of client users.", |
- "items": { |
- "$ref": "ClientUser" |
- }, |
- "type": "array" |
- } |
- }, |
- "type": "object" |
- }, |
- "LocationContext": { |
- "description": "@OutputOnly The Geo criteria the restriction applies to.", |
- "id": "LocationContext", |
- "properties": { |
- "geoCriteriaIds": { |
- "description": "IDs representing the geo location for this context.\nPlease refer to the\n[geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)\nfile for different geo criteria IDs.", |
- "items": { |
- "format": "int32", |
- "type": "integer" |
- }, |
- "type": "array" |
- } |
- }, |
- "type": "object" |
- }, |
- "PlatformContext": { |
- "description": "@OutputOnly The type of platform the restriction applies to.", |
- "id": "PlatformContext", |
- "properties": { |
- "platforms": { |
- "description": "The platforms this restriction applies to.", |
- "enumDescriptions": [ |
- "Desktop platform.", |
- "Android platform.", |
- "iOS platform." |
- ], |
- "items": { |
- "enum": [ |
- "DESKTOP", |
- "ANDROID", |
- "IOS" |
- ], |
- "type": "string" |
- }, |
- "type": "array" |
- } |
- }, |
- "type": "object" |
} |
}, |
"servicePath": "", |