Google Git
Sign in
chromium / external / github.com / google / google-api-python-client / refs/heads/release-v1.13.0 / . / googleapiclient / discovery_cache / documents / realtimebidding.v1.json
blob: 41fa4c93cc93dfecad960e3d605f487a318a0d58 [file] [log] [blame] [edit]
{
"title": "Real-time Bidding API",
"baseUrl": "https://realtimebidding.googleapis.com/",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/realtime-bidding": {
"description": "See, create, edit, and delete your Authorized Buyers and Open Bidding account entities"
}
}
}
},
"ownerDomain": "google.com",
"resources": {
"buyers": {
"resources": {
"creatives": {
"methods": {
"patch": {
"parameters": {
"updateMask": {
"location": "query",
"format": "google-fieldmask",
"description": "Field mask to use for partial in-place updates.",
"type": "string"
},
"name": {
"description": "Output only. Name of the creative. Follows the pattern `buyers/{buyer}/creatives/{creative}`, where `{buyer}` represents the account ID of the buyer who owns the creative, and `{creative}` is the buyer-specific creative ID that references this creative in the bid response.",
"required": true,
"location": "path",
"pattern": "^buyers/[^/]+/creatives/[^/]+$",
"type": "string"
}
},
"id": "realtimebidding.buyers.creatives.patch",
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
],
"path": "v1/{+name}",
"description": "Updates a creative.",
"flatPath": "v1/buyers/{buyersId}/creatives/{creativesId}",
"request": {
"$ref": "Creative"
},
"parameterOrder": [
"name"
],
"httpMethod": "PATCH",
"response": {
"$ref": "Creative"
}
},
"list": {
"parameterOrder": [
"parent"
],
"flatPath": "v1/buyers/{buyersId}/creatives",
"parameters": {
"filter": {
"description": "Query string to filter creatives. If no filter is specified, all active creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:IS_COOKIE_TARGETED'",
"type": "string",
"location": "query"
},
"pageToken": {
"description": "A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.nextPageToken returned from the previous call to the 'ListCreatives' method.",
"type": "string",
"location": "query"
},
"pageSize": {
"type": "integer",
"description": "Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.",
"location": "query",
"format": "int32"
},
"view": {
"location": "query",
"enum": [
"CREATIVE_VIEW_UNSPECIFIED",
"SERVING_DECISION_ONLY",
"FULL"
],
"enumDescriptions": [
"Not specified, equivalent to SERVING_DECISION_ONLY.",
"Only creativeServingDecision is included in the response.",
"The entire creative resource (including the declared fields and the creative content) is included in the response."
],
"type": "string",
"description": "Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as \"FULL\"."
},
"parent": {
"description": "Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either `buyers/{buyerAccountId}` or `bidders/{bidderAccountId}`. For `buyers/{buyerAccountId}`, the `buyerAccountId` can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (`456`) under bidder account (`123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (`123`), you would use `buyers/123`. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use `bidders/{bidderAccountId}`, e.g., for all creatives pertaining to bidder (`123`), use `bidders/123`.",
"type": "string",
"required": true,
"location": "path",
"pattern": "^buyers/[^/]+$"
}
},
"httpMethod": "GET",
"description": "Lists creatives.",
"id": "realtimebidding.buyers.creatives.list",
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
],
"response": {
"$ref": "ListCreativesResponse"
},
"path": "v1/{+parent}/creatives"
},
"create": {
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
],
"path": "v1/{+parent}/creatives",
"httpMethod": "POST",
"response": {
"$ref": "Creative"
},
"parameters": {
"parent": {
"type": "string",
"location": "path",
"description": "Required. The name of the parent buyer that the new creative belongs to that must follow the pattern `buyers/{buyerAccountId}`, where `{buyerAccountId}` represents the account ID of the buyer who owns a creative. For a bidder accessing creatives on behalf of a child seat buyer, `{buyerAccountId}` should represent the account ID of the child seat buyer.",
"pattern": "^buyers/[^/]+$",
"required": true
}
},
"flatPath": "v1/buyers/{buyersId}/creatives",
"parameterOrder": [
"parent"
],
"id": "realtimebidding.buyers.creatives.create",
"description": "Creates a creative.",
"request": {
"$ref": "Creative"
}
},
"get": {
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
],
"id": "realtimebidding.buyers.creatives.get",
"parameterOrder": [
"name"
],
"path": "v1/{+name}",
"httpMethod": "GET",
"parameters": {
"view": {
"type": "string",
"enum": [
"CREATIVE_VIEW_UNSPECIFIED",
"SERVING_DECISION_ONLY",
"FULL"
],
"location": "query",
"description": "Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as \"FULL\".",
"enumDescriptions": [
"Not specified, equivalent to SERVING_DECISION_ONLY.",
"Only creativeServingDecision is included in the response.",
"The entire creative resource (including the declared fields and the creative content) is included in the response."
]
},
"name": {
"pattern": "^buyers/[^/]+/creatives/[^/]+$",
"location": "path",
"description": "Required. Name of the creative to retrieve. See creative.name.",
"required": true,
"type": "string"
}
},
"response": {
"$ref": "Creative"
},
"flatPath": "v1/buyers/{buyersId}/creatives/{creativesId}",
"description": "Gets a creative."
}
}
},
"userLists": {
"methods": {
"get": {
"parameters": {
"name": {
"type": "string",
"pattern": "^buyers/[^/]+/userLists/[^/]+$",
"description": "Required. The name of the user list to be retrieved. See UserList.name.",
"location": "path",
"required": true
}
},
"flatPath": "v1/buyers/{buyersId}/userLists/{userListsId}",
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"path": "v1/{+name}",
"response": {
"$ref": "UserList"
},
"id": "realtimebidding.buyers.userLists.get",
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
],
"description": "Gets a user list by its name."
},
"open": {
"request": {
"$ref": "OpenUserListRequest"
},
"parameterOrder": [
"name"
],
"path": "v1/{+name}:open",
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
],
"description": "Change the status of a user list to OPEN. This allows new users to be added to the user list.",
"flatPath": "v1/buyers/{buyersId}/userLists/{userListsId}:open",
"httpMethod": "POST",
"response": {
"$ref": "UserList"
},
"parameters": {
"name": {
"pattern": "^buyers/[^/]+/userLists/[^/]+$",
"location": "path",
"description": "Required. The name of the user list to open. See UserList.name",
"required": true,
"type": "string"
}
},
"id": "realtimebidding.buyers.userLists.open"
},
"list": {
"id": "realtimebidding.buyers.userLists.list",
"description": "Lists the user lists visible to the current user.",
"parameters": {
"parent": {
"location": "path",
"description": "Required. The name of the parent buyer for the user lists to be returned that must follow the pattern `buyers/{buyerAccountId}`, where `{buyerAccountId}` represents the account ID of the buyer who owns user lists. For a bidder accessing user lists on behalf of a child seat buyer , `{buyerAccountId}` should represent the account ID of the child seat buyer.",
"required": true,
"type": "string",
"pattern": "^buyers/[^/]+$"
},
"pageToken": {
"description": "Continuation page token (as received from a previous response).",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The number of results to return per page.",
"type": "integer",
"location": "query",
"format": "int32"
}
},
"parameterOrder": [
"parent"
],
"flatPath": "v1/buyers/{buyersId}/userLists",
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
],
"path": "v1/{+parent}/userLists",
"httpMethod": "GET",
"response": {
"$ref": "ListUserListsResponse"
}
},
"close": {
"request": {
"$ref": "CloseUserListRequest"
},
"id": "realtimebidding.buyers.userLists.close",
"parameterOrder": [
"name"
],
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
],
"path": "v1/{+name}:close",
"parameters": {
"name": {
"required": true,
"type": "string",
"location": "path",
"description": "Required. The name of the user list to close. See UserList.name",
"pattern": "^buyers/[^/]+/userLists/[^/]+$"
}
},
"description": "Change the status of a user list to CLOSED. This prevents new users from being added to the user list.",
"response": {
"$ref": "UserList"
},
"flatPath": "v1/buyers/{buyersId}/userLists/{userListsId}:close",
"httpMethod": "POST"
},
"update": {
"httpMethod": "PUT",
"flatPath": "v1/buyers/{buyersId}/userLists/{userListsId}",
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
],
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"type": "string",
"required": true,
"description": "Output only. Name of the user list that must follow the pattern `buyers/{buyer}/userLists/{user_list}`, where `{buyer}` represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, `{buyer}` represents the account ID of the child seat buyer. `{user_list}` is an int64 identifier assigned by Google to uniquely identify a user list.",
"pattern": "^buyers/[^/]+/userLists/[^/]+$",
"location": "path"
}
},
"request": {
"$ref": "UserList"
},
"path": "v1/{+name}",
"id": "realtimebidding.buyers.userLists.update",
"response": {
"$ref": "UserList"
},
"description": "Update the given user list. Only user lists with URLRestrictions can be updated."
},
"getRemarketingTag": {
"httpMethod": "GET",
"flatPath": "v1/buyers/{buyersId}/userLists/{userListsId}:getRemarketingTag",
"parameters": {
"name": {
"location": "path",
"type": "string",
"pattern": "^buyers/[^/]+/userLists/[^/]+$",
"required": true,
"description": "Required. To fetch remarketing tag for an account, name must follow the pattern `buyers/{accountId}` where `{accountId}` represents ID of a buyer that owns the remarketing tag. For a bidder accessing remarketing tag on behalf of a child seat buyer, `{accountId}` should represent the ID of the child seat buyer. To fetch remarketing tag for a specific user list, name must follow the pattern `buyers/{accountId}/userLists/{userListId}`. See UserList.name."
}
},
"path": "v1/{+name}:getRemarketingTag",
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
],
"parameterOrder": [
"name"
],
"id": "realtimebidding.buyers.userLists.getRemarketingTag",
"response": {
"$ref": "GetRemarketingTagResponse"
},
"description": "Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript code that can be placed on a web page. When a user visits a page containing a remarketing tag, Google adds the user to a user list."
},
"create": {
"parameters": {
"parent": {
"pattern": "^buyers/[^/]+$",
"location": "path",
"type": "string",
"description": "Required. The name of the parent buyer of the user list to be retrieved that must follow the pattern `buyers/{buyerAccountId}`, where `{buyerAccountId}` represents the account ID of the buyer who owns user lists. For a bidder accessing user lists on behalf of a child seat buyer , `{buyerAccountId}` should represent the account ID of the child seat buyer.",
"required": true
}
},
"flatPath": "v1/buyers/{buyersId}/userLists",
"request": {
"$ref": "UserList"
},
"httpMethod": "POST",
"path": "v1/{+parent}/userLists",
"response": {
"$ref": "UserList"
},
"id": "realtimebidding.buyers.userLists.create",
"parameterOrder": [
"parent"
],
"description": "Create a new user list.",
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
]
}
}
}
},
"methods": {
"getRemarketingTag": {
"response": {
"$ref": "GetRemarketingTagResponse"
},
"parameters": {
"name": {
"location": "path",
"required": true,
"pattern": "^buyers/[^/]+$",
"description": "Required. To fetch remarketing tag for an account, name must follow the pattern `buyers/{accountId}` where `{accountId}` represents ID of a buyer that owns the remarketing tag. For a bidder accessing remarketing tag on behalf of a child seat buyer, `{accountId}` should represent the ID of the child seat buyer. To fetch remarketing tag for a specific user list, name must follow the pattern `buyers/{accountId}/userLists/{userListId}`. See UserList.name.",
"type": "string"
}
},
"flatPath": "v1/buyers/{buyersId}:getRemarketingTag",
"httpMethod": "GET",
"description": "Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript code that can be placed on a web page. When a user visits a page containing a remarketing tag, Google adds the user to a user list.",
"parameterOrder": [
"name"
],
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
],
"id": "realtimebidding.buyers.getRemarketingTag",
"path": "v1/{+name}:getRemarketingTag"
}
}
},
"bidders": {
"resources": {
"pretargetingConfigs": {
"methods": {
"list": {
"path": "v1/{+parent}/pretargetingConfigs",
"parameters": {
"pageToken": {
"location": "query",
"description": "A token identifying a page of results the server should return. This value is received from a previous `ListPretargetingConfigs` call in ListPretargetingConfigsResponse.nextPageToken.",
"type": "string"
},
"parent": {
"pattern": "^bidders/[^/]+$",
"location": "path",
"type": "string",
"description": "Required. Name of the bidder whose pretargeting configurations will be listed. Format: bidders/{bidderAccountId}",
"required": true
},
"pageSize": {
"description": "The maximum number of pretargeting configurations to return. If unspecified, at most 10 pretargeting configurations will be returned. The maximum value is 100; values above 100 will be coerced to 100.",
"format": "int32",
"type": "integer",
"location": "query"
}
},
"flatPath": "v1/bidders/{biddersId}/pretargetingConfigs",
"description": "Lists all pretargeting configurations for a single bidder.",
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
],
"httpMethod": "GET",
"response": {
"$ref": "ListPretargetingConfigsResponse"
},
"parameterOrder": [
"parent"
],
"id": "realtimebidding.bidders.pretargetingConfigs.list"
},
"suspend": {
"path": "v1/{+name}:suspend",
"httpMethod": "POST",
"id": "realtimebidding.bidders.pretargetingConfigs.suspend",
"request": {
"$ref": "SuspendPretargetingConfigRequest"
},
"description": "Suspends a pretargeting configuration.",
"flatPath": "v1/bidders/{biddersId}/pretargetingConfigs/{pretargetingConfigsId}:suspend",
"response": {
"$ref": "PretargetingConfig"
},
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"required": true,
"location": "path",
"type": "string",
"pattern": "^bidders/[^/]+/pretargetingConfigs/[^/]+$",
"description": "Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}"
}
},
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
]
},
"activate": {
"flatPath": "v1/bidders/{biddersId}/pretargetingConfigs/{pretargetingConfigsId}:activate",
"parameters": {
"name": {
"location": "path",
"required": true,
"pattern": "^bidders/[^/]+/pretargetingConfigs/[^/]+$",
"type": "string",
"description": "Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}"
}
},
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
],
"parameterOrder": [
"name"
],
"path": "v1/{+name}:activate",
"request": {
"$ref": "ActivatePretargetingConfigRequest"
},
"response": {
"$ref": "PretargetingConfig"
},
"id": "realtimebidding.bidders.pretargetingConfigs.activate",
"httpMethod": "POST",
"description": "Activates a pretargeting configuration."
},
"delete": {
"description": "Deletes a pretargeting configuration.",
"httpMethod": "DELETE",
"parameterOrder": [
"name"
],
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
],
"id": "realtimebidding.bidders.pretargetingConfigs.delete",
"parameters": {
"name": {
"pattern": "^bidders/[^/]+/pretargetingConfigs/[^/]+$",
"description": "Required. The name of the pretargeting configuration to delete. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}",
"type": "string",
"location": "path",
"required": true
}
},
"response": {
"$ref": "Empty"
},
"flatPath": "v1/bidders/{biddersId}/pretargetingConfigs/{pretargetingConfigsId}",
"path": "v1/{+name}"
},
"patch": {
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
],
"httpMethod": "PATCH",
"parameterOrder": [
"name"
],
"flatPath": "v1/bidders/{biddersId}/pretargetingConfigs/{pretargetingConfigsId}",
"response": {
"$ref": "PretargetingConfig"
},
"id": "realtimebidding.bidders.pretargetingConfigs.patch",
"path": "v1/{+name}",
"request": {
"$ref": "PretargetingConfig"
},
"parameters": {
"name": {
"location": "path",
"required": true,
"description": "Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`",
"type": "string",
"pattern": "^bidders/[^/]+/pretargetingConfigs/[^/]+$"
},
"updateMask": {
"location": "query",
"format": "google-fieldmask",
"type": "string",
"description": "Field mask to use for partial in-place updates."
}
},
"description": "Updates a pretargeting configuration."
},
"create": {
"path": "v1/{+parent}/pretargetingConfigs",
"request": {
"$ref": "PretargetingConfig"
},
"response": {
"$ref": "PretargetingConfig"
},
"flatPath": "v1/bidders/{biddersId}/pretargetingConfigs",
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
],
"description": "Creates a pretargeting configuration. A pretargeting configuration's state (PretargetingConfig.state) is active upon creation, and it will start to affect traffic shortly after. A bidder may create a maximum of 10 pretargeting configurations. Attempts to exceed this maximum results in a 400 bad request error.",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Name of the bidder to create the pretargeting configuration for. Format: bidders/{bidderAccountId}",
"pattern": "^bidders/[^/]+$",
"type": "string",
"location": "path",
"required": true
}
},
"httpMethod": "POST",
"id": "realtimebidding.bidders.pretargetingConfigs.create"
},
"removeTargetedSites": {
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
],
"parameterOrder": [
"pretargetingConfig"
],
"id": "realtimebidding.bidders.pretargetingConfigs.removeTargetedSites",
"flatPath": "v1/bidders/{biddersId}/pretargetingConfigs/{pretargetingConfigsId}:removeTargetedSites",
"response": {
"$ref": "PretargetingConfig"
},
"parameters": {
"pretargetingConfig": {
"description": "Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}",
"pattern": "^bidders/[^/]+/pretargetingConfigs/[^/]+$",
"type": "string",
"required": true,
"location": "path"
}
},
"description": "Removes targeted sites from the pretargeting configuration.",
"request": {
"$ref": "RemoveTargetedSitesRequest"
},
"httpMethod": "POST",
"path": "v1/{+pretargetingConfig}:removeTargetedSites"
},
"get": {
"flatPath": "v1/bidders/{biddersId}/pretargetingConfigs/{pretargetingConfigsId}",
"id": "realtimebidding.bidders.pretargetingConfigs.get",
"response": {
"$ref": "PretargetingConfig"
},
"description": "Gets a pretargeting configuration.",
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
],
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"path": "v1/{+name}",
"parameters": {
"name": {
"description": "Required. Name of the pretargeting configuration to get. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}",
"type": "string",
"location": "path",
"pattern": "^bidders/[^/]+/pretargetingConfigs/[^/]+$",
"required": true
}
}
},
"removeTargetedApps": {
"request": {
"$ref": "RemoveTargetedAppsRequest"
},
"parameters": {
"pretargetingConfig": {
"type": "string",
"location": "path",
"required": true,
"description": "Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}",
"pattern": "^bidders/[^/]+/pretargetingConfigs/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
],
"response": {
"$ref": "PretargetingConfig"
},
"path": "v1/{+pretargetingConfig}:removeTargetedApps",
"httpMethod": "POST",
"id": "realtimebidding.bidders.pretargetingConfigs.removeTargetedApps",
"flatPath": "v1/bidders/{biddersId}/pretargetingConfigs/{pretargetingConfigsId}:removeTargetedApps",
"parameterOrder": [
"pretargetingConfig"
],
"description": "Removes targeted apps from the pretargeting configuration."
},
"addTargetedPublishers": {
"request": {
"$ref": "AddTargetedPublishersRequest"
},
"id": "realtimebidding.bidders.pretargetingConfigs.addTargetedPublishers",
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
],
"description": "Adds targeted publishers to the pretargeting config.",
"httpMethod": "POST",
"parameters": {
"pretargetingConfig": {
"description": "Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}",
"pattern": "^bidders/[^/]+/pretargetingConfigs/[^/]+$",
"required": true,
"type": "string",
"location": "path"
}
},
"flatPath": "v1/bidders/{biddersId}/pretargetingConfigs/{pretargetingConfigsId}:addTargetedPublishers",
"path": "v1/{+pretargetingConfig}:addTargetedPublishers",
"parameterOrder": [
"pretargetingConfig"
],
"response": {
"$ref": "PretargetingConfig"
}
},
"addTargetedApps": {
"parameterOrder": [
"pretargetingConfig"
],
"id": "realtimebidding.bidders.pretargetingConfigs.addTargetedApps",
"path": "v1/{+pretargetingConfig}:addTargetedApps",
"flatPath": "v1/bidders/{biddersId}/pretargetingConfigs/{pretargetingConfigsId}:addTargetedApps",
"description": "Adds targeted apps to the pretargeting configuration.",
"request": {
"$ref": "AddTargetedAppsRequest"
},
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
],
"response": {
"$ref": "PretargetingConfig"
},
"parameters": {
"pretargetingConfig": {
"location": "path",
"type": "string",
"description": "Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}",
"required": true,
"pattern": "^bidders/[^/]+/pretargetingConfigs/[^/]+$"
}
},
"httpMethod": "POST"
},
"removeTargetedPublishers": {
"flatPath": "v1/bidders/{biddersId}/pretargetingConfigs/{pretargetingConfigsId}:removeTargetedPublishers",
"id": "realtimebidding.bidders.pretargetingConfigs.removeTargetedPublishers",
"request": {
"$ref": "RemoveTargetedPublishersRequest"
},
"response": {
"$ref": "PretargetingConfig"
},
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
],
"path": "v1/{+pretargetingConfig}:removeTargetedPublishers",
"description": "Removes targeted publishers from the pretargeting config.",
"httpMethod": "POST",
"parameters": {
"pretargetingConfig": {
"required": true,
"pattern": "^bidders/[^/]+/pretargetingConfigs/[^/]+$",
"location": "path",
"type": "string",
"description": "Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}"
}
},
"parameterOrder": [
"pretargetingConfig"
]
},
"addTargetedSites": {
"id": "realtimebidding.bidders.pretargetingConfigs.addTargetedSites",
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
],
"response": {
"$ref": "PretargetingConfig"
},
"path": "v1/{+pretargetingConfig}:addTargetedSites",
"request": {
"$ref": "AddTargetedSitesRequest"
},
"parameters": {
"pretargetingConfig": {
"required": true,
"location": "path",
"description": "Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}",
"type": "string",
"pattern": "^bidders/[^/]+/pretargetingConfigs/[^/]+$"
}
},
"parameterOrder": [
"pretargetingConfig"
],
"description": "Adds targeted sites to the pretargeting configuration.",
"flatPath": "v1/bidders/{biddersId}/pretargetingConfigs/{pretargetingConfigsId}:addTargetedSites",
"httpMethod": "POST"
}
}
},
"creatives": {
"methods": {
"watch": {
"request": {
"$ref": "WatchCreativesRequest"
},
"path": "v1/{+parent}/creatives:watch",
"response": {
"$ref": "WatchCreativesResponse"
},
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
],
"description": "Watches all creatives pertaining to a bidder. It is sufficient to invoke this endpoint once per bidder. A Pub/Sub topic will be created and notifications will be pushed to the topic when any of the bidder's creatives change status. All of the bidder's service accounts will have access to read from the topic. Subsequent invocations of this method will return the existing Pub/Sub configuration.",
"flatPath": "v1/bidders/{biddersId}/creatives:watch",
"parameterOrder": [
"parent"
],
"id": "realtimebidding.bidders.creatives.watch",
"parameters": {
"parent": {
"description": "Required. To watch all creatives pertaining to the bidder and all its child seat accounts, the bidder must follow the pattern `bidders/{bidderAccountId}`.",
"required": true,
"type": "string",
"location": "path",
"pattern": "^bidders/[^/]+$"
}
}
},
"list": {
"description": "Lists creatives.",
"response": {
"$ref": "ListCreativesResponse"
},
"id": "realtimebidding.bidders.creatives.list",
"parameters": {
"view": {
"type": "string",
"enum": [
"CREATIVE_VIEW_UNSPECIFIED",
"SERVING_DECISION_ONLY",
"FULL"
],
"description": "Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as \"FULL\".",
"location": "query",
"enumDescriptions": [
"Not specified, equivalent to SERVING_DECISION_ONLY.",
"Only creativeServingDecision is included in the response.",
"The entire creative resource (including the declared fields and the creative content) is included in the response."
]
},
"filter": {
"description": "Query string to filter creatives. If no filter is specified, all active creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:IS_COOKIE_TARGETED'",
"location": "query",
"type": "string"
},
"pageToken": {
"type": "string",
"location": "query",
"description": "A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.nextPageToken returned from the previous call to the 'ListCreatives' method."
},
"parent": {
"location": "path",
"pattern": "^bidders/[^/]+$",
"required": true,
"type": "string",
"description": "Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either `buyers/{buyerAccountId}` or `bidders/{bidderAccountId}`. For `buyers/{buyerAccountId}`, the `buyerAccountId` can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (`456`) under bidder account (`123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (`123`), you would use `buyers/123`. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use `bidders/{bidderAccountId}`, e.g., for all creatives pertaining to bidder (`123`), use `bidders/123`."
},
"pageSize": {
"format": "int32",
"description": "Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.",
"type": "integer",
"location": "query"
}
},
"parameterOrder": [
"parent"
],
"flatPath": "v1/bidders/{biddersId}/creatives",
"httpMethod": "GET",
"path": "v1/{+parent}/creatives",
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
]
}
}
}
}
}
},
"ownerName": "Google",
"id": "realtimebidding:v1",
"revision": "20201109",
"documentationLink": "https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/",
"mtlsRootUrl": "https://realtimebidding.mtls.googleapis.com/",
"parameters": {
"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"
},
"$.xgafv": {
"type": "string",
"location": "query",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"description": "V1 error format."
},
"upload_protocol": {
"location": "query",
"type": "string",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
},
"uploadType": {
"type": "string",
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
},
"callback": {
"type": "string",
"description": "JSONP",
"location": "query"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"description": "Data format for response.",
"type": "string",
"default": "json",
"enum": [
"json",
"media",
"proto"
],
"location": "query",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
]
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
"default": "true",
"location": "query"
},
"fields": {
"type": "string",
"location": "query",
"description": "Selector specifying which fields to include in a partial response."
},
"quotaUser": {
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user.",
"location": "query"
}
},
"batchPath": "batch",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"fullyEncodeReservedExpansion": true,
"description": "Allows external bidders to manage their RTB integration with Google. This includes managing bidder endpoints, QPS quotas, configuring what ad inventory to receive via pretargeting, submitting creatives for verification, and accessing creative metadata such as approval status.",
"canonicalName": "Real-time Bidding",
"basePath": "",
"discoveryVersion": "v1",
"rootUrl": "https://realtimebidding.googleapis.com/",
"name": "realtimebidding",
"kind": "discovery#restDescription",
"schemas": {
"ListUserListsResponse": {
"id": "ListUserListsResponse",
"description": "The list user list response.",
"type": "object",
"properties": {
"nextPageToken": {
"description": "The continuation page token to send back to the server in a subsequent request. Due to a currently known issue, it is recommended that the caller keep invoking the list method till the time a next page token is not returned (even if the result set is empty).",
"type": "string"
},
"userLists": {
"description": "List of user lists from the search.",
"items": {
"$ref": "UserList"
},
"type": "array"
}
}
},
"DomainCallEvidence": {
"id": "DomainCallEvidence",
"description": "Number of HTTP calls made by a creative, broken down by domain.",
"type": "object",
"properties": {
"topHttpCallDomains": {
"description": "Breakdown of the most frequent domains called via HTTP by the creative.",
"items": {
"$ref": "DomainCalls"
},
"type": "array"
},
"totalHttpCallCount": {
"format": "int32",
"description": "The total number of HTTP calls made by the creative, including but not limited to the number of calls in the top_http_call_domains.",
"type": "integer"
}
}
},
"ListPretargetingConfigsResponse": {
"id": "ListPretargetingConfigsResponse",
"type": "object",
"description": "A response containing pretargeting configurations.",
"properties": {
"pretargetingConfigs": {
"description": "List of pretargeting configurations.",
"type": "array",
"items": {
"$ref": "PretargetingConfig"
}
},
"nextPageToken": {
"type": "string",
"description": "A token which can be passed to a subsequent call to the `ListPretargetingConfigs` method to retrieve the next page of results in ListPretargetingConfigsRequest.pageToken."
}
}
},
"AddTargetedAppsRequest": {
"properties": {
"appIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of app IDs to target in the pretargeting configuration. These values will be added to the list of targeted app IDs in PretargetingConfig.appTargeting.mobileAppTargeting.values."
},
"targetingMode": {
"enum": [
"TARGETING_MODE_UNSPECIFIED",
"INCLUSIVE",
"EXCLUSIVE"
],
"description": "Required. The targeting mode that should be applied to the list of app IDs. If there are existing targeted app IDs, must be equal to the existing PretargetingConfig.appTargeting.mobileAppTargeting.targetingMode or a 400 bad request error will be returned.",
"type": "string",
"enumDescriptions": [
"Placeholder for undefined targeting mode.",
"The inclusive list type. Inventory must match an item in this list to be targeted.",
"The exclusive list type. Inventory must not match any item in this list to be targeted."
]
}
},
"description": "A request to start targeting the provided app IDs in a specific pretargeting configuration. The pretargeting configuration itself specifies how these apps are targeted. in PretargetingConfig.appTargeting.mobileAppTargeting.",
"type": "object",
"id": "AddTargetedAppsRequest"
},
"HttpCallEvidence": {
"properties": {
"urls": {
"items": {
"type": "string"
},
"description": "URLs of HTTP calls made by the creative.",
"type": "array"
}
},
"id": "HttpCallEvidence",
"description": "HTTP calls made by a creative that resulted in policy violations.",
"type": "object"
},
"UrlDownloadSize": {
"description": "The URL-level breakdown for the download size.",
"type": "object",
"properties": {
"normalizedUrl": {
"description": "The normalized URL with query parameters and fragment removed.",
"type": "string"
},
"downloadSizeKb": {
"format": "int32",
"type": "integer",
"description": "Download size of the URL in kilobytes."
}
},
"id": "UrlDownloadSize"
},
"ActivatePretargetingConfigRequest": {
"id": "ActivatePretargetingConfigRequest",
"description": "A request to activate a pretargeting configuration. Sets the configuration's state to ACTIVE.",
"properties": {},
"type": "object"
},
"PolicyTopicEntry": {
"type": "object",
"properties": {
"evidences": {
"description": "Pieces of evidence associated with this policy topic entry.",
"items": {
"$ref": "PolicyTopicEvidence"
},
"type": "array"
},
"policyTopic": {
"type": "string",
"description": "Policy topic this entry refers to. For example, \"ALCOHOL\", \"TRADEMARKS_IN_AD_TEXT\", or \"DESTINATION_NOT_WORKING\". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method"
},
"helpCenterUrl": {
"description": "URL of the help center article describing this policy topic.",
"type": "string"
}
},
"id": "PolicyTopicEntry",
"description": "Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation."
},
"NativeContent": {
"id": "NativeContent",
"properties": {
"appIcon": {
"$ref": "Image",
"description": "The app icon, for app download ads."
},
"image": {
"description": "A large image.",
"$ref": "Image"
},
"clickTrackingUrl": {
"type": "string",
"description": "The URL to use for click tracking."
},
"body": {
"description": "A long description of the ad.",
"type": "string"
},
"advertiserName": {
"description": "The name of the advertiser or sponsor, to be displayed in the ad creative.",
"type": "string"
},
"callToAction": {
"description": "A label for the button that the user is supposed to click.",
"type": "string"
},
"starRating": {
"type": "number",
"format": "double",
"description": "The app rating in the app store. Must be in the range [0-5]."
},
"priceDisplayText": {
"description": "The price of the promoted app including currency info.",
"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"
},
"headline": {
"description": "A short title for the ad.",
"type": "string"
},
"videoUrl": {
"description": "The URL to fetch a native video ad.",
"type": "string"
}
},
"type": "object",
"description": "Native content for a creative."
},
"RemoveTargetedPublishersRequest": {
"properties": {
"publisherIds": {
"items": {
"type": "string"
},
"type": "array",
"description": "A list of publisher IDs to stop targeting in the pretargeting configuration. These values will be removed from the list of targeted publisher IDs in PretargetingConfig.publisherTargeting.values. Publishers are identified by their publisher ID from ads.txt / app-ads.txt. See https://iabtechlab.com/ads-txt/ and https://iabtechlab.com/app-ads-txt/ for more details."
}
},
"type": "object",
"id": "RemoveTargetedPublishersRequest",
"description": "A request to stop targeting publishers in a specific configuration. The pretargeting configuration itself specifies how these publishers are targeted in PretargetingConfig.publisherTargeting."
},
"OpenUserListRequest": {
"type": "object",
"id": "OpenUserListRequest",
"description": "A request to open a specified user list.",
"properties": {}
},
"HttpCookieEvidence": {
"description": "Evidence for HTTP cookie-related policy violations.",
"id": "HttpCookieEvidence",
"properties": {
"cookieNames": {
"description": "Names of cookies that violate Google policies. For TOO_MANY_COOKIES policy, this will be the cookie names of top domains with the largest number of cookies. For other policies, this will be all the cookie names that violate the policy.",
"type": "array",
"items": {
"type": "string"
}
},
"maxCookieCount": {
"description": "The largest number of cookies set by a creative. If this field is set, cookie_names above will be set to the cookie names of top domains with the largest number of cookies. This field will only be set for TOO_MANY_COOKIES policy.",
"type": "integer",
"format": "int32"
}
},
"type": "object"
},
"SuspendPretargetingConfigRequest": {
"properties": {},
"type": "object",
"id": "SuspendPretargetingConfigRequest",
"description": "A request to suspend a pretargeting configuration. Sets the configuration's state to SUSPENDED."
},
"DownloadSizeEvidence": {
"properties": {
"topUrlDownloadSizeBreakdowns": {
"type": "array",
"items": {
"$ref": "UrlDownloadSize"
},
"description": "Download size broken down by URLs with the top download size."
},
"totalDownloadSizeKb": {
"type": "integer",
"format": "int32",
"description": "Total download size (in kilobytes) for all the resources in the creative."
}
},
"id": "DownloadSizeEvidence",
"type": "object",
"description": "Total download size and URL-level download size breakdown for resources in a creative."
},
"ListCreativesResponse": {
"id": "ListCreativesResponse",
"type": "object",
"properties": {
"nextPageToken": {
"type": "string",
"description": "A token to retrieve the next page of results. Pass this value in the ListCreativesRequest.pageToken field in the subsequent call to the `ListCreatives` method to retrieve the next page of results."
},
"creatives": {
"description": "The list of creatives.",
"items": {
"$ref": "Creative"
},
"type": "array"
}
},
"description": "A response for listing creatives."
},
"AddTargetedSitesRequest": {
"properties": {
"targetingMode": {
"type": "string",
"enumDescriptions": [
"Placeholder for undefined targeting mode.",
"The inclusive list type. Inventory must match an item in this list to be targeted.",
"The exclusive list type. Inventory must not match any item in this list to be targeted."
],
"enum": [
"TARGETING_MODE_UNSPECIFIED",
"INCLUSIVE",
"EXCLUSIVE"
],
"description": "Required. The targeting mode that should be applied to the list of site URLs. If there are existing targeted sites, must be equal to the existing PretargetingConfig.webTargeting.targetingMode or a 400 bad request error will be returned."
},
"sites": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of site URLs to target in the pretargeting configuration. These values will be added to the list of targeted URLs in PretargetingConfig.webTargeting.values."
}
},
"type": "object",
"description": "A request to start targeting the provided sites in a specific pretargeting configuration. The pretargeting configuration itself specifies how these sites are targeted in PretargetingConfig.webTargeting.",
"id": "AddTargetedSitesRequest"
},
"AdvertiserAndBrand": {
"description": "Detected advertiser and brand information.",
"properties": {
"advertiserId": {
"format": "int64",
"description": "See https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt for the list of possible values. Can be used to filter the response of the creatives.list method.",
"type": "string"
},
"advertiserName": {
"description": "Advertiser name. Can be used to filter the response of the creatives.list method.",
"type": "string"
},
"brandId": {
"type": "string",
"description": "Detected brand ID or zero if no brand has been detected. See https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt for the list of possible values. Can be used to filter the response of the creatives.list method.",
"format": "int64"
},
"brandName": {
"type": "string",
"description": "Brand name. Can be used to filter the response of the creatives.list method."
}
},
"id": "AdvertiserAndBrand",
"type": "object"
},
"Date": {
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.",
"id": "Date",
"type": "object",
"properties": {
"month": {
"format": "int32",
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
"type": "integer"
},
"day": {
"format": "int32",
"type": "integer",
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant."
},
"year": {
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
"format": "int32",
"type": "integer"
}
}
},
"CreativeDimensions": {
"description": "The dimensions of a creative. This applies to only HTML and Native creatives.",
"type": "object",
"id": "CreativeDimensions",
"properties": {
"width": {
"format": "int64",
"description": "The width of the creative in pixels.",
"type": "string"
},
"height": {
"format": "int64",
"description": "The height of the creative in pixels.",
"type": "string"
}
}
},
"AppTargeting": {
"type": "object",
"properties": {
"mobileAppTargeting": {
"$ref": "StringTargetingDimension",
"description": "Targeted app IDs. App IDs can refer to those found in an app store or ones that are not published in an app store. A maximum of 30,000 app IDs can be targeted."
},
"mobileAppCategoryTargeting": {
"description": "Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv.",
"$ref": "NumericTargetingDimension"
}
},
"description": "A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent.",
"id": "AppTargeting"
},
"DestinationNotWorkingEvidence": {
"type": "object",
"id": "DestinationNotWorkingEvidence",
"description": "Evidence of the creative's destination URL not functioning properly or having been incorrectly set up.",
"properties": {
"expandedUrl": {
"description": "The full non-working URL.",
"type": "string"
},
"redirectionError": {
"description": "HTTP redirect chain error.",
"enum": [
"REDIRECTION_ERROR_UNSPECIFIED",
"TOO_MANY_REDIRECTS",
"INVALID_REDIRECT",
"EMPTY_REDIRECT",
"REDIRECT_ERROR_UNKNOWN"
],
"enumDescriptions": [
"Default value that should never be used.",
"Too many redirect hops.",
"Got a redirect but it was invalid.",
"Got a redirect but it was empty.",
"Unknown redirect error."
],
"type": "string"
},
"invalidPage": {
"type": "string",
"enumDescriptions": [
"Default value that should never be used.",
"Page was empty or had an error."
],
"enum": [
"INVALID_PAGE_UNSPECIFIED",
"EMPTY_OR_ERROR_PAGE"
],
"description": "Page was crawled successfully, but was detected as either a page with no content or an error page."
},
"platform": {
"type": "string",
"enumDescriptions": [
"Default value that should never be used.",
"The personal computer platform.",
"The Android platform.",
"The iOS platform."
],
"description": "Platform of the non-working URL.",
"enum": [
"PLATFORM_UNSPECIFIED",
"PERSONAL_COMPUTER",
"ANDROID",
"IOS"
]
},
"dnsError": {
"enum": [
"DNS_ERROR_UNSPECIFIED",
"ERROR_DNS",
"GOOGLE_CRAWLER_DNS_ISSUE"
],
"description": "DNS lookup errors.",
"enumDescriptions": [
"Default value that should never be used.",
"DNS name was not found.",
"An internal issue occurred when Google's crawler tried to resolve the DNS entry. This is a Google-internal issue and may not be the result of an issue with the landing page."
],
"type": "string"
},
"httpError": {
"type": "integer",
"format": "int32",
"description": "HTTP error code (e.g. 404 or 5xx)"
},
"lastCheckTime": {
"format": "google-datetime",
"description": "Approximate time when the ad destination was last checked.",
"type": "string"
},
"urlRejected": {
"type": "string",
"description": "Rejected because of malformed URLs or invalid requests.",
"enumDescriptions": [
"Default value that should never be used.",
"URL rejected because of a malformed request.",
"URL rejected because of a malformed URL.",
"URL rejected because of unknown reason."
],
"enum": [
"URL_REJECTED_UNSPECIFIED",
"BAD_REQUEST",
"MALFORMED_URL",
"URL_REJECTED_UNKNOWN"
]
}
}
},
"NumericTargetingDimension": {
"type": "object",
"id": "NumericTargetingDimension",
"description": "Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting.",
"properties": {
"includedIds": {
"type": "array",
"description": "The IDs included in a configuration.",
"items": {
"type": "string",
"format": "int64"
}
},
"excludedIds": {
"description": "The IDs excluded in a configuration.",
"type": "array",
"items": {
"format": "int64",
"type": "string"
}
}
}
},
"CreativeServingDecision": {
"properties": {
"detectedSensitiveCategories": {
"description": "Detected sensitive categories, if any. Can be used to filter the response of the creatives.list method. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids.",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"platformPolicyCompliance": {
"description": "Policy compliance of this creative when bidding in Open Bidding (outside of Russia and China). For the list of platform policies, see: https://support.google.com/platformspolicy/answer/3013851.",
"$ref": "PolicyCompliance"
},
"detectedAttributes": {
"items": {
"type": "string",
"enum": [
"ATTRIBUTE_UNSPECIFIED",
"IMAGE_RICH_MEDIA",
"ADOBE_FLASH_FLV",
"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",
"CREATIVE_TYPE_HTML",
"CREATIVE_TYPE_VAST_VIDEO",
"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_FLASH",
"RICH_MEDIA_CAPABILITY_TYPE_HTML5",
"SKIPPABLE_INSTREAM_VIDEO",
"RICH_MEDIA_CAPABILITY_TYPE_SSL",
"RICH_MEDIA_CAPABILITY_TYPE_NON_SSL",
"RICH_MEDIA_CAPABILITY_TYPE_INTERSTITIAL",
"NON_SKIPPABLE_INSTREAM_VIDEO",
"NATIVE_ELIGIBILITY_ELIGIBLE",
"NON_VPAID",
"NATIVE_ELIGIBILITY_NOT_ELIGIBLE",
"ANY_INTERSTITIAL",
"NON_INTERSTITIAL",
"IN_BANNER_VIDEO",
"RENDERING_SIZELESS_ADX",
"OMSDK_1_0"
],
"enumDescriptions": [
"Do not use. This is a placeholder value only.",
"The creative is of type image/rich media. For pretargeting.",
"The creative is of video type Adobe Flash FLV. For pretargeting.",
"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 type is HTML.",
"The creative type is VAST video.",
"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 Flash.",
"The creative is HTML5.",
"The creative has an instream VAST video type of skippable instream video. For pretargeting.",
"The creative is SSL.",
"The creative is non-SSL.",
"The creative is an interstitial.",
"The creative has an instream VAST video type of non-skippable instream video. For pretargeting.",
"The creative is eligible for native.",
"The creative has an instream VAST video type of non-VPAID. For pretargeting.",
"The creative is not eligible for native.",
"The creative has an interstitial size of any interstitial. For pretargeting.",
"The creative has an interstitial size of non interstitial. For pretargeting.",
"The video type is in-banner video.",
"The creative can dynamically resize to fill a variety of slot sizes.",
"The open measurement SDK is supported."
]
},
"description": "Publisher-excludable attributes that were detected for this creative. Can be used to filter the response of the creatives.list method. If the `excluded_attribute` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction.",
"type": "array"
},
"chinaPolicyCompliance": {
"$ref": "PolicyCompliance",
"description": "The policy compliance of this creative in China. When approved or disapproved, this applies to both deals and open auction in China. When pending review, this creative is allowed to serve for deals but not for open auction."
},
"detectedVendorIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs of the ad technology vendors that were detected to be used by this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. Can be used to filter the response of the creatives.list method. If the `allowed_vendor_type` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) does not contain one of the vendor type IDs that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction."
},
"networkPolicyCompliance": {
"description": "Policy compliance of this creative when bidding in open auction, private auction, or auction packages (outside of Russia and China).",
"$ref": "PolicyCompliance"
},
"detectedAdvertisers": {
"items": {
"$ref": "AdvertiserAndBrand"
},
"type": "array",
"description": "Detected advertisers and brands."
},
"detectedProductCategories": {
"description": "Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs. Can be used to filter the response of the creatives.list method.",
"items": {
"type": "integer",
"format": "int32"
},
"type": "array"
},
"detectedDomains": {
"description": "The detected domains for this creative.",
"type": "array",
"items": {
"type": "string"
}
},
"dealsPolicyCompliance": {
"$ref": "PolicyCompliance",
"description": "Policy compliance of this creative when bidding on Programmatic Guaranteed and Preferred Deals (outside of Russia and China)."
},
"russiaPolicyCompliance": {
"$ref": "PolicyCompliance",
"description": "The policy compliance of this creative in Russia. When approved or disapproved, this applies to both deals and open auction in Russia. When pending review, this creative is allowed to serve for deals but not for open auction."
},
"detectedLanguages": {
"description": "The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes. Can be used to filter the response of the creatives.list method.",
"items": {
"type": "string"
},
"type": "array"
},
"lastStatusUpdate": {
"type": "string",
"format": "google-datetime",
"description": "The last time the creative status was updated. Can be used to filter the response of the creatives.list method."
},
"detectedClickThroughUrls": {
"type": "array",
"description": "The set of detected destination URLs for the creative. Can be used to filter the response of the creatives.list method.",
"items": {
"type": "string"
}
}
},
"id": "CreativeServingDecision",
"type": "object",
"description": "Top level status and detected attributes of a creative."
},
"PretargetingConfig": {
"type": "object",
"id": "PretargetingConfig",
"properties": {
"geoTargeting": {
"$ref": "NumericTargetingDimension",
"description": "The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv"
},
"minimumViewabilityDecile": {
"description": "The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values \u003e 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability.",
"type": "integer",
"format": "int32"
},
"userListTargeting": {
"$ref": "NumericTargetingDimension",
"description": "The remarketing lists included or excluded in this configuration as defined in UserList."
},
"includedPlatforms": {
"items": {
"enum": [
"PLATFORM_UNSPECIFIED",
"PERSONAL_COMPUTER",
"PHONE",
"TABLET",
"CONNECTED_TV"
],
"type": "string",
"enumDescriptions": [
"Placeholder for an undefined platform. This value should not be used.",
"The personal computer platform.",
"The mobile platform.",
"The tablet platform.",
"The connected TV platform."
]
},
"type": "array",
"description": "The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform."
},
"webTargeting": {
"$ref": "StringTargetingDimension",
"description": "Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration)."
},
"includedLanguages": {
"description": "The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.",
"items": {
"type": "string"
},
"type": "array"
},
"publisherTargeting": {
"$ref": "StringTargetingDimension",
"description": "Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto)."
},
"includedUserIdTypes": {
"description": "User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent.",
"type": "array",
"items": {
"type": "string",
"enum": [
"USER_ID_TYPE_UNSPECIFIED",
"HOSTED_MATCH_DATA",
"GOOGLE_COOKIE",
"DEVICE_ID"
],
"enumDescriptions": [
"Placeholder for unspecified user identifier.",
"Hosted match data, referring to hosted_match_data in the bid request.",
"Google cookie, referring to google_user_id in the bid request.",
"Mobile device advertising ID."
]
}
},
"includedCreativeDimensions": {
"type": "array",
"description": "Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension.",
"items": {
"$ref": "CreativeDimensions"
}
},
"allowedUserTargetingModes": {
"items": {
"enumDescriptions": [
"Placeholder for undefined user targeting mode.",
"Remarketing ads are allowed to serve.",
"Ads based on user interest category targeting are allowed to serve."
],
"enum": [
"USER_TARGETING_MODE_UNSPECIFIED",
"REMARKETING_ADS",
"INTEREST_BASED_TARGETING"
],
"type": "string"
},
"type": "array",
"description": "Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow."
},
"verticalTargeting": {
"$ref": "NumericTargetingDimension",
"description": "The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals"
},
"interstitialTargeting": {
"enumDescriptions": [
"Unspecified interstitial targeting. Represents an interstitial-agnostic selection.",
"Only bid requests for interstitial inventory should be sent.",
"Only bid requests for non-interstitial inventory should be sent."
],
"description": "The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not.",
"type": "string",
"enum": [
"INTERSTITIAL_TARGETING_UNSPECIFIED",
"ONLY_INTERSTITIAL_REQUESTS",
"ONLY_NON_INTERSTITIAL_REQUESTS"
]
},
"maximumQps": {
"description": "The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide",
"format": "int64",
"type": "string"
},
"displayName": {
"description": "The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.",
"type": "string"
},
"name": {
"type": "string",
"readOnly": true,
"description": "Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`"
},
"includedFormats": {
"type": "array",
"description": "Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format.",
"items": {
"enumDescriptions": [
"Placeholder for undefined creative format. This value should not be used.",
"HTML and AMPHTML creatives.",
"VAST video or audio creative.",
"Native creative, including standard and video native ads."
],
"type": "string",
"enum": [
"CREATIVE_FORMAT_UNSPECIFIED",
"HTML",
"VAST",
"NATIVE"
]
}
},
"includedEnvironments": {
"description": "Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments.",
"items": {
"enum": [
"ENVIRONMENT_UNSPECIFIED",
"APP",
"WEB"
],
"type": "string",
"enumDescriptions": [
"Placeholder for unspecified environment. This value should not be used.",
"App environment.",
"Web environment."
]
},
"type": "array"
},
"billingId": {
"type": "string",
"readOnly": true,
"description": "Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids.",
"format": "int64"
},
"state": {
"description": "Output only. The state of this pretargeting configuration.",
"enumDescriptions": [
"Placeholder for undefined state.",
"This pretargeting configuration is actively being used to filter bid requests.",
"This pretargeting configuration is suspended and not used in serving."
],
"readOnly": true,
"enum": [
"STATE_UNSPECIFIED",
"ACTIVE",
"SUSPENDED"
],
"type": "string"
},
"appTargeting": {
"$ref": "AppTargeting",
"description": "Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension)."
},
"includedMobileOperatingSystemIds": {
"description": "The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"excludedContentLabelIds": {
"type": "array",
"description": "The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.",
"items": {
"format": "int64",
"type": "string"
}
},
"invalidGeoIds": {
"readOnly": true,
"type": "array",
"description": "Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.",
"items": {
"type": "string",
"format": "int64"
}
}
},
"description": "Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for."
},
"MediaFile": {
"properties": {
"mimeType": {
"type": "string",
"enum": [
"VIDEO_MIME_TYPE_UNSPECIFIED",
"MIME_VIDEO_XFLV",
"MIME_VIDEO_WEBM",
"MIME_VIDEO_MP4",
"MIME_VIDEO_OGG",
"MIME_VIDEO_YT_HOSTED",
"MIME_VIDEO_X_MS_WMV",
"MIME_VIDEO_3GPP",
"MIME_VIDEO_MOV",
"MIME_APPLICATION_SWF",
"MIME_APPLICATION_SURVEY",
"MIME_APPLICATION_JAVASCRIPT",
"MIME_APPLICATION_SILVERLIGHT",
"MIME_APPLICATION_MPEGURL",
"MIME_APPLICATION_MPEGDASH",
"MIME_AUDIO_MP4A",
"MIME_AUDIO_MP3",
"MIME_AUDIO_OGG"
],
"enumDescriptions": [
"Default value that should never be used.",
"Flash container.",
"WebM container assuming VP9 codec.",
"MPEG-4 container typically with H.264 codec.",
"Ogg container assuming Theora codec.",
"Video files hosted on YouTube.",
"Windows Media Video Codec.",
"3GPP container format used on 3G phones.",
"Quicktime container format.",
"Shockwave Flash (used for VPAID ads).",
"Properties of VAST served by consumer survey.",
"JavaScript (used for VPAID ads).",
"Silverlight (used for VPAID ads).",
"HLS/M3U8.",
"DASH.",
"MPEG-4 audio format.",
"MPEG-3 audio format.",
"Ogg audio format"
],
"description": "The MIME type of this media file. Can be used to filter the response of the creatives.list method."
},
"bitrate": {
"description": "Bitrate of the video file, in Kbps. Can be used to filter the response of the creatives.list method.",
"type": "string",
"format": "int64"
}
},
"type": "object",
"description": "Information about each media file in the VAST.",
"id": "MediaFile"
},
"PolicyCompliance": {
"id": "PolicyCompliance",
"properties": {
"status": {
"type": "string",
"enumDescriptions": [
"Default value that should never be used.",
"Creative is pending review.",
"Creative cannot serve.",
"Creative is approved."
],
"description": "Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method.",
"enum": [
"STATUS_UNSPECIFIED",
"PENDING_REVIEW",
"DISAPPROVED",
"APPROVED"
]
},
"topics": {
"description": "Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED.",
"type": "array",
"items": {
"$ref": "PolicyTopicEntry"
}
}
},
"description": "Policy compliance of the creative for a transaction type or a region.",
"type": "object"
},
"DomainCalls": {
"properties": {
"domain": {
"type": "string",
"description": "The domain name."
},
"httpCallCount": {
"format": "int32",
"type": "integer",
"description": "Number of HTTP calls made to the domain."
}
},
"type": "object",
"description": "The number of HTTP calls made to the given domain.",
"id": "DomainCalls"
},
"Image": {
"description": "An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved.",
"type": "object",
"id": "Image",
"properties": {
"height": {
"description": "Image height in pixels.",
"format": "int32",
"type": "integer"
},
"width": {
"format": "int32",
"description": "Image width in pixels.",
"type": "integer"
},
"url": {
"type": "string",
"description": "The URL of the image."
}
}
},
"DestinationNotCrawlableEvidence": {
"properties": {
"reason": {
"enum": [
"REASON_UNSPECIFIED",
"UNREACHABLE_ROBOTS",
"TIMEOUT_ROBOTS",
"ROBOTED_DENIED",
"UNKNOWN"
],
"type": "string",
"description": "Reason of destination not crawlable.",
"enumDescriptions": [
"Default value that should never be used.",
"Site's robots exclusion file (e.g., robots.txt) was unreachable.",
"Timed out reading site's robots exclusion file (e.g., robots.txt).",
"Crawler was disallowed by the site's robots exclusion file (e.g., robots.txt).",
"Unknown reason."
]
},
"crawlTime": {
"description": "Approximate time of the crawl.",
"type": "string",
"format": "google-datetime"
},
"crawledUrl": {
"description": "Destination URL that was attempted to be crawled.",
"type": "string"
}
},
"id": "DestinationNotCrawlableEvidence",
"type": "object",
"description": "Evidence that the creative's destination URL was not crawlable by Google."
},
"AddTargetedPublishersRequest": {
"id": "AddTargetedPublishersRequest",
"description": "A request to start targeting the provided publishers in a specific pretargeting configuration. The pretargeting configuration itself specifies how these publishers are targeted in PretargetingConfig.publisherTargeting.",
"properties": {
"targetingMode": {
"type": "string",
"enumDescriptions": [
"Placeholder for undefined targeting mode.",
"The inclusive list type. Inventory must match an item in this list to be targeted.",
"The exclusive list type. Inventory must not match any item in this list to be targeted."
],
"description": "Required. The targeting mode that should be applied to the list of publisher IDs. If are existing publisher IDs, must be equal to the existing PretargetingConfig.publisherTargeting.targetingMode or a 400 bad request error will be returned.",
"enum": [
"TARGETING_MODE_UNSPECIFIED",
"INCLUSIVE",
"EXCLUSIVE"
]
},
"publisherIds": {
"description": "A list of publisher IDs to target in the pretargeting configuration. These values will be added to the list of targeted publisher IDs in PretargetingConfig.publisherTargeting.values. Publishers are identified by their publisher ID from ads.txt / app-ads.txt. See https://iabtechlab.com/ads-txt/ and https://iabtechlab.com/app-ads-txt/ for more details.",
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
},
"UserList": {
"properties": {
"displayName": {
"type": "string",
"description": "Required. Display name of the user list. This must be unique across all user lists for a given account."
},
"urlRestriction": {
"$ref": "UrlRestriction",
"description": "Required. The URL restriction for the user list."
},
"name": {
"description": "Output only. Name of the user list that must follow the pattern `buyers/{buyer}/userLists/{user_list}`, where `{buyer}` represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, `{buyer}` represents the account ID of the child seat buyer. `{user_list}` is an int64 identifier assigned by Google to uniquely identify a user list.",
"type": "string",
"readOnly": true
},
"membershipDurationDays": {
"format": "int64",
"description": "Required. The number of days a user's cookie stays on the user list. The field must be between 0 and 540 inclusive.",
"type": "string"
},
"description": {
"type": "string",
"description": "The description for the user list."
},
"status": {
"description": "Output only. The status of the user list. A new user list starts out as open.",
"readOnly": true,
"enumDescriptions": [
"Default value that should never be used.",
"New users can be added to the user list.",
"New users cannot be added to the user list."
],
"type": "string",
"enum": [
"STATUS_UNSPECIFIED",
"OPEN",
"CLOSED"
]
}
},
"id": "UserList",
"type": "object",
"description": "Represents an Authorized Buyers user list. Authorized Buyers can create/update/list user lists. Once a user list is created in the system, Authorized Buyers can add users to the user list using the bulk uploader API. Alternatively, users can be added by hosting a tag on the advertiser's page."
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object",
"id": "Empty",
"properties": {}
},
"GetRemarketingTagResponse": {
"id": "GetRemarketingTagResponse",
"description": "Response for a request to get remarketing tag.",
"type": "object",
"properties": {
"snippet": {
"type": "string",
"description": "A HTML tag that can be placed on the advertiser's page to add users to a user list. For more information and code samples on using snippet on your website refer to [Tag your site for remarketing]( https://support.google.com/google-ads/answer/2476688)."
}
}
},
"RemoveTargetedAppsRequest": {
"properties": {
"appIds": {
"description": "A list of app IDs to stop targeting in the pretargeting configuration. These values will be removed from the list of targeted app IDs in PretargetingConfig.appTargeting.mobileAppTargeting.values.",
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object",
"id": "RemoveTargetedAppsRequest",
"description": "A request to stop targeting the provided apps in a specific pretargeting configuration. The pretargeting configuration itself specifies how these apps are targeted. in PretargetingConfig.appTargeting.mobileAppTargeting."
},
"WatchCreativesRequest": {
"properties": {},
"id": "WatchCreativesRequest",
"type": "object",
"description": "A request to receive push notifications when any of the creatives belonging to the bidder changes status."
},
"DestinationUrlEvidence": {
"description": "The full landing page URL of the destination.",
"id": "DestinationUrlEvidence",
"type": "object",
"properties": {
"destinationUrl": {
"type": "string",
"description": "The full landing page URL of the destination."
}
}
},
"HtmlContent": {
"id": "HtmlContent",
"description": "HTML content for a creative.",
"type": "object",
"properties": {
"width": {
"description": "The width of the HTML snippet in pixels. Can be used to filter the response of the creatives.list method.",
"format": "int32",
"type": "integer"
},
"snippet": {
"type": "string",
"description": "The HTML snippet that displays the ad when inserted in the web page."
},
"height": {
"format": "int32",
"type": "integer",
"description": "The height of the HTML snippet in pixels. Can be used to filter the response of the creatives.list method."
}
}
},
"UrlRestriction": {
"description": "Represents the URL restriction (for the URL captured by the pixel callback) for a user list.",
"properties": {
"restrictionType": {
"enumDescriptions": [
"Default value that should never be used.",
"The tag URL (as recorded by the pixel callback) contains the specified URL.",
"The tag URL (as recorded by the pixel callback) exactly matches the specified URL.",
"The tag URL (as recorded by the pixel callback) starts with the specified URL.",
"The tag URL (as recorded by the pixel callback) ends with the specified URL.",
"The tag URL (as recorded by the pixel callback) does not equal the specified URL.",
"The tag URL (as recorded by the pixel callback) does not contain the specified URL.",
"The tag URL (as recorded by the pixel callback) does not start with the specified URL.",
"The tag URL (as recorded by the pixel callback) does not end with the specified URL."
],
"enum": [
"RESTRICTION_TYPE_UNSPECIFIED",
"CONTAINS",
"EQUALS",
"STARTS_WITH",
"ENDS_WITH",
"DOES_NOT_EQUAL",
"DOES_NOT_CONTAIN",
"DOES_NOT_START_WITH",
"DOES_NOT_END_WITH"
],
"description": "The restriction type for the specified URL.",
"type": "string"
},
"startDate": {
"$ref": "Date",
"description": "Start date (if specified) of the URL restriction."
},
"url": {
"description": "Required. The URL to use for applying the restriction on the user list.",
"type": "string"
},
"endDate": {
"description": "End date (if specified) of the URL restriction. End date should be later than the start date for the date range to be valid.",
"$ref": "Date"
}
},
"id": "UrlRestriction",
"type": "object"
},
"VideoMetadata": {
"description": "Video metadata for a creative.",
"properties": {
"isValidVast": {
"type": "boolean",
"description": "Is this a valid VAST ad? Can be used to filter the response of the creatives.list method."
},
"isVpaid": {
"type": "boolean",
"description": "Is this a VPAID ad? Can be used to filter the response of the creatives.list method."
},
"vastVersion": {
"enum": [
"VAST_VERSION_UNSPECIFIED",
"VAST_VERSION_1_0",
"VAST_VERSION_2_0",
"VAST_VERSION_3_0",
"VAST_VERSION_4_0"
],
"enumDescriptions": [
"Default value that should never be used.",
"VAST 1.0",
"VAST 2.0",
"VAST 3.0",
"VAST 4.0"
],
"description": "The maximum VAST version across all wrapped VAST documents. Can be used to filter the response of the creatives.list method.",
"type": "string"
},
"skipOffset": {
"format": "google-duration",
"description": "The minimum duration that the user has to watch before being able to skip this ad. If the field is not set, the ad is not skippable. If the field is set, the ad is skippable. Can be used to filter the response of the creatives.list method.",
"type": "string"
},
"duration": {
"type": "string",
"format": "google-duration",
"description": "The duration of the ad. Can be used to filter the response of the creatives.list method."
},
"mediaFiles": {
"type": "array",
"items": {
"$ref": "MediaFile"
},
"description": "The list of all media files declared in the VAST. If there are multiple VASTs in a wrapper chain, this includes the media files from the deepest one in the chain."
}
},
"id": "VideoMetadata",
"type": "object"
},
"RemoveTargetedSitesRequest": {
"id": "RemoveTargetedSitesRequest",
"type": "object",
"description": "A request to stop targeting sites in a specific pretargeting configuration. The pretargeting configuration itself specifies how these sites are targeted in PretargetingConfig.webTargeting.",
"properties": {
"sites": {
"items": {
"type": "string"
},
"description": "A list of site URLs to stop targeting in the pretargeting configuration. These values will be removed from the list of targeted URLs in PretargetingConfig.webTargeting.values.",
"type": "array"
}
}
},
"VideoContent": {
"properties": {
"videoMetadata": {
"readOnly": true,
"$ref": "VideoMetadata",
"description": "Output only. Video metadata."
},
"videoUrl": {
"description": "The URL to fetch a video ad.",
"type": "string"
},
"videoVastXml": {
"type": "string",
"description": "The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard."
}
},
"id": "VideoContent",
"description": "Video content for a creative.",
"type": "object"
},
"CloseUserListRequest": {
"id": "CloseUserListRequest",
"description": "A request to close a specified user list.",
"type": "object",
"properties": {}
},
"PolicyTopicEvidence": {
"description": "Evidence associated with a policy topic entry.",
"type": "object",
"id": "PolicyTopicEvidence",
"properties": {
"httpCookie": {
"description": "Evidence for HTTP cookie-related policy violations.",
"$ref": "HttpCookieEvidence"
},
"downloadSize": {
"$ref": "DownloadSizeEvidence",
"description": "Total download size and URL-level download size breakdown for resources in a creative."
},
"destinationNotCrawlable": {
"$ref": "DestinationNotCrawlableEvidence",
"description": "The creative's destination URL was not crawlable by Google."
},
"httpCall": {
"$ref": "HttpCallEvidence",
"description": "HTTP calls made by the creative that resulted in policy violations."
},
"destinationNotWorking": {
"$ref": "DestinationNotWorkingEvidence",
"description": "The creative's destination URL did not function properly or was incorrectly set up."
},
"domainCall": {
"$ref": "DomainCallEvidence",
"description": "Number of HTTP calls made by the creative, broken down by domain."
},
"destinationUrl": {
"$ref": "DestinationUrlEvidence",
"description": "URL of the actual landing page."
}
}
},
"Creative": {
"id": "Creative",
"type": "object",
"properties": {
"dealIds": {
"items": {
"type": "string"
},
"readOnly": true,
"description": "Output only. IDs of all of the deals with which this creative has been used in bidding. Can be used to filter the response of the creatives.list method.",
"type": "array"
},
"agencyId": {
"description": "The agency ID for this creative.",
"type": "string",
"format": "int64"
},
"creativeId": {
"type": "string",
"description": "Buyer-specific creative ID that references this creative in bid responses. This field is Ignored in update operations. Can be used to filter the response of the creatives.list method. The maximum length of the creative ID is 128 bytes."
},
"apiUpdateTime": {
"type": "string",
"readOnly": true,
"format": "google-datetime",
"description": "Output only. The last update timestamp of the creative via API."
},
"impressionTrackingUrls": {
"type": "array",
"items": {
"type": "string"
},
"description": "The set of URLs to be called to record an impression."
},
"accountId": {
"readOnly": true,
"format": "int64",
"type": "string",
"description": "Output only. ID of the buyer account that this creative is owned by. Can be used to filter the response of the creatives.list method with equality and inequality check."
},
"version": {
"readOnly": true,
"format": "int32",
"type": "integer",
"description": "Output only. The version of this creative. Version for a new creative is 1 and it increments during subsequent creative updates."
},
"declaredRestrictedCategories": {
"items": {
"type": "string",
"enum": [
"RESTRICTED_CATEGORY_UNSPECIFIED",
"ALCOHOL"
],
"enumDescriptions": [
"Default value that should never be used.",
"The alcohol restricted category."
]
},
"type": "array",
"description": "All declared restricted categories for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method."
},
"restrictedCategories": {
"description": "All restricted categories for the ads that may be shown from this creative.",
"items": {
"enumDescriptions": [
"Default value that should never be used.",
"The alcohol restricted category."
],
"enum": [
"RESTRICTED_CATEGORY_UNSPECIFIED",
"ALCOHOL"
],
"type": "string"
},
"type": "array"
},
"html": {
"description": "An HTML creative.",
"$ref": "HtmlContent"
},
"native": {
"description": "A native creative.",
"$ref": "NativeContent"
},
"adChoicesDestinationUrl": {
"description": "The link to AdChoices destination page. This is only supported for native ads.",
"type": "string"
},
"declaredClickThroughUrls": {
"items": {
"type": "string"
},
"description": "The set of declared destination URLs for the creative. Can be used to filter the response of the creatives.list method.",
"type": "array"
},
"declaredVendorIds": {
"description": "IDs for the declared ad technology vendors that may be used by this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. Can be used to filter the response of the creatives.list method.",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"video": {
"$ref": "VideoContent",
"description": "A video creative."
},
"creativeServingDecision": {
"description": "Output only. Top level status and detected attributes of a creative (for example domain, language, advertiser, product category, etc.) that affect whether (status) and where (context) a creative will be allowed to serve.",
"readOnly": true,
"$ref": "CreativeServingDecision"
},
"creativeFormat": {
"readOnly": true,
"enumDescriptions": [
"The format is unknown.",
"HTML creative.",
"Video creative.",
"Native creative."
],
"description": "Output only. The format of this creative. Can be used to filter the response of the creatives.list method.",
"enum": [
"CREATIVE_FORMAT_UNSPECIFIED",
"HTML",
"VIDEO",
"NATIVE"
],
"type": "string"
},
"advertiserName": {
"type": "string",
"description": "The name of the company being advertised in the creative. Can be used to filter the response of the creatives.list method."
},
"declaredAttributes": {
"items": {
"enum": [
"ATTRIBUTE_UNSPECIFIED",
"IMAGE_RICH_MEDIA",
"ADOBE_FLASH_FLV",
"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",
"CREATIVE_TYPE_HTML",
"CREATIVE_TYPE_VAST_VIDEO",
"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_FLASH",
"RICH_MEDIA_CAPABILITY_TYPE_HTML5",
"SKIPPABLE_INSTREAM_VIDEO",
"RICH_MEDIA_CAPABILITY_TYPE_SSL",
"RICH_MEDIA_CAPABILITY_TYPE_NON_SSL",
"RICH_MEDIA_CAPABILITY_TYPE_INTERSTITIAL",
"NON_SKIPPABLE_INSTREAM_VIDEO",
"NATIVE_ELIGIBILITY_ELIGIBLE",
"NON_VPAID",
"NATIVE_ELIGIBILITY_NOT_ELIGIBLE",
"ANY_INTERSTITIAL",
"NON_INTERSTITIAL",
"IN_BANNER_VIDEO",
"RENDERING_SIZELESS_ADX",
"OMSDK_1_0"
],
"type": "string",
"enumDescriptions": [
"Do not use. This is a placeholder value only.",
"The creative is of type image/rich media. For pretargeting.",
"The creative is of video type Adobe Flash FLV. For pretargeting.",
"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 type is HTML.",
"The creative type is VAST video.",
"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 Flash.",
"The creative is HTML5.",
"The creative has an instream VAST video type of skippable instream video. For pretargeting.",
"The creative is SSL.",
"The creative is non-SSL.",
"The creative is an interstitial.",
"The creative has an instream VAST video type of non-skippable instream video. For pretargeting.",
"The creative is eligible for native.",
"The creative has an instream VAST video type of non-VPAID. For pretargeting.",
"The creative is not eligible for native.",
"The creative has an interstitial size of any interstitial. For pretargeting.",
"The creative has an interstitial size of non interstitial. For pretargeting.",
"The video type is in-banner video.",
"The creative can dynamically resize to fill a variety of slot sizes.",
"The open measurement SDK is supported."
]
},
"description": "All declared attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. If the `excluded_attribute` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto\") contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction.",
"type": "array"
},
"name": {
"readOnly": true,
"description": "Output only. Name of the creative. Follows the pattern `buyers/{buyer}/creatives/{creative}`, where `{buyer}` represents the account ID of the buyer who owns the creative, and `{creative}` is the buyer-specific creative ID that references this creative in the bid response.",
"type": "string"
}
},
"description": "A creative and its classification data."
},
"StringTargetingDimension": {
"description": "Generic targeting with string values used in app, website and publisher targeting.",
"type": "object",
"properties": {
"values": {
"description": "The values specified.",
"items": {
"type": "string"
},
"type": "array"
},
"targetingMode": {
"type": "string",
"enumDescriptions": [
"Placeholder for undefined targeting mode.",
"The inclusive list type. Inventory must match an item in this list to be targeted.",
"The exclusive list type. Inventory must not match any item in this list to be targeted."
],
"description": "How the items in this list should be targeted.",
"enum": [
"TARGETING_MODE_UNSPECIFIED",
"INCLUSIVE",
"EXCLUSIVE"
]
}
},
"id": "StringTargetingDimension"
},
"WatchCreativesResponse": {
"properties": {
"topic": {
"type": "string",
"description": "The Pub/Sub topic that will be used to publish creative serving status notifications. This would be of the format `projects/{project_id}/topics/{topic_id}`."
},
"subscription": {
"type": "string",
"description": "The Pub/Sub subscription that can be used to pull creative status notifications. This would be of the format `projects/{project_id}/subscriptions/{subscription_id}`. Subscription is created with pull delivery. All service accounts belonging to the bidder will have read access to this subscription. Subscriptions that are inactive for more than 90 days will be disabled. Please use watchCreatives to re-enable the subscription."
}
},
"type": "object",
"description": "A response for the request to receive push notification when a bidder's creatives change status.",
"id": "WatchCreativesResponse"
}
},
"version_module": true,
"servicePath": "",
"protocol": "rest",
"version": "v1"
}