Google Git
Sign in
code / google-api-go-client / cb1f45ca288bfafb52ab824361c939d908e525ad / . / displayvideo / v1 / displayvideo-api.json
blob: 565a7dbdd16b4b071153a2896ad519eb04620dab [file] [log] [blame]
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/display-video": {
"description": "Create, see, edit, and permanently delete your Display \u0026 Video 360 entities and reports"
},
"https://www.googleapis.com/auth/doubleclickbidmanager": {
"description": "View and manage your reports in DoubleClick Bid Manager"
}
}
}
},
"basePath": "",
"baseUrl": "https://displayvideo.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Display Video",
"description": "Display \u0026 Video 360 API allows users to manage and create campaigns and reports.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/display-video/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "displayvideo:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://displayvideo.mtls.googleapis.com/",
"name": "displayvideo",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"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"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"advertisers": {
"methods": {
"bulkEditAdvertiserAssignedTargetingOptions": {
"description": "Bulk edits targeting options under a single advertiser.\nThe operation will delete the assigned targeting options provided in\nBulkEditAdvertiserAssignedTargetingOptionsRequest.delete_requests and\nthen create the assigned targeting options provided in\nBulkEditAdvertiserAssignedTargetingOptionsRequest.create_requests .",
"flatPath": "v1/advertisers/{advertisersId}:bulkEditAdvertiserAssignedTargetingOptions",
"httpMethod": "POST",
"id": "displayvideo.advertisers.bulkEditAdvertiserAssignedTargetingOptions",
"parameterOrder": [
"advertiserId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the advertiser.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}:bulkEditAdvertiserAssignedTargetingOptions",
"request": {
"$ref": "BulkEditAdvertiserAssignedTargetingOptionsRequest"
},
"response": {
"$ref": "BulkEditAdvertiserAssignedTargetingOptionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"bulkListAdvertiserAssignedTargetingOptions": {
"description": "Lists assigned targeting options of an advertiser across targeting types.",
"flatPath": "v1/advertisers/{advertisersId}:bulkListAdvertiserAssignedTargetingOptions",
"httpMethod": "GET",
"id": "displayvideo.advertisers.bulkListAdvertiserAssignedTargetingOptions",
"parameterOrder": [
"advertiserId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the advertiser the line item belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"filter": {
"description": "Allows filtering by assigned targeting option properties.\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by the logical operator `OR`..\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `EQUALS (=)`.\n* Supported fields:\n - `targetingType`\n\nExamples:\n\n* targetingType with value TARGETING_TYPE_CHANNEL\n`targetingType=\"TARGETING_TYPE_CHANNEL\"`\n\nThe length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Field by which to sort the list.\nAcceptable values are:\n\n* `targetingType` (default)\n\nThe default sorting order is ascending. To specify descending order for\na field, a suffix \"desc\" should be added to the field name. Example:\n`targetingType desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size.\nThe size must be an integer between `1` and `5000`. If unspecified,\nthe default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid\nvalue is specified.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token that lets the client fetch the next page of results.\nTypically, this is the value of\nnext_page_token\nreturned from the previous call to\n`BulkListAdvertiserAssignedTargetingOptions` method.\nIf not specified, the first page of results will be returned.",
"location": "query",
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}:bulkListAdvertiserAssignedTargetingOptions",
"response": {
"$ref": "BulkListAdvertiserAssignedTargetingOptionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"create": {
"description": "Creates a new advertiser.\nReturns the newly created advertiser if successful.\nThis method can take up to 180 seconds to complete.",
"flatPath": "v1/advertisers",
"httpMethod": "POST",
"id": "displayvideo.advertisers.create",
"parameterOrder": [],
"parameters": {},
"path": "v1/advertisers",
"request": {
"$ref": "Advertiser"
},
"response": {
"$ref": "Advertiser"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"delete": {
"description": "Deletes an advertiser.\nDeleting an advertiser will delete all of its child resources, for example,\ncampaigns, insertion orders and line items.\nA deleted advertiser cannot be recovered.",
"flatPath": "v1/advertisers/{advertisersId}",
"httpMethod": "DELETE",
"id": "displayvideo.advertisers.delete",
"parameterOrder": [
"advertiserId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser we need to delete.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"get": {
"description": "Gets an advertiser.",
"flatPath": "v1/advertisers/{advertisersId}",
"httpMethod": "GET",
"id": "displayvideo.advertisers.get",
"parameterOrder": [
"advertiserId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the advertiser to fetch.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}",
"response": {
"$ref": "Advertiser"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"list": {
"description": "Lists advertisers that are accessible to the current user.\n\nThe order is defined by the order_by\nparameter.\n\nA single partner_id is required.\nCross-partner listing is not supported.",
"flatPath": "v1/advertisers",
"httpMethod": "GET",
"id": "displayvideo.advertisers.list",
"parameterOrder": [],
"parameters": {
"filter": {
"description": "Allows filtering by advertiser properties.\n\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by `AND` or `OR` logical operators. A\nsequence of restrictions implicitly uses `AND`.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `EQUALS (=)`.\n* Supported fields:\n - `entityStatus`\n\nExamples:\n\n* All active advertisers under a partner:\n`entityStatus=\"ENTITY_STATUS_ACTIVE\"`\n\nThe length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Field by which to sort the list.\nAcceptable values are:\n\n* `displayName` (default)\n* `entityStatus`\n\nThe default sorting order is ascending. To specify descending order for\na field, a suffix \"desc\" should be added to the field name. For example,\n`displayName desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nnext_page_token\nreturned from the previous call to `ListAdvertisers` method.\nIf not specified, the first page of results will be returned.",
"location": "query",
"type": "string"
},
"partnerId": {
"description": "Required. The ID of the partner that the fetched advertisers should all belong to.\nThe system only supports listing advertisers for one partner at a time.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "v1/advertisers",
"response": {
"$ref": "ListAdvertisersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"patch": {
"description": "Updates an existing advertiser.\nReturns the updated advertiser if successful.",
"flatPath": "v1/advertisers/{advertisersId}",
"httpMethod": "PATCH",
"id": "displayvideo.advertisers.patch",
"parameterOrder": [
"advertiserId"
],
"parameters": {
"advertiserId": {
"description": "Output only. The unique ID of the advertiser. Assigned by the system.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The mask to control which fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}",
"request": {
"$ref": "Advertiser"
},
"response": {
"$ref": "Advertiser"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
},
"resources": {
"assets": {
"methods": {
"upload": {
"description": "Uploads an asset.\nReturns the ID of the newly uploaded asset if successful.\nThe asset file size should be no more than 10 MB for images, 200 MB for\nZIP files, and 1 GB for videos.",
"flatPath": "v1/advertisers/{advertisersId}/assets",
"httpMethod": "POST",
"id": "displayvideo.advertisers.assets.upload",
"mediaUpload": {
"accept": [
"*/*"
],
"protocols": {
"simple": {
"multipart": true,
"path": "/upload/v1/advertisers/{+advertiserId}/assets"
}
}
},
"parameterOrder": [
"advertiserId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the advertiser this asset belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/assets",
"request": {
"$ref": "CreateAssetRequest"
},
"response": {
"$ref": "CreateAssetResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
],
"supportsMediaUpload": true
}
}
},
"campaigns": {
"methods": {
"create": {
"description": "Creates a new campaign.\nReturns the newly created campaign if successful.",
"flatPath": "v1/advertisers/{advertisersId}/campaigns",
"httpMethod": "POST",
"id": "displayvideo.advertisers.campaigns.create",
"parameterOrder": [
"advertiserId"
],
"parameters": {
"advertiserId": {
"description": "Output only. The unique ID of the advertiser the campaign belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/campaigns",
"request": {
"$ref": "Campaign"
},
"response": {
"$ref": "Campaign"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"delete": {
"description": "Permanently deletes a campaign. A deleted campaign cannot be recovered.\nThe campaign should be archived first, i.e. set\nentity_status to `ENTITY_STATUS_ARCHIVED`, to be\nable to delete it.",
"flatPath": "v1/advertisers/{advertisersId}/campaigns/{campaignsId}",
"httpMethod": "DELETE",
"id": "displayvideo.advertisers.campaigns.delete",
"parameterOrder": [
"advertiserId",
"campaignId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser this campaign belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"campaignId": {
"description": "The ID of the campaign we need to delete.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/campaigns/{+campaignId}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"get": {
"description": "Gets a campaign.",
"flatPath": "v1/advertisers/{advertisersId}/campaigns/{campaignsId}",
"httpMethod": "GET",
"id": "displayvideo.advertisers.campaigns.get",
"parameterOrder": [
"advertiserId",
"campaignId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the advertiser this campaign belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"campaignId": {
"description": "Required. The ID of the campaign to fetch.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/campaigns/{+campaignId}",
"response": {
"$ref": "Campaign"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"list": {
"description": "Lists campaigns in an advertiser.\n\nThe order is defined by the order_by\nparameter.\nIf a filter by\nentity_status is not specified, campaigns with\n`ENTITY_STATUS_ARCHIVED` will not be included in the results.",
"flatPath": "v1/advertisers/{advertisersId}/campaigns",
"httpMethod": "GET",
"id": "displayvideo.advertisers.campaigns.list",
"parameterOrder": [
"advertiserId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser to list campaigns for.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"filter": {
"description": "Allows filtering by campaign properties.\n\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by `AND` or `OR` logical operators. A\nsequence of restrictions implicitly uses `AND`.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `EQUALS (=)`.\n* Supported fields:\n - `entityStatus`\n\nExamples:\n\n* All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an\nadvertiser:\n`(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR\nentityStatus=\"ENTITY_STATUS_PAUSED\")`\n\nThe length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Field by which to sort the list.\nAcceptable values are:\n\n* `displayName` (default)\n* `entityStatus`\n\nThe default sorting order is ascending. To specify descending order for\na field, a suffix \"desc\" should be added to the field name. Example:\n`displayName desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nnext_page_token returned from the\nprevious call to `ListCampaigns` method. If not specified, the first page\nof results will be returned.",
"location": "query",
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/campaigns",
"response": {
"$ref": "ListCampaignsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"patch": {
"description": "Updates an existing campaign.\nReturns the updated campaign if successful.",
"flatPath": "v1/advertisers/{advertisersId}/campaigns/{campaignsId}",
"httpMethod": "PATCH",
"id": "displayvideo.advertisers.campaigns.patch",
"parameterOrder": [
"advertiserId",
"campaignId"
],
"parameters": {
"advertiserId": {
"description": "Output only. The unique ID of the advertiser the campaign belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"campaignId": {
"description": "Output only. The unique ID of the campaign. Assigned by the system.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The mask to control which fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/campaigns/{+campaignId}",
"request": {
"$ref": "Campaign"
},
"response": {
"$ref": "Campaign"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
}
},
"channels": {
"methods": {
"create": {
"description": "Creates a new channel. Returns the newly created channel if successful.",
"flatPath": "v1/advertisers/{advertisersId}/channels",
"httpMethod": "POST",
"id": "displayvideo.advertisers.channels.create",
"parameterOrder": [
"advertiserId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that owns the created channel.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that owns the created channel.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/channels",
"request": {
"$ref": "Channel"
},
"response": {
"$ref": "Channel"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"get": {
"description": "Gets a channel for a partner or advertiser.",
"flatPath": "v1/advertisers/{advertisersId}/channels/{channelsId}",
"httpMethod": "GET",
"id": "displayvideo.advertisers.channels.get",
"parameterOrder": [
"advertiserId",
"channelId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that owns the fetched channel.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"channelId": {
"description": "Required. The ID of the channel to fetch.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that owns the fetched channel.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/channels/{+channelId}",
"response": {
"$ref": "Channel"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"list": {
"description": "Lists channels for a partner or advertiser.",
"flatPath": "v1/advertisers/{advertisersId}/channels",
"httpMethod": "GET",
"id": "displayvideo.advertisers.channels.list",
"parameterOrder": [
"advertiserId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that owns the channels.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"filter": {
"description": "Allows filtering by channel fields.\n\nSupported syntax:\n\n* Filter expressions for channel currently can only contain at most one\n* restriction.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `CONTAINS (:)`.\n* Supported fields:\n - `displayName`\n\nExamples:\n\n* All channels for which the display name contains \"google\":\n`displayName : \"google\"`.\n\nThe length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Field by which to sort the list.\nAcceptable values are:\n\n* `displayName` (default)\n* `channelId`\n\nThe default sorting order is ascending. To specify descending order for a\nfield, a suffix \" desc\" should be added to the field name. Example:\n`displayName desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value\nis specified.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nnext_page_token returned from the\nprevious call to `ListChannels` method. If not specified, the first page\nof results will be returned.",
"location": "query",
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that owns the channels.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/channels",
"response": {
"$ref": "ListChannelsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"patch": {
"description": "Updates a channel. Returns the updated channel if successful.",
"flatPath": "v1/advertisers/{advertisersId}/channels/{channelId}",
"httpMethod": "PATCH",
"id": "displayvideo.advertisers.channels.patch",
"parameterOrder": [
"advertiserId",
"channelId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that owns the created channel.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"channelId": {
"description": "Output only. The unique ID of the channel. Assigned by the system.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that owns the created channel.",
"format": "int64",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "Required. The mask to control which fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/channels/{channelId}",
"request": {
"$ref": "Channel"
},
"response": {
"$ref": "Channel"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
},
"resources": {
"sites": {
"methods": {
"bulkEdit": {
"description": "Bulk edits sites under a single channel.\n\nThe operation will delete the sites provided in\nBulkEditSitesRequest.deleted_sites and then create the sites\nprovided in BulkEditSitesRequest.created_sites.",
"flatPath": "v1/advertisers/{advertiserId}/channels/{channelsId}/sites:bulkEdit",
"httpMethod": "POST",
"id": "displayvideo.advertisers.channels.sites.bulkEdit",
"parameterOrder": [
"advertiserId",
"channelId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that owns the parent channel.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"channelId": {
"description": "Required. The ID of the parent channel to which the sites belong.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{advertiserId}/channels/{+channelId}/sites:bulkEdit",
"request": {
"$ref": "BulkEditSitesRequest"
},
"response": {
"$ref": "BulkEditSitesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"create": {
"description": "Creates a site in a channel.",
"flatPath": "v1/advertisers/{advertiserId}/channels/{channelsId}/sites",
"httpMethod": "POST",
"id": "displayvideo.advertisers.channels.sites.create",
"parameterOrder": [
"advertiserId",
"channelId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that owns the parent channel.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"channelId": {
"description": "Required. The ID of the parent channel in which the site will be created.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that owns the parent channel.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "v1/advertisers/{advertiserId}/channels/{+channelId}/sites",
"request": {
"$ref": "Site"
},
"response": {
"$ref": "Site"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"delete": {
"description": "Deletes a site from a channel.",
"flatPath": "v1/advertisers/{advertiserId}/channels/{channelsId}/sites/{sitesId}",
"httpMethod": "DELETE",
"id": "displayvideo.advertisers.channels.sites.delete",
"parameterOrder": [
"advertiserId",
"channelId",
"urlOrAppId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that owns the parent channel.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"channelId": {
"description": "Required. The ID of the parent channel to which the site belongs.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that owns the parent channel.",
"format": "int64",
"location": "query",
"type": "string"
},
"urlOrAppId": {
"description": "Required. The URL or app ID of the site to delete.",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"list": {
"description": "Lists sites in a channel.",
"flatPath": "v1/advertisers/{advertisersId}/channels/{channelsId}/sites",
"httpMethod": "GET",
"id": "displayvideo.advertisers.channels.sites.list",
"parameterOrder": [
"advertiserId",
"channelId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that owns the parent channel.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"channelId": {
"description": "Required. The ID of the parent channel to which the requested sites belong.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"filter": {
"description": "Allows filtering by site fields.\n\nSupported syntax:\n\n* Filter expressions for site currently can only contain at most one\n* restriction.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `CONTAINS (:)`.\n* Supported fields:\n - `urlOrAppId`\n\nExamples:\n\n* All sites for which the URL or app ID contains \"google\":\n`urlOrAppId : \"google\"`",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Field by which to sort the list.\nAcceptable values are:\n\n* `urlOrAppId` (default)\n\nThe default sorting order is ascending. To specify descending order for a\nfield, a suffix \" desc\" should be added to the field name. Example:\n`urlOrAppId desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value\nis specified.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.\n\nTypically, this is the value of\nnext_page_token returned from the\nprevious call to `ListSites` method. If not specified, the first page\nof results will be returned.",
"location": "query",
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that owns the parent channel.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/channels/{+channelId}/sites",
"response": {
"$ref": "ListSitesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
}
}
}
},
"creatives": {
"methods": {
"create": {
"description": "Creates a new creative.\nReturns the newly created creative if successful.",
"flatPath": "v1/advertisers/{advertisersId}/creatives",
"httpMethod": "POST",
"id": "displayvideo.advertisers.creatives.create",
"parameterOrder": [
"advertiserId"
],
"parameters": {
"advertiserId": {
"description": "Output only. The unique ID of the advertiser the creative belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/creatives",
"request": {
"$ref": "Creative"
},
"response": {
"$ref": "Creative"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"delete": {
"description": "Deletes a creative.\nReturns error code `NOT_FOUND` if the creative does not exist.\nThe creative should be archived first, i.e. set\nentity_status to `ENTITY_STATUS_ARCHIVED`, before\nit can be deleted.",
"flatPath": "v1/advertisers/{advertisersId}/creatives/{creativesId}",
"httpMethod": "DELETE",
"id": "displayvideo.advertisers.creatives.delete",
"parameterOrder": [
"advertiserId",
"creativeId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser this creative belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"creativeId": {
"description": "The ID of the creative to be deleted.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/creatives/{+creativeId}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"get": {
"description": "Gets a creative.",
"flatPath": "v1/advertisers/{advertisersId}/creatives/{creativesId}",
"httpMethod": "GET",
"id": "displayvideo.advertisers.creatives.get",
"parameterOrder": [
"advertiserId",
"creativeId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the advertiser this creative belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"creativeId": {
"description": "Required. The ID of the creative to fetch.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/creatives/{+creativeId}",
"response": {
"$ref": "Creative"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"list": {
"description": "Lists creatives in an advertiser.\n\nThe order is defined by the order_by\nparameter.\nIf a filter by\nentity_status is not specified, creatives with\n`ENTITY_STATUS_ARCHIVED` will not be included in the results.",
"flatPath": "v1/advertisers/{advertisersId}/creatives",
"httpMethod": "GET",
"id": "displayvideo.advertisers.creatives.list",
"parameterOrder": [
"advertiserId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the advertiser to list creatives for.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"filter": {
"description": "Allows filtering by creative properties.\n\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restriction for the same field must be combined by `OR`.\n* Restriction for different fields must be combined by `AND`.\n* Between `(` and `)` there can only be restrictions combined by `OR`\nfor the same field.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `EQUALS (=)` for the following fields:\n - `entityStatus`\n - `creativeType`.\n - `dimensions`\n - `minDuration`\n - `maxDuration`\n - `approvalStatus`\n - `exchangeReviewStatus`\n - `dynamic`\n - `creativeId`\n* The operator must be `HAS (:)` for the following fields:\n - `lineItemIds`\n* For `entityStatus`, `minDuration`, `maxDuration`, and `dynamic` there may\nbe at most one restriction.\n* For `dimensions`, the value is in the form of `\"{width}x{height}\"`.\n* For `exchangeReviewStatus`, the value is in the form of\n`{exchange}-{reviewStatus}`.\n* For `minDuration` and `maxDuration`, the value is in the form of\n`\"{duration}s\"`. Only seconds are supported with millisecond granularity.\n* There may be multiple `lineItemIds` restrictions in order to search\nagainst multiple possible line item IDs.\n* There may be multiple `creativeId` restrictions in order to search\nagainst multiple possible creative IDs.\n\nExamples:\n\n* All native creatives: `creativeType=\"CREATIVE_TYPE_NATIVE\"`\n* All active creatives with 300x400 or 50x100 dimensions:\n`entityStatus=\"ENTITY_STATUS_ACTIVE\" AND (dimensions=\"300x400\"\nOR dimensions=\"50x100\")`\n* All dynamic creatives that are approved by AdX or\nAppNexus, with a minimum duration of 5 seconds and 200ms.\n`dynamic=\"true\" AND minDuration=\"5.2s\" AND\n(exchangeReviewStatus=\"EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED\"\nOR exchangeReviewStatus=\"EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED\")`\n* All video creatives that are associated with line item ID 1 or 2:\n`creativeType=\"CREATIVE_TYPE_VIDEO\" AND (lineItemIds:1 OR lineItemIds:2)`\n* Find creatives by multiple creative IDs:\n`creativeId=1 OR creativeId=2`\n\nThe length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Field by which to sort the list.\nAcceptable values are:\n\n* `creativeId` (default)\n* `createTime`\n* `mediaDuration`\n* `dimensions` (sorts by width first, then by height)\n\nThe default sorting order is ascending. To specify descending order for\na field, a suffix \"desc\" should be added to the field name.\nExample: `createTime desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value\nis specified.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nnext_page_token\nreturned from the previous call to `ListCreatives` method.\nIf not specified, the first page of results will be returned.",
"location": "query",
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/creatives",
"response": {
"$ref": "ListCreativesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"patch": {
"description": "Updates an existing creative.\nReturns the updated creative if successful.",
"flatPath": "v1/advertisers/{advertisersId}/creatives/{creativesId}",
"httpMethod": "PATCH",
"id": "displayvideo.advertisers.creatives.patch",
"parameterOrder": [
"advertiserId",
"creativeId"
],
"parameters": {
"advertiserId": {
"description": "Output only. The unique ID of the advertiser the creative belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"creativeId": {
"description": "Output only. The unique ID of the creative. Assigned by the system.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The mask to control which fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/creatives/{+creativeId}",
"request": {
"$ref": "Creative"
},
"response": {
"$ref": "Creative"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
}
},
"insertionOrders": {
"methods": {
"create": {
"description": "Creates a new insertion order.\nReturns the newly created insertion order if successful.",
"flatPath": "v1/advertisers/{advertisersId}/insertionOrders",
"httpMethod": "POST",
"id": "displayvideo.advertisers.insertionOrders.create",
"parameterOrder": [
"advertiserId"
],
"parameters": {
"advertiserId": {
"description": "Output only. The unique ID of the advertiser the insertion order belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/insertionOrders",
"request": {
"$ref": "InsertionOrder"
},
"response": {
"$ref": "InsertionOrder"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"delete": {
"description": "Deletes an insertion order.\nReturns error code `NOT_FOUND` if the insertion order does not exist.\nThe insertion order should be archived first, i.e. set\nentity_status to `ENTITY_STATUS_ARCHIVED`,\nto be able to delete it.",
"flatPath": "v1/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}",
"httpMethod": "DELETE",
"id": "displayvideo.advertisers.insertionOrders.delete",
"parameterOrder": [
"advertiserId",
"insertionOrderId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser this insertion order belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"insertionOrderId": {
"description": "The ID of the insertion order we need to delete.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"get": {
"description": "Gets an insertion order.\nReturns error code `NOT_FOUND` if the insertion order does not exist.",
"flatPath": "v1/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}",
"httpMethod": "GET",
"id": "displayvideo.advertisers.insertionOrders.get",
"parameterOrder": [
"advertiserId",
"insertionOrderId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the advertiser this insertion order belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"insertionOrderId": {
"description": "Required. The ID of the insertion order to fetch.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}",
"response": {
"$ref": "InsertionOrder"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"list": {
"description": "Lists insertion orders in an advertiser.\n\nThe order is defined by the order_by\nparameter.\nIf a filter by\nentity_status is not specified, insertion\norders with `ENTITY_STATUS_ARCHIVED` will not be included in the results.",
"flatPath": "v1/advertisers/{advertisersId}/insertionOrders",
"httpMethod": "GET",
"id": "displayvideo.advertisers.insertionOrders.list",
"parameterOrder": [
"advertiserId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the advertiser to list insertion orders for.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"filter": {
"description": "Allows filtering by insertion order properties.\n\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by `AND` or `OR` logical operators. A\nsequence of restrictions implicitly uses `AND`.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `EQUALS (=)`.\n* Supported fields:\n - `campaignId`\n - `entityStatus`\n\nExamples:\n\n* All insertion orders under a campaign: `campaignId=\"1234\"`\n* All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders\nunder an advertiser:\n`(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR\nentityStatus=\"ENTITY_STATUS_PAUSED\")`\n\nThe length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Field by which to sort the list.\nAcceptable values are:\n\n* \"displayName\" (default)\n* \"entityStatus\"\n\nThe default sorting order is ascending. To specify descending order for\na field, a suffix \"desc\" should be added to the field name. Example:\n`displayName desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value\nis specified.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nnext_page_token returned\nfrom the previous call to `ListInsertionOrders` method. If not specified,\nthe first page of results will be returned.",
"location": "query",
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/insertionOrders",
"response": {
"$ref": "ListInsertionOrdersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"patch": {
"description": "Updates an existing insertion order.\nReturns the updated insertion order if successful.",
"flatPath": "v1/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}",
"httpMethod": "PATCH",
"id": "displayvideo.advertisers.insertionOrders.patch",
"parameterOrder": [
"advertiserId",
"insertionOrderId"
],
"parameters": {
"advertiserId": {
"description": "Output only. The unique ID of the advertiser the insertion order belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"insertionOrderId": {
"description": "Output only. The unique ID of the insertion order. Assigned by the system.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The mask to control which fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}",
"request": {
"$ref": "InsertionOrder"
},
"response": {
"$ref": "InsertionOrder"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
}
},
"lineItems": {
"methods": {
"bulkEditLineItemAssignedTargetingOptions": {
"description": "Bulk edits targeting options under a single line item.\nThe operation will delete the assigned targeting options provided in\nBulkEditLineItemAssignedTargetingOptionsRequest.delete_requests and\nthen create the assigned targeting options provided in\nBulkEditLineItemAssignedTargetingOptionsRequest.create_requests .",
"flatPath": "v1/advertisers/{advertisersId}/lineItems/{lineItemsId}:bulkEditLineItemAssignedTargetingOptions",
"httpMethod": "POST",
"id": "displayvideo.advertisers.lineItems.bulkEditLineItemAssignedTargetingOptions",
"parameterOrder": [
"advertiserId",
"lineItemId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the advertiser the line item belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"lineItemId": {
"description": "Required. The ID of the line item the assigned targeting option will belong to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}:bulkEditLineItemAssignedTargetingOptions",
"request": {
"$ref": "BulkEditLineItemAssignedTargetingOptionsRequest"
},
"response": {
"$ref": "BulkEditLineItemAssignedTargetingOptionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"bulkListLineItemAssignedTargetingOptions": {
"description": "Lists assigned targeting options of a line item across targeting types.",
"flatPath": "v1/advertisers/{advertisersId}/lineItems/{lineItemsId}:bulkListLineItemAssignedTargetingOptions",
"httpMethod": "GET",
"id": "displayvideo.advertisers.lineItems.bulkListLineItemAssignedTargetingOptions",
"parameterOrder": [
"advertiserId",
"lineItemId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the advertiser the line item belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"filter": {
"description": "Allows filtering by assigned targeting option properties.\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by the logical operator `OR` on the same\nfield.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `EQUALS (=)`.\n* Supported fields:\n - `targetingType`\n - `inheritance`\n\nExamples:\n\n* AssignedTargetingOptions of targeting type\nTARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL\n`targetingType=\"TARGETING_TYPE_PROXIMITY_LOCATION_LIST\" OR\ntargetingType=\"TARGETING_TYPE_CHANNEL\"`\n* AssignedTargetingOptions with inheritance status of NOT_INHERITED or\n INHERITED_FROM_PARTNER\n`inheritance=\"NOT_INHERITED\" OR inheritance=\"INHERITED_FROM_PARTNER\"`\n\nThe length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"lineItemId": {
"description": "Required. The ID of the line item to list assigned targeting options for.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"orderBy": {
"description": "Field by which to sort the list.\nAcceptable values are:\n\n* `targetingType` (default)\n\nThe default sorting order is ascending. To specify descending order for\na field, a suffix \"desc\" should be added to the field name. Example:\n`targetingType desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size.\nThe size must be an integer between `1` and `5000`. If unspecified,\nthe default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid\nvalue is specified.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token that lets the client fetch the next page of results.\nTypically, this is the value of\nnext_page_token\nreturned from the previous call to\n`BulkListLineItemAssignedTargetingOptions` method.\nIf not specified, the first page of results will be returned.",
"location": "query",
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}:bulkListLineItemAssignedTargetingOptions",
"response": {
"$ref": "BulkListLineItemAssignedTargetingOptionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"create": {
"description": "Creates a new line item.\nReturns the newly created line item if successful.",
"flatPath": "v1/advertisers/{advertisersId}/lineItems",
"httpMethod": "POST",
"id": "displayvideo.advertisers.lineItems.create",
"parameterOrder": [
"advertiserId"
],
"parameters": {
"advertiserId": {
"description": "Output only. The unique ID of the advertiser the line item belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/lineItems",
"request": {
"$ref": "LineItem"
},
"response": {
"$ref": "LineItem"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"delete": {
"description": "Deletes a line item.\nReturns error code `NOT_FOUND` if the line item does not exist.\nThe line item should be archived first, i.e. set\nentity_status to `ENTITY_STATUS_ARCHIVED`, to be\nable to delete it.",
"flatPath": "v1/advertisers/{advertisersId}/lineItems/{lineItemsId}",
"httpMethod": "DELETE",
"id": "displayvideo.advertisers.lineItems.delete",
"parameterOrder": [
"advertiserId",
"lineItemId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser this line item belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"lineItemId": {
"description": "The ID of the line item we need to fetch.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"get": {
"description": "Gets a line item.",
"flatPath": "v1/advertisers/{advertisersId}/lineItems/{lineItemsId}",
"httpMethod": "GET",
"id": "displayvideo.advertisers.lineItems.get",
"parameterOrder": [
"advertiserId",
"lineItemId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the advertiser this line item belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"lineItemId": {
"description": "Required. The ID of the line item to fetch.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}",
"response": {
"$ref": "LineItem"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"list": {
"description": "Lists line items in an advertiser.\n\nThe order is defined by the order_by\nparameter.\nIf a filter by\nentity_status is not specified, line items with\n`ENTITY_STATUS_ARCHIVED` will not be included in the results.",
"flatPath": "v1/advertisers/{advertisersId}/lineItems",
"httpMethod": "GET",
"id": "displayvideo.advertisers.lineItems.list",
"parameterOrder": [
"advertiserId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the advertiser to list line items for.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"filter": {
"description": "Allows filtering by line item properties.\n\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by `AND` or `OR` logical operators. A\nsequence of restrictions implicitly uses `AND`.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `EQUALS (=)`.\n* Supported fields:\n - `campaignId`\n - `insertionOrderId`\n - `entityStatus`\n - `lineItemType`.\n\nExamples:\n\n* All line items under an insertion order: `insertionOrderId=\"1234\"`\n* All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`\nand `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser:\n`(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR\nentityStatus=\"ENTITY_STATUS_PAUSED\") AND\nlineItemType=\"LINE_ITEM_TYPE_DISPLAY_DEFAULT\"`\n\nThe length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Field by which to sort the list.\nAcceptable values are:\n\n* \"displayName\" (default)\n* \"entityStatus\"\n\nThe default sorting order is ascending. To specify descending order for\na field, a suffix \"desc\" should be added to the field name. Example:\n`displayName desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value\nis specified.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nnext_page_token\nreturned from the previous call to `ListLineItems` method.\nIf not specified, the first page of results will be returned.",
"location": "query",
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/lineItems",
"response": {
"$ref": "ListLineItemsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"patch": {
"description": "Updates an existing line item.\nReturns the updated line item if successful.",
"flatPath": "v1/advertisers/{advertisersId}/lineItems/{lineItemsId}",
"httpMethod": "PATCH",
"id": "displayvideo.advertisers.lineItems.patch",
"parameterOrder": [
"advertiserId",
"lineItemId"
],
"parameters": {
"advertiserId": {
"description": "Output only. The unique ID of the advertiser the line item belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"lineItemId": {
"description": "Output only. The unique ID of the line item. Assigned by the system.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The mask to control which fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}",
"request": {
"$ref": "LineItem"
},
"response": {
"$ref": "LineItem"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
},
"resources": {
"targetingTypes": {
"resources": {
"assignedTargetingOptions": {
"methods": {
"create": {
"description": "Assigns a targeting option to a line item.\nReturns the assigned targeting option if successful.",
"flatPath": "v1/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions",
"httpMethod": "POST",
"id": "displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create",
"parameterOrder": [
"advertiserId",
"lineItemId",
"targetingType"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the advertiser the line item belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"lineItemId": {
"description": "Required. The ID of the line item the assigned targeting option will belong to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"targetingType": {
"description": "Required. Identifies the type of this assigned targeting option.",
"enum": [
"TARGETING_TYPE_UNSPECIFIED",
"TARGETING_TYPE_CHANNEL",
"TARGETING_TYPE_APP_CATEGORY",
"TARGETING_TYPE_APP",
"TARGETING_TYPE_URL",
"TARGETING_TYPE_DAY_AND_TIME",
"TARGETING_TYPE_AGE_RANGE",
"TARGETING_TYPE_REGIONAL_LOCATION_LIST",
"TARGETING_TYPE_PROXIMITY_LOCATION_LIST",
"TARGETING_TYPE_GENDER",
"TARGETING_TYPE_VIDEO_PLAYER_SIZE",
"TARGETING_TYPE_USER_REWARDED_CONTENT",
"TARGETING_TYPE_PARENTAL_STATUS",
"TARGETING_TYPE_CONTENT_INSTREAM_POSITION",
"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION",
"TARGETING_TYPE_DEVICE_TYPE",
"TARGETING_TYPE_AUDIENCE_GROUP",
"TARGETING_TYPE_BROWSER",
"TARGETING_TYPE_HOUSEHOLD_INCOME",
"TARGETING_TYPE_ON_SCREEN_POSITION",
"TARGETING_TYPE_THIRD_PARTY_VERIFIER",
"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION",
"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION",
"TARGETING_TYPE_ENVIRONMENT",
"TARGETING_TYPE_CARRIER_AND_ISP",
"TARGETING_TYPE_OPERATING_SYSTEM",
"TARGETING_TYPE_DEVICE_MAKE_MODEL",
"TARGETING_TYPE_KEYWORD",
"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST",
"TARGETING_TYPE_VIEWABILITY",
"TARGETING_TYPE_CATEGORY",
"TARGETING_TYPE_INVENTORY_SOURCE",
"TARGETING_TYPE_LANGUAGE",
"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS",
"TARGETING_TYPE_GEO_REGION",
"TARGETING_TYPE_INVENTORY_SOURCE_GROUP",
"TARGETING_TYPE_EXCHANGE",
"TARGETING_TYPE_SUB_EXCHANGE"
],
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions",
"request": {
"$ref": "AssignedTargetingOption"
},
"response": {
"$ref": "AssignedTargetingOption"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"delete": {
"description": "Deletes an assigned targeting option from a line item.",
"flatPath": "v1/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}",
"httpMethod": "DELETE",
"id": "displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete",
"parameterOrder": [
"advertiserId",
"lineItemId",
"targetingType",
"assignedTargetingOptionId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the advertiser the line item belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"assignedTargetingOptionId": {
"description": "Required. The ID of the assigned targeting option to delete.",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"lineItemId": {
"description": "Required. The ID of the line item the assigned targeting option belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"targetingType": {
"description": "Required. Identifies the type of this assigned targeting option.",
"enum": [
"TARGETING_TYPE_UNSPECIFIED",
"TARGETING_TYPE_CHANNEL",
"TARGETING_TYPE_APP_CATEGORY",
"TARGETING_TYPE_APP",
"TARGETING_TYPE_URL",
"TARGETING_TYPE_DAY_AND_TIME",
"TARGETING_TYPE_AGE_RANGE",
"TARGETING_TYPE_REGIONAL_LOCATION_LIST",
"TARGETING_TYPE_PROXIMITY_LOCATION_LIST",
"TARGETING_TYPE_GENDER",
"TARGETING_TYPE_VIDEO_PLAYER_SIZE",
"TARGETING_TYPE_USER_REWARDED_CONTENT",
"TARGETING_TYPE_PARENTAL_STATUS",
"TARGETING_TYPE_CONTENT_INSTREAM_POSITION",
"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION",
"TARGETING_TYPE_DEVICE_TYPE",
"TARGETING_TYPE_AUDIENCE_GROUP",
"TARGETING_TYPE_BROWSER",
"TARGETING_TYPE_HOUSEHOLD_INCOME",
"TARGETING_TYPE_ON_SCREEN_POSITION",
"TARGETING_TYPE_THIRD_PARTY_VERIFIER",
"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION",
"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION",
"TARGETING_TYPE_ENVIRONMENT",
"TARGETING_TYPE_CARRIER_AND_ISP",
"TARGETING_TYPE_OPERATING_SYSTEM",
"TARGETING_TYPE_DEVICE_MAKE_MODEL",
"TARGETING_TYPE_KEYWORD",
"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST",
"TARGETING_TYPE_VIEWABILITY",
"TARGETING_TYPE_CATEGORY",
"TARGETING_TYPE_INVENTORY_SOURCE",
"TARGETING_TYPE_LANGUAGE",
"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS",
"TARGETING_TYPE_GEO_REGION",
"TARGETING_TYPE_INVENTORY_SOURCE_GROUP",
"TARGETING_TYPE_EXCHANGE",
"TARGETING_TYPE_SUB_EXCHANGE"
],
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"get": {
"description": "Gets a single targeting option assigned to a line item.",
"flatPath": "v1/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}",
"httpMethod": "GET",
"id": "displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get",
"parameterOrder": [
"advertiserId",
"lineItemId",
"targetingType",
"assignedTargetingOptionId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the advertiser the line item belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"assignedTargetingOptionId": {
"description": "Required. An identifier unique to the targeting type in this line item that\nidentifies the assigned targeting option being requested.",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"lineItemId": {
"description": "Required. The ID of the line item the assigned targeting option belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"targetingType": {
"description": "Required. Identifies the type of this assigned targeting option.",
"enum": [
"TARGETING_TYPE_UNSPECIFIED",
"TARGETING_TYPE_CHANNEL",
"TARGETING_TYPE_APP_CATEGORY",
"TARGETING_TYPE_APP",
"TARGETING_TYPE_URL",
"TARGETING_TYPE_DAY_AND_TIME",
"TARGETING_TYPE_AGE_RANGE",
"TARGETING_TYPE_REGIONAL_LOCATION_LIST",
"TARGETING_TYPE_PROXIMITY_LOCATION_LIST",
"TARGETING_TYPE_GENDER",
"TARGETING_TYPE_VIDEO_PLAYER_SIZE",
"TARGETING_TYPE_USER_REWARDED_CONTENT",
"TARGETING_TYPE_PARENTAL_STATUS",
"TARGETING_TYPE_CONTENT_INSTREAM_POSITION",
"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION",
"TARGETING_TYPE_DEVICE_TYPE",
"TARGETING_TYPE_AUDIENCE_GROUP",
"TARGETING_TYPE_BROWSER",
"TARGETING_TYPE_HOUSEHOLD_INCOME",
"TARGETING_TYPE_ON_SCREEN_POSITION",
"TARGETING_TYPE_THIRD_PARTY_VERIFIER",
"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION",
"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION",
"TARGETING_TYPE_ENVIRONMENT",
"TARGETING_TYPE_CARRIER_AND_ISP",
"TARGETING_TYPE_OPERATING_SYSTEM",
"TARGETING_TYPE_DEVICE_MAKE_MODEL",
"TARGETING_TYPE_KEYWORD",
"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST",
"TARGETING_TYPE_VIEWABILITY",
"TARGETING_TYPE_CATEGORY",
"TARGETING_TYPE_INVENTORY_SOURCE",
"TARGETING_TYPE_LANGUAGE",
"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS",
"TARGETING_TYPE_GEO_REGION",
"TARGETING_TYPE_INVENTORY_SOURCE_GROUP",
"TARGETING_TYPE_EXCHANGE",
"TARGETING_TYPE_SUB_EXCHANGE"
],
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}",
"response": {
"$ref": "AssignedTargetingOption"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"list": {
"description": "Lists the targeting options assigned to a line item.",
"flatPath": "v1/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions",
"httpMethod": "GET",
"id": "displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list",
"parameterOrder": [
"advertiserId",
"lineItemId",
"targetingType"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the advertiser the line item belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"filter": {
"description": "Allows filtering by assigned targeting option properties.\n\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by the logical operator `OR`.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `EQUALS (=)`.\n* Supported fields:\n - `assignedTargetingOptionId`\n - `inheritance`\n\nExamples:\n\n* AssignedTargetingOptions with ID 1 or 2\n`assignedTargetingOptionId=\"1\" OR assignedTargetingOptionId=\"2\"`\n* AssignedTargetingOptions with inheritance status of NOT_INHERITED or\n INHERITED_FROM_PARTNER\n`inheritance=\"NOT_INHERITED\" OR inheritance=\"INHERITED_FROM_PARTNER\"`\n\nThe length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"lineItemId": {
"description": "Required. The ID of the line item to list assigned targeting options for.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"orderBy": {
"description": "Field by which to sort the list.\nAcceptable values are:\n\n* `assignedTargetingOptionId` (default)\n\nThe default sorting order is ascending. To specify descending order for\na field, a suffix \"desc\" should be added to the field name. Example:\n`assignedTargetingOptionId desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value\nis specified.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nnext_page_token\nreturned from the previous call to `ListLineItemAssignedTargetingOptions`\nmethod. If not specified, the first page of results will be returned.",
"location": "query",
"type": "string"
},
"targetingType": {
"description": "Required. Identifies the type of assigned targeting options to list.",
"enum": [
"TARGETING_TYPE_UNSPECIFIED",
"TARGETING_TYPE_CHANNEL",
"TARGETING_TYPE_APP_CATEGORY",
"TARGETING_TYPE_APP",
"TARGETING_TYPE_URL",
"TARGETING_TYPE_DAY_AND_TIME",
"TARGETING_TYPE_AGE_RANGE",
"TARGETING_TYPE_REGIONAL_LOCATION_LIST",
"TARGETING_TYPE_PROXIMITY_LOCATION_LIST",
"TARGETING_TYPE_GENDER",
"TARGETING_TYPE_VIDEO_PLAYER_SIZE",
"TARGETING_TYPE_USER_REWARDED_CONTENT",
"TARGETING_TYPE_PARENTAL_STATUS",
"TARGETING_TYPE_CONTENT_INSTREAM_POSITION",
"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION",
"TARGETING_TYPE_DEVICE_TYPE",
"TARGETING_TYPE_AUDIENCE_GROUP",
"TARGETING_TYPE_BROWSER",
"TARGETING_TYPE_HOUSEHOLD_INCOME",
"TARGETING_TYPE_ON_SCREEN_POSITION",
"TARGETING_TYPE_THIRD_PARTY_VERIFIER",
"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION",
"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION",
"TARGETING_TYPE_ENVIRONMENT",
"TARGETING_TYPE_CARRIER_AND_ISP",
"TARGETING_TYPE_OPERATING_SYSTEM",
"TARGETING_TYPE_DEVICE_MAKE_MODEL",
"TARGETING_TYPE_KEYWORD",
"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST",
"TARGETING_TYPE_VIEWABILITY",
"TARGETING_TYPE_CATEGORY",
"TARGETING_TYPE_INVENTORY_SOURCE",
"TARGETING_TYPE_LANGUAGE",
"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS",
"TARGETING_TYPE_GEO_REGION",
"TARGETING_TYPE_INVENTORY_SOURCE_GROUP",
"TARGETING_TYPE_EXCHANGE",
"TARGETING_TYPE_SUB_EXCHANGE"
],
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions",
"response": {
"$ref": "ListLineItemAssignedTargetingOptionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
}
}
}
}
}
},
"locationLists": {
"methods": {
"create": {
"description": "Creates a new location list. Returns the newly created location list if\nsuccessful.",
"flatPath": "v1/advertisers/{advertisersId}/locationLists",
"httpMethod": "POST",
"id": "displayvideo.advertisers.locationLists.create",
"parameterOrder": [
"advertiserId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the DV360 advertiser to which the location list belongs.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/locationLists",
"request": {
"$ref": "LocationList"
},
"response": {
"$ref": "LocationList"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"get": {
"description": "Gets a location list.",
"flatPath": "v1/advertisers/{advertisersId}/locationLists/{locationListsId}",
"httpMethod": "GET",
"id": "displayvideo.advertisers.locationLists.get",
"parameterOrder": [
"advertiserId",
"locationListId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the DV360 advertiser to which the fetched location list belongs.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"locationListId": {
"description": "Required. The ID of the location list to fetch.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/locationLists/{+locationListId}",
"response": {
"$ref": "LocationList"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"list": {
"description": "Lists location lists based on a given advertiser id.",
"flatPath": "v1/advertisers/{advertisersId}/locationLists",
"httpMethod": "GET",
"id": "displayvideo.advertisers.locationLists.list",
"parameterOrder": [
"advertiserId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the DV360 advertiser to which the fetched location lists belong.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"filter": {
"description": "Allows filtering by location list fields.\n\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by `AND` or `OR` logical operators. A\nsequence of restrictions implicitly uses `AND`.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `EQUALS (=)`.\n* Supported fields:\n - `locationType`\n\nExamples:\n\n* All regional location list:\n`locationType=\"TARGETING_LOCATION_TYPE_REGIONAL\"`\n* All proximity location list:\n`locationType=\"TARGETING_LOCATION_TYPE_PROXIMITY\"`",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Field by which to sort the list.\nAcceptable values are:\n\n* `locationListId` (default)\n* `displayName`\n\nThe default sorting order is ascending. To specify descending order for\na field, a suffix \"desc\" should be added to the field name. Example:\n`displayName desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. Must be between `1` and `100`.\nDefaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an\ninvalid value is specified.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.\n\nTypically, this is the value of\nnext_page_token\nreturned from the previous call to `ListLocationLists` method.\nIf not specified, the first page of results will be returned.",
"location": "query",
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/locationLists",
"response": {
"$ref": "ListLocationListsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"patch": {
"description": "Updates a location list. Returns the updated location list if successful.",
"flatPath": "v1/advertisers/{advertisersId}/locationLists/{locationListId}",
"httpMethod": "PATCH",
"id": "displayvideo.advertisers.locationLists.patch",
"parameterOrder": [
"advertiserId",
"locationListId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the DV360 advertiser to which the location lists belongs.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"locationListId": {
"description": "Output only. The unique ID of the location list. Assigned by the system.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The mask to control which fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/locationLists/{locationListId}",
"request": {
"$ref": "LocationList"
},
"response": {
"$ref": "LocationList"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
},
"resources": {
"assignedLocations": {
"methods": {
"bulkEdit": {
"description": "Bulk edits multiple assignments between locations and a single location\nlist.\n\nThe operation will delete the assigned locations provided in\nBulkEditAssignedLocationsRequest.deleted_assigned_locations and then\ncreate the assigned locations provided in\nBulkEditAssignedLocationsRequest.created_assigned_locations.",
"flatPath": "v1/advertisers/{advertiserId}/locationLists/{locationListsId}/assignedLocations:bulkEdit",
"httpMethod": "POST",
"id": "displayvideo.advertisers.locationLists.assignedLocations.bulkEdit",
"parameterOrder": [
"advertiserId",
"locationListId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the DV360 advertiser to which the location list belongs.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"locationListId": {
"description": "Required. The ID of the location list to which these assignments are assigned.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{advertiserId}/locationLists/{+locationListId}/assignedLocations:bulkEdit",
"request": {
"$ref": "BulkEditAssignedLocationsRequest"
},
"response": {
"$ref": "BulkEditAssignedLocationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"create": {
"description": "Creates an assignment between a location and a location list.",
"flatPath": "v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations",
"httpMethod": "POST",
"id": "displayvideo.advertisers.locationLists.assignedLocations.create",
"parameterOrder": [
"advertiserId",
"locationListId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the DV360 advertiser to which the location list belongs.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"locationListId": {
"description": "Required. The ID of the location list for which the assignment will be created.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations",
"request": {
"$ref": "AssignedLocation"
},
"response": {
"$ref": "AssignedLocation"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"delete": {
"description": "Deletes the assignment between a location and a location list.",
"flatPath": "v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{assignedLocationsId}",
"httpMethod": "DELETE",
"id": "displayvideo.advertisers.locationLists.assignedLocations.delete",
"parameterOrder": [
"advertiserId",
"locationListId",
"assignedLocationId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the DV360 advertiser to which the location list belongs.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"assignedLocationId": {
"description": "Required. The ID of the assigned location to delete.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"locationListId": {
"description": "Required. The ID of the location list to which this assignment is assigned.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{+assignedLocationId}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"list": {
"description": "Lists locations assigned to a location list.",
"flatPath": "v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations",
"httpMethod": "GET",
"id": "displayvideo.advertisers.locationLists.assignedLocations.list",
"parameterOrder": [
"advertiserId",
"locationListId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the DV360 advertiser to which the location list belongs.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"filter": {
"description": "Allows filtering by location list assignment fields.\n\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by the logical operator `OR`.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `EQUALS (=)`.\n* Supported fields:\n - `assignedLocationId`\n\nThe length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"locationListId": {
"description": "Required. The ID of the location list to which these assignments are assigned.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"orderBy": {
"description": "Field by which to sort the list.\nAcceptable values are:\n\n* `assignedLocationId` (default)\n\nThe default sorting order is ascending. To specify descending order for a\nfield, a suffix \" desc\" should be added to the field name. Example:\n`assignedLocationId desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value\nis specified.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.\n\nTypically, this is the value of\nnext_page_token\nreturned from the previous call to `ListAssignedLocations`\nmethod. If not specified, the first page of results will be returned.",
"location": "query",
"type": "string"
}
},
"path": "v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations",
"response": {
"$ref": "ListAssignedLocationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
}
}
}
},
"negativeKeywordLists": {
"methods": {
"create": {
"description": "Creates a new negative keyword list. Returns the newly created negative\nkeyword list if successful.",
"flatPath": "v1/advertisers/{advertisersId}/negativeKeywordLists",
"httpMethod": "POST",
"id": "displayvideo.advertisers.negativeKeywordLists.create",
"parameterOrder": [
"advertiserId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the DV360 advertiser to which the negative keyword list will\nbelong.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/negativeKeywordLists",
"request": {
"$ref": "NegativeKeywordList"
},
"response": {
"$ref": "NegativeKeywordList"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"delete": {
"description": "Deletes a negative keyword list given an advertiser ID and a negative\nkeyword list ID.",
"flatPath": "v1/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}",
"httpMethod": "DELETE",
"id": "displayvideo.advertisers.negativeKeywordLists.delete",
"parameterOrder": [
"advertiserId",
"negativeKeywordListId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the DV360 advertiser to which the negative keyword list belongs.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"negativeKeywordListId": {
"description": "Required. The ID of the negative keyword list to delete.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"get": {
"description": "Gets a negative keyword list given an advertiser ID and a negative keyword\nlist ID.",
"flatPath": "v1/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}",
"httpMethod": "GET",
"id": "displayvideo.advertisers.negativeKeywordLists.get",
"parameterOrder": [
"advertiserId",
"negativeKeywordListId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the DV360 advertiser to which the fetched negative keyword list\nbelongs.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"negativeKeywordListId": {
"description": "Required. The ID of the negative keyword list to fetch.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}",
"response": {
"$ref": "NegativeKeywordList"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"list": {
"description": "Lists negative keyword lists based on a given advertiser id.",
"flatPath": "v1/advertisers/{advertisersId}/negativeKeywordLists",
"httpMethod": "GET",
"id": "displayvideo.advertisers.negativeKeywordLists.list",
"parameterOrder": [
"advertiserId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the DV360 advertiser to which the fetched negative keyword lists\nbelong.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Requested page size. Must be between `1` and `100`.\nDefaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an\ninvalid value is specified.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.\n\nTypically, this is the value of\nnext_page_token\nreturned from the previous call to `ListNegativeKeywordLists` method.\nIf not specified, the first page of results will be returned.",
"location": "query",
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/negativeKeywordLists",
"response": {
"$ref": "ListNegativeKeywordListsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"patch": {
"description": "Updates a negative keyword list. Returns the updated negative keyword list\nif successful.",
"flatPath": "v1/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListId}",
"httpMethod": "PATCH",
"id": "displayvideo.advertisers.negativeKeywordLists.patch",
"parameterOrder": [
"advertiserId",
"negativeKeywordListId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the DV360 advertiser to which the negative keyword list belongs.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"negativeKeywordListId": {
"description": "Output only. The unique ID of the negative keyword list. Assigned by the system.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The mask to control which fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/negativeKeywordLists/{negativeKeywordListId}",
"request": {
"$ref": "NegativeKeywordList"
},
"response": {
"$ref": "NegativeKeywordList"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
},
"resources": {
"negativeKeywords": {
"methods": {
"bulkEdit": {
"description": "Bulk edits negative keywords in a single negative keyword list.\n\nThe operation will delete the negative keywords provided in\nBulkEditNegativeKeywordsRequest.deleted_negative_keywords and then\ncreate the negative keywords provided in\nBulkEditNegativeKeywordsRequest.created_negative_keywords.\n\nThis operation is guaranteed to be atomic and will never result in a\npartial success or partial failure.",
"flatPath": "v1/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:bulkEdit",
"httpMethod": "POST",
"id": "displayvideo.advertisers.negativeKeywordLists.negativeKeywords.bulkEdit",
"parameterOrder": [
"advertiserId",
"negativeKeywordListId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the DV360 advertiser to which the parent negative keyword list\nbelongs.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"negativeKeywordListId": {
"description": "Required. The ID of the parent negative keyword list to which the negative keywords\nbelong.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:bulkEdit",
"request": {
"$ref": "BulkEditNegativeKeywordsRequest"
},
"response": {
"$ref": "BulkEditNegativeKeywordsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"create": {
"description": "Creates a negative keyword in a negative keyword list.",
"flatPath": "v1/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords",
"httpMethod": "POST",
"id": "displayvideo.advertisers.negativeKeywordLists.negativeKeywords.create",
"parameterOrder": [
"advertiserId",
"negativeKeywordListId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the DV360 advertiser to which the parent negative keyword list\nbelongs.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"negativeKeywordListId": {
"description": "Required. The ID of the parent negative keyword list in which the negative keyword\nwill be created.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords",
"request": {
"$ref": "NegativeKeyword"
},
"response": {
"$ref": "NegativeKeyword"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"delete": {
"description": "Deletes a negative keyword from a negative keyword list.",
"flatPath": "v1/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords/{negativeKeywordsId}",
"httpMethod": "DELETE",
"id": "displayvideo.advertisers.negativeKeywordLists.negativeKeywords.delete",
"parameterOrder": [
"advertiserId",
"negativeKeywordListId",
"keywordValue"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the DV360 advertiser to which the parent negative keyword list\nbelongs.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"keywordValue": {
"description": "Required. The keyword value of the negative keyword to delete.",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"negativeKeywordListId": {
"description": "Required. The ID of the parent negative keyword list to which the negative keyword\nbelongs.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords/{+keywordValue}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"list": {
"description": "Lists negative keywords in a negative keyword list.",
"flatPath": "v1/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords",
"httpMethod": "GET",
"id": "displayvideo.advertisers.negativeKeywordLists.negativeKeywords.list",
"parameterOrder": [
"advertiserId",
"negativeKeywordListId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the DV360 advertiser to which the parent negative keyword list\nbelongs.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"filter": {
"description": "Allows filtering by negative keyword fields.\n\nSupported syntax:\n\n* Filter expressions for negative keyword currently can only contain at\nmost one\n* restriction.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `CONTAINS (:)`.\n* Supported fields:\n - `keywordValue`\n\nExamples:\n\n* All negative keywords for which the keyword value contains \"google\":\n`keywordValue : \"google\"`",
"location": "query",
"type": "string"
},
"negativeKeywordListId": {
"description": "Required. The ID of the parent negative keyword list to which the requested negative\nkeywords belong.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"orderBy": {
"description": "Field by which to sort the list.\nAcceptable values are:\n\n* `keywordValue` (default)\n\nThe default sorting order is ascending. To specify descending order for a\nfield, a suffix \" desc\" should be added to the field name. Example:\n`keywordValue desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value\nis specified.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.\n\nTypically, this is the value of\nnext_page_token returned\nfrom the previous call to `ListNegativeKeywords` method. If not specified,\nthe first page of results will be returned.",
"location": "query",
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords",
"response": {
"$ref": "ListNegativeKeywordsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
}
}
}
},
"targetingTypes": {
"resources": {
"assignedTargetingOptions": {
"methods": {
"create": {
"description": "Assigns a targeting option to an advertiser.\nReturns the assigned targeting option if successful.",
"flatPath": "v1/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions",
"httpMethod": "POST",
"id": "displayvideo.advertisers.targetingTypes.assignedTargetingOptions.create",
"parameterOrder": [
"advertiserId",
"targetingType"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the advertiser.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"targetingType": {
"description": "Required. Identifies the type of this assigned targeting option.",
"enum": [
"TARGETING_TYPE_UNSPECIFIED",
"TARGETING_TYPE_CHANNEL",
"TARGETING_TYPE_APP_CATEGORY",
"TARGETING_TYPE_APP",
"TARGETING_TYPE_URL",
"TARGETING_TYPE_DAY_AND_TIME",
"TARGETING_TYPE_AGE_RANGE",
"TARGETING_TYPE_REGIONAL_LOCATION_LIST",
"TARGETING_TYPE_PROXIMITY_LOCATION_LIST",
"TARGETING_TYPE_GENDER",
"TARGETING_TYPE_VIDEO_PLAYER_SIZE",
"TARGETING_TYPE_USER_REWARDED_CONTENT",
"TARGETING_TYPE_PARENTAL_STATUS",
"TARGETING_TYPE_CONTENT_INSTREAM_POSITION",
"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION",
"TARGETING_TYPE_DEVICE_TYPE",
"TARGETING_TYPE_AUDIENCE_GROUP",
"TARGETING_TYPE_BROWSER",
"TARGETING_TYPE_HOUSEHOLD_INCOME",
"TARGETING_TYPE_ON_SCREEN_POSITION",
"TARGETING_TYPE_THIRD_PARTY_VERIFIER",
"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION",
"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION",
"TARGETING_TYPE_ENVIRONMENT",
"TARGETING_TYPE_CARRIER_AND_ISP",
"TARGETING_TYPE_OPERATING_SYSTEM",
"TARGETING_TYPE_DEVICE_MAKE_MODEL",
"TARGETING_TYPE_KEYWORD",
"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST",
"TARGETING_TYPE_VIEWABILITY",
"TARGETING_TYPE_CATEGORY",
"TARGETING_TYPE_INVENTORY_SOURCE",
"TARGETING_TYPE_LANGUAGE",
"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS",
"TARGETING_TYPE_GEO_REGION",
"TARGETING_TYPE_INVENTORY_SOURCE_GROUP",
"TARGETING_TYPE_EXCHANGE",
"TARGETING_TYPE_SUB_EXCHANGE"
],
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions",
"request": {
"$ref": "AssignedTargetingOption"
},
"response": {
"$ref": "AssignedTargetingOption"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"delete": {
"description": "Deletes an assigned targeting option from an advertiser.",
"flatPath": "v1/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}",
"httpMethod": "DELETE",
"id": "displayvideo.advertisers.targetingTypes.assignedTargetingOptions.delete",
"parameterOrder": [
"advertiserId",
"targetingType",
"assignedTargetingOptionId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the advertiser.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"assignedTargetingOptionId": {
"description": "Required. The ID of the assigned targeting option to delete.",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"targetingType": {
"description": "Required. Identifies the type of this assigned targeting option.",
"enum": [
"TARGETING_TYPE_UNSPECIFIED",
"TARGETING_TYPE_CHANNEL",
"TARGETING_TYPE_APP_CATEGORY",
"TARGETING_TYPE_APP",
"TARGETING_TYPE_URL",
"TARGETING_TYPE_DAY_AND_TIME",
"TARGETING_TYPE_AGE_RANGE",
"TARGETING_TYPE_REGIONAL_LOCATION_LIST",
"TARGETING_TYPE_PROXIMITY_LOCATION_LIST",
"TARGETING_TYPE_GENDER",
"TARGETING_TYPE_VIDEO_PLAYER_SIZE",
"TARGETING_TYPE_USER_REWARDED_CONTENT",
"TARGETING_TYPE_PARENTAL_STATUS",
"TARGETING_TYPE_CONTENT_INSTREAM_POSITION",
"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION",
"TARGETING_TYPE_DEVICE_TYPE",
"TARGETING_TYPE_AUDIENCE_GROUP",
"TARGETING_TYPE_BROWSER",
"TARGETING_TYPE_HOUSEHOLD_INCOME",
"TARGETING_TYPE_ON_SCREEN_POSITION",
"TARGETING_TYPE_THIRD_PARTY_VERIFIER",
"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION",
"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION",
"TARGETING_TYPE_ENVIRONMENT",
"TARGETING_TYPE_CARRIER_AND_ISP",
"TARGETING_TYPE_OPERATING_SYSTEM",
"TARGETING_TYPE_DEVICE_MAKE_MODEL",
"TARGETING_TYPE_KEYWORD",
"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST",
"TARGETING_TYPE_VIEWABILITY",
"TARGETING_TYPE_CATEGORY",
"TARGETING_TYPE_INVENTORY_SOURCE",
"TARGETING_TYPE_LANGUAGE",
"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS",
"TARGETING_TYPE_GEO_REGION",
"TARGETING_TYPE_INVENTORY_SOURCE_GROUP",
"TARGETING_TYPE_EXCHANGE",
"TARGETING_TYPE_SUB_EXCHANGE"
],
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"get": {
"description": "Gets a single targeting option assigned to an advertiser.",
"flatPath": "v1/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}",
"httpMethod": "GET",
"id": "displayvideo.advertisers.targetingTypes.assignedTargetingOptions.get",
"parameterOrder": [
"advertiserId",
"targetingType",
"assignedTargetingOptionId"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the advertiser.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"assignedTargetingOptionId": {
"description": "Required. An identifier unique to the targeting type in this advertiser that\nidentifies the assigned targeting option being requested.",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"targetingType": {
"description": "Required. Identifies the type of this assigned targeting option.",
"enum": [
"TARGETING_TYPE_UNSPECIFIED",
"TARGETING_TYPE_CHANNEL",
"TARGETING_TYPE_APP_CATEGORY",
"TARGETING_TYPE_APP",
"TARGETING_TYPE_URL",
"TARGETING_TYPE_DAY_AND_TIME",
"TARGETING_TYPE_AGE_RANGE",
"TARGETING_TYPE_REGIONAL_LOCATION_LIST",
"TARGETING_TYPE_PROXIMITY_LOCATION_LIST",
"TARGETING_TYPE_GENDER",
"TARGETING_TYPE_VIDEO_PLAYER_SIZE",
"TARGETING_TYPE_USER_REWARDED_CONTENT",
"TARGETING_TYPE_PARENTAL_STATUS",
"TARGETING_TYPE_CONTENT_INSTREAM_POSITION",
"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION",
"TARGETING_TYPE_DEVICE_TYPE",
"TARGETING_TYPE_AUDIENCE_GROUP",
"TARGETING_TYPE_BROWSER",
"TARGETING_TYPE_HOUSEHOLD_INCOME",
"TARGETING_TYPE_ON_SCREEN_POSITION",
"TARGETING_TYPE_THIRD_PARTY_VERIFIER",
"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION",
"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION",
"TARGETING_TYPE_ENVIRONMENT",
"TARGETING_TYPE_CARRIER_AND_ISP",
"TARGETING_TYPE_OPERATING_SYSTEM",
"TARGETING_TYPE_DEVICE_MAKE_MODEL",
"TARGETING_TYPE_KEYWORD",
"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST",
"TARGETING_TYPE_VIEWABILITY",
"TARGETING_TYPE_CATEGORY",
"TARGETING_TYPE_INVENTORY_SOURCE",
"TARGETING_TYPE_LANGUAGE",
"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS",
"TARGETING_TYPE_GEO_REGION",
"TARGETING_TYPE_INVENTORY_SOURCE_GROUP",
"TARGETING_TYPE_EXCHANGE",
"TARGETING_TYPE_SUB_EXCHANGE"
],
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}",
"response": {
"$ref": "AssignedTargetingOption"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"list": {
"description": "Lists the targeting options assigned to an advertiser.",
"flatPath": "v1/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions",
"httpMethod": "GET",
"id": "displayvideo.advertisers.targetingTypes.assignedTargetingOptions.list",
"parameterOrder": [
"advertiserId",
"targetingType"
],
"parameters": {
"advertiserId": {
"description": "Required. The ID of the advertiser.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"filter": {
"description": "Allows filtering by assigned targeting option properties.\n\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by the logical operator `OR`.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `EQUALS (=)`.\n* Supported fields:\n - `assignedTargetingOptionId`\n\nExamples:\n\n* AssignedTargetingOption with ID 123456\n`assignedTargetingOptionId=\"123456\"`\n\nThe length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Field by which to sort the list.\nAcceptable values are:\n\n* `assignedTargetingOptionId` (default)\n\nThe default sorting order is ascending. To specify descending order for\na field, a suffix \"desc\" should be added to the field name. Example:\n`assignedTargetingOptionId desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value\nis specified.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nnext_page_token\nreturned from the previous call to `ListAdvertiserAssignedTargetingOptions`\nmethod. If not specified, the first page of results will be returned.",
"location": "query",
"type": "string"
},
"targetingType": {
"description": "Required. Identifies the type of assigned targeting options to list.",
"enum": [
"TARGETING_TYPE_UNSPECIFIED",
"TARGETING_TYPE_CHANNEL",
"TARGETING_TYPE_APP_CATEGORY",
"TARGETING_TYPE_APP",
"TARGETING_TYPE_URL",
"TARGETING_TYPE_DAY_AND_TIME",
"TARGETING_TYPE_AGE_RANGE",
"TARGETING_TYPE_REGIONAL_LOCATION_LIST",
"TARGETING_TYPE_PROXIMITY_LOCATION_LIST",
"TARGETING_TYPE_GENDER",
"TARGETING_TYPE_VIDEO_PLAYER_SIZE",
"TARGETING_TYPE_USER_REWARDED_CONTENT",
"TARGETING_TYPE_PARENTAL_STATUS",
"TARGETING_TYPE_CONTENT_INSTREAM_POSITION",
"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION",
"TARGETING_TYPE_DEVICE_TYPE",
"TARGETING_TYPE_AUDIENCE_GROUP",
"TARGETING_TYPE_BROWSER",
"TARGETING_TYPE_HOUSEHOLD_INCOME",
"TARGETING_TYPE_ON_SCREEN_POSITION",
"TARGETING_TYPE_THIRD_PARTY_VERIFIER",
"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION",
"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION",
"TARGETING_TYPE_ENVIRONMENT",
"TARGETING_TYPE_CARRIER_AND_ISP",
"TARGETING_TYPE_OPERATING_SYSTEM",
"TARGETING_TYPE_DEVICE_MAKE_MODEL",
"TARGETING_TYPE_KEYWORD",
"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST",
"TARGETING_TYPE_VIEWABILITY",
"TARGETING_TYPE_CATEGORY",
"TARGETING_TYPE_INVENTORY_SOURCE",
"TARGETING_TYPE_LANGUAGE",
"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS",
"TARGETING_TYPE_GEO_REGION",
"TARGETING_TYPE_INVENTORY_SOURCE_GROUP",
"TARGETING_TYPE_EXCHANGE",
"TARGETING_TYPE_SUB_EXCHANGE"
],
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions",
"response": {
"$ref": "ListAdvertiserAssignedTargetingOptionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
}
}
}
}
}
},
"combinedAudiences": {
"methods": {
"get": {
"description": "Gets a combined audience.",
"flatPath": "v1/combinedAudiences/{combinedAudiencesId}",
"httpMethod": "GET",
"id": "displayvideo.combinedAudiences.get",
"parameterOrder": [
"combinedAudienceId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that has access to the fetched combined\naudience.",
"format": "int64",
"location": "query",
"type": "string"
},
"combinedAudienceId": {
"description": "Required. The ID of the combined audience to fetch.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that has access to the fetched combined audience.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "v1/combinedAudiences/{+combinedAudienceId}",
"response": {
"$ref": "CombinedAudience"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"list": {
"description": "Lists combined audiences.\n\nThe order is defined by the\norder_by parameter.",
"flatPath": "v1/combinedAudiences",
"httpMethod": "GET",
"id": "displayvideo.combinedAudiences.list",
"parameterOrder": [],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that has access to the fetched combined\naudiences.",
"format": "int64",
"location": "query",
"type": "string"
},
"filter": {
"description": "Allows filtering by combined audience fields.\n\nSupported syntax:\n\n* Filter expressions for combined audiences currently can only contain at\nmost one restriction.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `CONTAINS (:)`.\n* Supported fields:\n - `displayName`\n\nExamples:\n\n* All combined audiences for which the display name contains \"Google\":\n`displayName : \"Google\"`.\n\nThe length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Field by which to sort the list.\nAcceptable values are:\n\n* `combinedAudienceId` (default)\n* `displayName`\n\nThe default sorting order is ascending. To specify descending order for\na field, a suffix \"desc\" should be added to the field name. Example:\n`displayName desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value\nis specified.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nnext_page_token\nreturned from the previous call to `ListCombinedAudiences` method.\nIf not specified, the first page of results will be returned.",
"location": "query",
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that has access to the fetched combined audiences.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "v1/combinedAudiences",
"response": {
"$ref": "ListCombinedAudiencesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
}
},
"customLists": {
"methods": {
"get": {
"description": "Gets a custom list.",
"flatPath": "v1/customLists/{customListsId}",
"httpMethod": "GET",
"id": "displayvideo.customLists.get",
"parameterOrder": [
"customListId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the DV360 advertiser that has access to the fetched custom\nlists.",
"format": "int64",
"location": "query",
"type": "string"
},
"customListId": {
"description": "Required. The ID of the custom list to fetch.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/customLists/{+customListId}",
"response": {
"$ref": "CustomList"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"list": {
"description": "Lists custom lists.\n\nThe order is defined by the order_by\nparameter.",
"flatPath": "v1/customLists",
"httpMethod": "GET",
"id": "displayvideo.customLists.list",
"parameterOrder": [],
"parameters": {
"advertiserId": {
"description": "The ID of the DV360 advertiser that has access to the fetched custom\nlists.",
"format": "int64",
"location": "query",
"type": "string"
},
"filter": {
"description": "Allows filtering by custom list fields.\n\nSupported syntax:\n\n* Filter expressions for custom lists currently can only contain at\nmost one restriction.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `CONTAINS (:)`.\n* Supported fields:\n - `displayName`\n\nExamples:\n\n* All custom lists for which the display name contains \"Google\":\n`displayName : \"Google\"`.\n\nThe length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Field by which to sort the list.\nAcceptable values are:\n\n* `customListId` (default)\n* `displayName`\n\nThe default sorting order is ascending. To specify descending order for\na field, a suffix \"desc\" should be added to the field name. Example:\n`displayName desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value\nis specified.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nnext_page_token\nreturned from the previous call to `ListCustomLists` method.\nIf not specified, the first page of results will be returned.",
"location": "query",
"type": "string"
}
},
"path": "v1/customLists",
"response": {
"$ref": "ListCustomListsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
}
},
"firstAndThirdPartyAudiences": {
"methods": {
"get": {
"description": "Gets a first and third party audience.",
"flatPath": "v1/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}",
"httpMethod": "GET",
"id": "displayvideo.firstAndThirdPartyAudiences.get",
"parameterOrder": [
"firstAndThirdPartyAudienceId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that has access to the fetched first and\nthird party audience.",
"format": "int64",
"location": "query",
"type": "string"
},
"firstAndThirdPartyAudienceId": {
"description": "Required. The ID of the first and third party audience to fetch.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that has access to the fetched first and\nthird party audience.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "v1/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}",
"response": {
"$ref": "FirstAndThirdPartyAudience"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"list": {
"description": "Lists first and third party audiences.\n\nThe order is defined by the\norder_by parameter.",
"flatPath": "v1/firstAndThirdPartyAudiences",
"httpMethod": "GET",
"id": "displayvideo.firstAndThirdPartyAudiences.list",
"parameterOrder": [],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that has access to the fetched first and\nthird party audiences.",
"format": "int64",
"location": "query",
"type": "string"
},
"filter": {
"description": "Allows filtering by first and third party audience fields.\n\nSupported syntax:\n\n* Filter expressions for first and third party audiences currently can\nonly contain at most one restriction.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `CONTAINS (:)`.\n* Supported fields:\n - `displayName`\n\nExamples:\n\n* All first and third party audiences for which the display name contains\n\"Google\": `displayName : \"Google\"`.\n\nThe length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Field by which to sort the list.\nAcceptable values are:\n\n* `firstAndThirdPartyAudienceId` (default)\n* `displayName`\n\nThe default sorting order is ascending. To specify descending order for\na field, a suffix \"desc\" should be added to the field name. Example:\n`displayName desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value\nis specified.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nnext_page_token\nreturned from the previous call to `ListFirstAndThirdPartyAudiences`\nmethod. If not specified, the first page of results will be returned.",
"location": "query",
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that has access to the fetched first and\nthird party audiences.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "v1/firstAndThirdPartyAudiences",
"response": {
"$ref": "ListFirstAndThirdPartyAudiencesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
}
},
"floodlightGroups": {
"methods": {
"get": {
"description": "Gets a Floodlight group.",
"flatPath": "v1/floodlightGroups/{floodlightGroupsId}",
"httpMethod": "GET",
"id": "displayvideo.floodlightGroups.get",
"parameterOrder": [
"floodlightGroupId"
],
"parameters": {
"floodlightGroupId": {
"description": "Required. The ID of the Floodlight group to fetch.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"partnerId": {
"description": "Required. The partner context by which the Floodlight group is being accessed.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "v1/floodlightGroups/{+floodlightGroupId}",
"response": {
"$ref": "FloodlightGroup"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"patch": {
"description": "Updates an existing Floodlight group.\nReturns the updated Floodlight group if successful.",
"flatPath": "v1/floodlightGroups/{floodlightGroupId}",
"httpMethod": "PATCH",
"id": "displayvideo.floodlightGroups.patch",
"parameterOrder": [
"floodlightGroupId"
],
"parameters": {
"floodlightGroupId": {
"description": "Output only. The unique ID of the Floodlight group. Assigned by the system.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"partnerId": {
"description": "Required. The partner context by which the Floodlight group is being accessed.",
"format": "int64",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "Required. The mask to control which fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/floodlightGroups/{floodlightGroupId}",
"request": {
"$ref": "FloodlightGroup"
},
"response": {
"$ref": "FloodlightGroup"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
}
},
"googleAudiences": {
"methods": {
"get": {
"description": "Gets a Google audience.",
"flatPath": "v1/googleAudiences/{googleAudiencesId}",
"httpMethod": "GET",
"id": "displayvideo.googleAudiences.get",
"parameterOrder": [
"googleAudienceId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that has access to the fetched Google audience.",
"format": "int64",
"location": "query",
"type": "string"
},
"googleAudienceId": {
"description": "Required. The ID of the Google audience to fetch.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that has access to the fetched Google audience.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "v1/googleAudiences/{+googleAudienceId}",
"response": {
"$ref": "GoogleAudience"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"list": {
"description": "Lists Google audiences.\n\nThe order is defined by the order_by\nparameter.",
"flatPath": "v1/googleAudiences",
"httpMethod": "GET",
"id": "displayvideo.googleAudiences.list",
"parameterOrder": [],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that has access to the fetched Google audiences.",
"format": "int64",
"location": "query",
"type": "string"
},
"filter": {
"description": "Allows filtering by Google audience fields.\n\nSupported syntax:\n\n* Filter expressions for Google audiences currently can only contain at\nmost one restriction.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `CONTAINS (:)`.\n* Supported fields:\n - `displayName`\n\nExamples:\n\n* All Google audiences for which the display name contains \"Google\":\n`displayName : \"Google\"`.\n\nThe length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Field by which to sort the list.\nAcceptable values are:\n\n* `googleAudienceId` (default)\n* `displayName`\n\nThe default sorting order is ascending. To specify descending order for\na field, a suffix \"desc\" should be added to the field name. Example:\n`displayName desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value\nis specified.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nnext_page_token\nreturned from the previous call to `ListGoogleAudiences` method.\nIf not specified, the first page of results will be returned.",
"location": "query",
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that has access to the fetched Google audiences.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "v1/googleAudiences",
"response": {
"$ref": "ListGoogleAudiencesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
}
},
"inventorySourceGroups": {
"methods": {
"create": {
"description": "Creates a new inventory source group. Returns the newly created inventory\nsource group if successful.",
"flatPath": "v1/inventorySourceGroups",
"httpMethod": "POST",
"id": "displayvideo.inventorySourceGroups.create",
"parameterOrder": [],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that owns the inventory source group.\n\nThe parent partner will not have access to this group.",
"format": "int64",
"location": "query",
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that owns the inventory source group.\n\nOnly this partner will have write access to this group. Only advertisers\nto which this group is explicitly shared will have read access to this\ngroup.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "v1/inventorySourceGroups",
"request": {
"$ref": "InventorySourceGroup"
},
"response": {
"$ref": "InventorySourceGroup"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"delete": {
"description": "Deletes an inventory source group.",
"flatPath": "v1/inventorySourceGroups/{inventorySourceGroupsId}",
"httpMethod": "DELETE",
"id": "displayvideo.inventorySourceGroups.delete",
"parameterOrder": [
"inventorySourceGroupId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that owns the inventory source group.\n\nThe parent partner does not have access to this group.",
"format": "int64",
"location": "query",
"type": "string"
},
"inventorySourceGroupId": {
"description": "Required. The ID of the inventory source group to delete.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that owns the inventory source group.\n\nOnly this partner has write access to this group.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "v1/inventorySourceGroups/{+inventorySourceGroupId}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"get": {
"description": "Gets an inventory source group.",
"flatPath": "v1/inventorySourceGroups/{inventorySourceGroupsId}",
"httpMethod": "GET",
"id": "displayvideo.inventorySourceGroups.get",
"parameterOrder": [
"inventorySourceGroupId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that has access to the inventory source group.\n\nIf an inventory source group is partner-owned, only advertisers to which\nthe group is explicitly shared can access the group.",
"format": "int64",
"location": "query",
"type": "string"
},
"inventorySourceGroupId": {
"description": "Required. The ID of the inventory source group to fetch.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that has access to the inventory source group.\n\nA partner cannot access an advertiser-owned inventory source group.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "v1/inventorySourceGroups/{+inventorySourceGroupId}",
"response": {
"$ref": "InventorySourceGroup"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"list": {
"description": "Lists inventory source groups that are accessible to the current user.\n\nThe order is defined by the\norder_by parameter.",
"flatPath": "v1/inventorySourceGroups",
"httpMethod": "GET",
"id": "displayvideo.inventorySourceGroups.list",
"parameterOrder": [],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that has access to the inventory source group.\n\nIf an inventory source group is partner-owned, only advertisers to which\nthe group is explicitly shared can access the group.",
"format": "int64",
"location": "query",
"type": "string"
},
"filter": {
"description": "Allows filtering by inventory source group properties.\n\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by the logical operator `OR`.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `EQUALS (=)`.\n* Supported fields:\n - `inventorySourceGroupId`\n\nThe length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Field by which to sort the list.\nAcceptable values are:\n\n* `displayName` (default)\n* `inventorySourceGroupId`\n\nThe default sorting order is ascending. To specify descending order for\na field, a suffix \"desc\" should be added to the field name. For example,\n`displayName desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nnext_page_token\nreturned from the previous call to `ListInventorySources` method.\nIf not specified, the first page of results will be returned.",
"location": "query",
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that has access to the inventory source group.\n\nA partner cannot access advertiser-owned inventory source groups.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "v1/inventorySourceGroups",
"response": {
"$ref": "ListInventorySourceGroupsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"patch": {
"description": "Updates an inventory source group. Returns the updated inventory source\ngroup if successful.",
"flatPath": "v1/inventorySourceGroups/{inventorySourceGroupId}",
"httpMethod": "PATCH",
"id": "displayvideo.inventorySourceGroups.patch",
"parameterOrder": [
"inventorySourceGroupId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that owns the inventory source group.\n\nThe parent partner does not have access to this group.",
"format": "int64",
"location": "query",
"type": "string"
},
"inventorySourceGroupId": {
"description": "Output only. The unique ID of the inventory source group. Assigned by the system.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that owns the inventory source group.\n\nOnly this partner has write access to this group.",
"format": "int64",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "Required. The mask to control which fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/inventorySourceGroups/{inventorySourceGroupId}",
"request": {
"$ref": "InventorySourceGroup"
},
"response": {
"$ref": "InventorySourceGroup"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
},
"resources": {
"assignedInventorySources": {
"methods": {
"bulkEdit": {
"description": "Bulk edits multiple assignments between inventory sources and a single\ninventory source group.\n\nThe operation will delete the assigned inventory sources provided in\nBulkEditAssignedInventorySourcesRequest.deleted_assigned_inventory_sources\nand then create the assigned inventory sources provided in\nBulkEditAssignedInventorySourcesRequest.created_assigned_inventory_sources.",
"flatPath": "v1/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources:bulkEdit",
"httpMethod": "POST",
"id": "displayvideo.inventorySourceGroups.assignedInventorySources.bulkEdit",
"parameterOrder": [
"inventorySourceGroupId"
],
"parameters": {
"inventorySourceGroupId": {
"description": "Required. The ID of the inventory source group to which the assignments are\nassigned.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources:bulkEdit",
"request": {
"$ref": "BulkEditAssignedInventorySourcesRequest"
},
"response": {
"$ref": "BulkEditAssignedInventorySourcesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"create": {
"description": "Creates an assignment between an inventory source and an inventory source\ngroup.",
"flatPath": "v1/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources",
"httpMethod": "POST",
"id": "displayvideo.inventorySourceGroups.assignedInventorySources.create",
"parameterOrder": [
"inventorySourceGroupId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that owns the parent inventory source group.\n\nThe parent partner will not have access to this assigned inventory\nsource.",
"format": "int64",
"location": "query",
"type": "string"
},
"inventorySourceGroupId": {
"description": "Required. The ID of the inventory source group to which the assignment will be\nassigned.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that owns the parent inventory source group.\n\nOnly this partner will have write access to this assigned inventory\nsource.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources",
"request": {
"$ref": "AssignedInventorySource"
},
"response": {
"$ref": "AssignedInventorySource"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"delete": {
"description": "Deletes the assignment between an inventory source and an inventory source\ngroup.",
"flatPath": "v1/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources/{assignedInventorySourcesId}",
"httpMethod": "DELETE",
"id": "displayvideo.inventorySourceGroups.assignedInventorySources.delete",
"parameterOrder": [
"inventorySourceGroupId",
"assignedInventorySourceId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that owns the parent inventory source group.\n\nThe parent partner does not have access to this assigned inventory\nsource.",
"format": "int64",
"location": "query",
"type": "string"
},
"assignedInventorySourceId": {
"description": "Required. The ID of the assigned inventory source to delete.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"inventorySourceGroupId": {
"description": "Required. The ID of the inventory source group to which this assignment is assigned.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that owns the parent inventory source group.\n\nOnly this partner has write access to this assigned inventory source.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources/{+assignedInventorySourceId}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"list": {
"description": "Lists inventory sources assigned to an inventory source group.",
"flatPath": "v1/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources",
"httpMethod": "GET",
"id": "displayvideo.inventorySourceGroups.assignedInventorySources.list",
"parameterOrder": [
"inventorySourceGroupId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that has access to the assignment.\n\nIf the parent inventory source group is partner-owned, only advertisers\nto which the parent group is explicitly shared can access the assigned\ninventory source.",
"format": "int64",
"location": "query",
"type": "string"
},
"filter": {
"description": "Allows filtering by assigned inventory source fields.\n\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by the logical operator `OR`.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `EQUALS (=)`.\n* Supported fields:\n - `assignedInventorySourceId`\n\nThe length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"inventorySourceGroupId": {
"description": "Required. The ID of the inventory source group to which these assignments are\nassigned.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"orderBy": {
"description": "Field by which to sort the list.\nAcceptable values are:\n\n* `assignedInventorySourceId` (default)\n\nThe default sorting order is ascending. To specify descending order for a\nfield, a suffix \" desc\" should be added to the field name. Example:\n`assignedInventorySourceId desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value\nis specified.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.\n\nTypically, this is the value of\nnext_page_token\nreturned from the previous call to `ListAssignedInventorySources`\nmethod. If not specified, the first page of results will be returned.",
"location": "query",
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that has access to the assignment.\n\nIf the parent inventory source group is advertiser-owned, the assignment\ncannot be accessed via a partner.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources",
"response": {
"$ref": "ListAssignedInventorySourcesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
}
}
}
},
"inventorySources": {
"methods": {
"get": {
"description": "Gets an inventory source.",
"flatPath": "v1/inventorySources/{inventorySourcesId}",
"httpMethod": "GET",
"id": "displayvideo.inventorySources.get",
"parameterOrder": [
"inventorySourceId"
],
"parameters": {
"inventorySourceId": {
"description": "Required. The ID of the inventory source to fetch.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"partnerId": {
"description": "Required. The ID of the DV360 partner to which the fetched inventory source\nis permissioned.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "v1/inventorySources/{+inventorySourceId}",
"response": {
"$ref": "InventorySource"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"list": {
"description": "Lists inventory sources that are accessible to the current user.\n\nThe order is defined by the\norder_by parameter.\nIf a filter by\nentity_status is not\nspecified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED`\nwill not be included in the results.",
"flatPath": "v1/inventorySources",
"httpMethod": "GET",
"id": "displayvideo.inventorySources.list",
"parameterOrder": [],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that has access to the inventory source.",
"format": "int64",
"location": "query",
"type": "string"
},
"filter": {
"description": "Allows filtering by inventory source properties.\n\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by `AND` or `OR` logical operators. A\nsequence of restrictions implicitly uses `AND`.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `EQUALS (=)`.\n* Supported fields:\n - `status.entityStatus`\n - `commitment`\n - `deliveryMethod`\n - `rateDetails.rateType`\n - `exchange`\n\nExamples:\n\n* All active inventory sources:\n`status.entityStatus=\"ENTITY_STATUS_ACTIVE\"`\n* Inventory sources belonging to Google Ad Manager or Rubicon exchanges:\n`exchange=\"EXCHANGE_GOOGLE_AD_MANAGER\" OR exchange=\"EXCHANGE_RUBICON\"`\n\nThe length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Field by which to sort the list.\nAcceptable values are:\n\n* `displayName` (default)\n\nThe default sorting order is ascending. To specify descending order for\na field, a suffix \"desc\" should be added to the field name. For example,\n`displayName desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nnext_page_token\nreturned from the previous call to `ListInventorySources` method.\nIf not specified, the first page of results will be returned.",
"location": "query",
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that has access to the inventory source.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "v1/inventorySources",
"response": {
"$ref": "ListInventorySourcesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
}
},
"media": {
"methods": {
"download": {
"description": "Downloads media. Download is supported on the URI `/download/{resource_name=**}?alt=media.`\n\n**Note**: Download requests will not be successful without including `alt=media` query string.",
"flatPath": "download/{downloadId}",
"httpMethod": "GET",
"id": "displayvideo.media.download",
"parameterOrder": [
"resourceName"
],
"parameters": {
"resourceName": {
"description": "Name of the media that is being downloaded. See\nReadRequest.resource_name.",
"location": "path",
"pattern": "^.*$",
"required": true,
"type": "string"
}
},
"path": "download/{+resourceName}",
"response": {
"$ref": "GoogleBytestreamMedia"
},
"scopes": [
"https://www.googleapis.com/auth/display-video",
"https://www.googleapis.com/auth/doubleclickbidmanager"
],
"supportsMediaDownload": true
}
}
},
"partners": {
"resources": {
"channels": {
"methods": {
"create": {
"description": "Creates a new channel. Returns the newly created channel if successful.",
"flatPath": "v1/partners/{partnersId}/channels",
"httpMethod": "POST",
"id": "displayvideo.partners.channels.create",
"parameterOrder": [
"partnerId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that owns the created channel.",
"format": "int64",
"location": "query",
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that owns the created channel.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/partners/{+partnerId}/channels",
"request": {
"$ref": "Channel"
},
"response": {
"$ref": "Channel"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"get": {
"description": "Gets a channel for a partner or advertiser.",
"flatPath": "v1/partners/{partnersId}/channels/{channelsId}",
"httpMethod": "GET",
"id": "displayvideo.partners.channels.get",
"parameterOrder": [
"partnerId",
"channelId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that owns the fetched channel.",
"format": "int64",
"location": "query",
"type": "string"
},
"channelId": {
"description": "Required. The ID of the channel to fetch.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that owns the fetched channel.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/partners/{+partnerId}/channels/{+channelId}",
"response": {
"$ref": "Channel"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"list": {
"description": "Lists channels for a partner or advertiser.",
"flatPath": "v1/partners/{partnersId}/channels",
"httpMethod": "GET",
"id": "displayvideo.partners.channels.list",
"parameterOrder": [
"partnerId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that owns the channels.",
"format": "int64",
"location": "query",
"type": "string"
},
"filter": {
"description": "Allows filtering by channel fields.\n\nSupported syntax:\n\n* Filter expressions for channel currently can only contain at most one\n* restriction.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `CONTAINS (:)`.\n* Supported fields:\n - `displayName`\n\nExamples:\n\n* All channels for which the display name contains \"google\":\n`displayName : \"google\"`.\n\nThe length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Field by which to sort the list.\nAcceptable values are:\n\n* `displayName` (default)\n* `channelId`\n\nThe default sorting order is ascending. To specify descending order for a\nfield, a suffix \" desc\" should be added to the field name. Example:\n`displayName desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value\nis specified.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nnext_page_token returned from the\nprevious call to `ListChannels` method. If not specified, the first page\nof results will be returned.",
"location": "query",
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that owns the channels.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/partners/{+partnerId}/channels",
"response": {
"$ref": "ListChannelsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"patch": {
"description": "Updates a channel. Returns the updated channel if successful.",
"flatPath": "v1/partners/{partnersId}/channels/{channelId}",
"httpMethod": "PATCH",
"id": "displayvideo.partners.channels.patch",
"parameterOrder": [
"partnerId",
"channelId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that owns the created channel.",
"format": "int64",
"location": "query",
"type": "string"
},
"channelId": {
"description": "Output only. The unique ID of the channel. Assigned by the system.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that owns the created channel.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The mask to control which fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/partners/{+partnerId}/channels/{channelId}",
"request": {
"$ref": "Channel"
},
"response": {
"$ref": "Channel"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
},
"resources": {
"sites": {
"methods": {
"bulkEdit": {
"description": "Bulk edits sites under a single channel.\n\nThe operation will delete the sites provided in\nBulkEditSitesRequest.deleted_sites and then create the sites\nprovided in BulkEditSitesRequest.created_sites.",
"flatPath": "v1/partners/{partnerId}/channels/{channelsId}/sites:bulkEdit",
"httpMethod": "POST",
"id": "displayvideo.partners.channels.sites.bulkEdit",
"parameterOrder": [
"partnerId",
"channelId"
],
"parameters": {
"channelId": {
"description": "Required. The ID of the parent channel to which the sites belong.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that owns the parent channel.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/partners/{partnerId}/channels/{+channelId}/sites:bulkEdit",
"request": {
"$ref": "BulkEditSitesRequest"
},
"response": {
"$ref": "BulkEditSitesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"create": {
"description": "Creates a site in a channel.",
"flatPath": "v1/partners/{partnerId}/channels/{channelsId}/sites",
"httpMethod": "POST",
"id": "displayvideo.partners.channels.sites.create",
"parameterOrder": [
"partnerId",
"channelId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that owns the parent channel.",
"format": "int64",
"location": "query",
"type": "string"
},
"channelId": {
"description": "Required. The ID of the parent channel in which the site will be created.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that owns the parent channel.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/partners/{partnerId}/channels/{+channelId}/sites",
"request": {
"$ref": "Site"
},
"response": {
"$ref": "Site"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"delete": {
"description": "Deletes a site from a channel.",
"flatPath": "v1/partners/{partnerId}/channels/{channelsId}/sites/{sitesId}",
"httpMethod": "DELETE",
"id": "displayvideo.partners.channels.sites.delete",
"parameterOrder": [
"partnerId",
"channelId",
"urlOrAppId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that owns the parent channel.",
"format": "int64",
"location": "query",
"type": "string"
},
"channelId": {
"description": "Required. The ID of the parent channel to which the site belongs.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that owns the parent channel.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"urlOrAppId": {
"description": "Required. The URL or app ID of the site to delete.",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/partners/{partnerId}/channels/{+channelId}/sites/{+urlOrAppId}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"list": {
"description": "Lists sites in a channel.",
"flatPath": "v1/partners/{partnersId}/channels/{channelsId}/sites",
"httpMethod": "GET",
"id": "displayvideo.partners.channels.sites.list",
"parameterOrder": [
"partnerId",
"channelId"
],
"parameters": {
"advertiserId": {
"description": "The ID of the advertiser that owns the parent channel.",
"format": "int64",
"location": "query",
"type": "string"
},
"channelId": {
"description": "Required. The ID of the parent channel to which the requested sites belong.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"filter": {
"description": "Allows filtering by site fields.\n\nSupported syntax:\n\n* Filter expressions for site currently can only contain at most one\n* restriction.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be `CONTAINS (:)`.\n* Supported fields:\n - `urlOrAppId`\n\nExamples:\n\n* All sites for which the URL or app ID contains \"google\":\n`urlOrAppId : \"google\"`",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Field by which to sort the list.\nAcceptable values are:\n\n* `urlOrAppId` (default)\n\nThe default sorting order is ascending. To specify descending order for a\nfield, a suffix \" desc\" should be added to the field name. Example:\n`urlOrAppId desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value\nis specified.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.\n\nTypically, this is the value of\nnext_page_token returned from the\nprevious call to `ListSites` method. If not specified, the first page\nof results will be returned.",
"location": "query",
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that owns the parent channel.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/partners/{+partnerId}/channels/{+channelId}/sites",
"response": {
"$ref": "ListSitesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
}
}
}
}
}
},
"sdfdownloadtasks": {
"methods": {
"create": {
"description": "Creates an SDF Download Task. Returns an\nOperation.\n\nAn SDF Download Task is a long-running, asynchronous operation. The\nmetadata type of this operation is\nSdfDownloadTaskMetadata. If the request is successful, the\nresponse type of the operation is\nSdfDownloadTask. The response will not include the download files,\nwhich must be retrieved with\nmedia.download. The state of\noperation can be retrieved with\nsdfdownloadtask.operations.get.\n\nAny errors can be found in the\nerror.message. Note\nthat error.details is expected to be\nempty.",
"flatPath": "v1/sdfdownloadtasks",
"httpMethod": "POST",
"id": "displayvideo.sdfdownloadtasks.create",
"parameterOrder": [],
"parameters": {},
"path": "v1/sdfdownloadtasks",
"request": {
"$ref": "CreateSdfDownloadTaskRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
},
"resources": {
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.",
"flatPath": "v1/sdfdownloadtasks/operations/{operationsId}",
"httpMethod": "GET",
"id": "displayvideo.sdfdownloadtasks.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^sdfdownloadtasks/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/display-video",
"https://www.googleapis.com/auth/doubleclickbidmanager"
]
}
}
}
}
},
"targetingTypes": {
"resources": {
"targetingOptions": {
"methods": {
"get": {
"description": "Gets a single targeting option.",
"flatPath": "v1/targetingTypes/{targetingTypesId}/targetingOptions/{targetingOptionsId}",
"httpMethod": "GET",
"id": "displayvideo.targetingTypes.targetingOptions.get",
"parameterOrder": [
"targetingType",
"targetingOptionId"
],
"parameters": {
"advertiserId": {
"description": "Required. The Advertiser this request is being made in the context of.",
"format": "int64",
"location": "query",
"type": "string"
},
"targetingOptionId": {
"description": "Required. The ID of the of targeting option to retrieve.",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"targetingType": {
"description": "Required. The type of targeting option to retrieve.",
"enum": [
"TARGETING_TYPE_UNSPECIFIED",
"TARGETING_TYPE_CHANNEL",
"TARGETING_TYPE_APP_CATEGORY",
"TARGETING_TYPE_APP",
"TARGETING_TYPE_URL",
"TARGETING_TYPE_DAY_AND_TIME",
"TARGETING_TYPE_AGE_RANGE",
"TARGETING_TYPE_REGIONAL_LOCATION_LIST",
"TARGETING_TYPE_PROXIMITY_LOCATION_LIST",
"TARGETING_TYPE_GENDER",
"TARGETING_TYPE_VIDEO_PLAYER_SIZE",
"TARGETING_TYPE_USER_REWARDED_CONTENT",
"TARGETING_TYPE_PARENTAL_STATUS",
"TARGETING_TYPE_CONTENT_INSTREAM_POSITION",
"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION",
"TARGETING_TYPE_DEVICE_TYPE",
"TARGETING_TYPE_AUDIENCE_GROUP",
"TARGETING_TYPE_BROWSER",
"TARGETING_TYPE_HOUSEHOLD_INCOME",
"TARGETING_TYPE_ON_SCREEN_POSITION",
"TARGETING_TYPE_THIRD_PARTY_VERIFIER",
"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION",
"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION",
"TARGETING_TYPE_ENVIRONMENT",
"TARGETING_TYPE_CARRIER_AND_ISP",
"TARGETING_TYPE_OPERATING_SYSTEM",
"TARGETING_TYPE_DEVICE_MAKE_MODEL",
"TARGETING_TYPE_KEYWORD",
"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST",
"TARGETING_TYPE_VIEWABILITY",
"TARGETING_TYPE_CATEGORY",
"TARGETING_TYPE_INVENTORY_SOURCE",
"TARGETING_TYPE_LANGUAGE",
"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS",
"TARGETING_TYPE_GEO_REGION",
"TARGETING_TYPE_INVENTORY_SOURCE_GROUP",
"TARGETING_TYPE_EXCHANGE",
"TARGETING_TYPE_SUB_EXCHANGE"
],
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/targetingTypes/{+targetingType}/targetingOptions/{+targetingOptionId}",
"response": {
"$ref": "TargetingOption"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"list": {
"description": "Lists targeting options of a given type.",
"flatPath": "v1/targetingTypes/{targetingTypesId}/targetingOptions",
"httpMethod": "GET",
"id": "displayvideo.targetingTypes.targetingOptions.list",
"parameterOrder": [
"targetingType"
],
"parameters": {
"advertiserId": {
"description": "Required. The Advertiser this request is being made in the context of.",
"format": "int64",
"location": "query",
"type": "string"
},
"filter": {
"description": "Allows filtering by targeting option properties.\n\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by `OR` logical operators.\n* A restriction has the form of `{field} {operator} {value}`.\n* The operator must be \"=\" (equal sign).\n* Supported fields:\n - `targetingOptionId`\n\nThe length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Field by which to sort the list.\nAcceptable values are:\n\n* `targetingOptionId` (default)\n\nThe default sorting order is ascending. To specify descending order for\na field, a suffix \"desc\" should be added to the field name.\nExample: `targetingOptionId desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. Must be between `1` and `100`. If unspecified will\ndefault to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value\nis specified.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nnext_page_token\nreturned from the previous call to `ListTargetingOptions` method.\nIf not specified, the first page of results will be returned.",
"location": "query",
"type": "string"
},
"targetingType": {
"description": "Required. The type of targeting option to be listed.",
"enum": [
"TARGETING_TYPE_UNSPECIFIED",
"TARGETING_TYPE_CHANNEL",
"TARGETING_TYPE_APP_CATEGORY",
"TARGETING_TYPE_APP",
"TARGETING_TYPE_URL",
"TARGETING_TYPE_DAY_AND_TIME",
"TARGETING_TYPE_AGE_RANGE",
"TARGETING_TYPE_REGIONAL_LOCATION_LIST",
"TARGETING_TYPE_PROXIMITY_LOCATION_LIST",
"TARGETING_TYPE_GENDER",
"TARGETING_TYPE_VIDEO_PLAYER_SIZE",
"TARGETING_TYPE_USER_REWARDED_CONTENT",
"TARGETING_TYPE_PARENTAL_STATUS",
"TARGETING_TYPE_CONTENT_INSTREAM_POSITION",
"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION",
"TARGETING_TYPE_DEVICE_TYPE",
"TARGETING_TYPE_AUDIENCE_GROUP",
"TARGETING_TYPE_BROWSER",
"TARGETING_TYPE_HOUSEHOLD_INCOME",
"TARGETING_TYPE_ON_SCREEN_POSITION",
"TARGETING_TYPE_THIRD_PARTY_VERIFIER",
"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION",
"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION",
"TARGETING_TYPE_ENVIRONMENT",
"TARGETING_TYPE_CARRIER_AND_ISP",
"TARGETING_TYPE_OPERATING_SYSTEM",
"TARGETING_TYPE_DEVICE_MAKE_MODEL",
"TARGETING_TYPE_KEYWORD",
"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST",
"TARGETING_TYPE_VIEWABILITY",
"TARGETING_TYPE_CATEGORY",
"TARGETING_TYPE_INVENTORY_SOURCE",
"TARGETING_TYPE_LANGUAGE",
"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS",
"TARGETING_TYPE_GEO_REGION",
"TARGETING_TYPE_INVENTORY_SOURCE_GROUP",
"TARGETING_TYPE_EXCHANGE",
"TARGETING_TYPE_SUB_EXCHANGE"
],
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/targetingTypes/{+targetingType}/targetingOptions",
"response": {
"$ref": "ListTargetingOptionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
}
}
}
}
}
},
"revision": "20200630",
"rootUrl": "https://displayvideo.googleapis.com/",
"schemas": {
"ActiveViewVideoViewabilityMetricConfig": {
"description": "Configuration for custom Active View video viewability metrics.",
"id": "ActiveViewVideoViewabilityMetricConfig",
"properties": {
"displayName": {
"description": "Required. The display name of the custom metric.",
"type": "string"
},
"minimumDuration": {
"description": "The minimum visible video duration required (in seconds) in order for an\nimpression to be recorded.\n\nYou must specify\nminimum_duration,\nminimum_quartile\nor both. If both are specified, an impression meets the metric criteria if\neither requirement is met (whichever happens first).",
"enum": [
"VIDEO_DURATION_UNSPECIFIED",
"VIDEO_DURATION_SECONDS_NONE",
"VIDEO_DURATION_SECONDS_0",
"VIDEO_DURATION_SECONDS_1",
"VIDEO_DURATION_SECONDS_2",
"VIDEO_DURATION_SECONDS_3",
"VIDEO_DURATION_SECONDS_4",
"VIDEO_DURATION_SECONDS_5",
"VIDEO_DURATION_SECONDS_6",
"VIDEO_DURATION_SECONDS_7",
"VIDEO_DURATION_SECONDS_8",
"VIDEO_DURATION_SECONDS_9",
"VIDEO_DURATION_SECONDS_10",
"VIDEO_DURATION_SECONDS_11",
"VIDEO_DURATION_SECONDS_12",
"VIDEO_DURATION_SECONDS_13",
"VIDEO_DURATION_SECONDS_14",
"VIDEO_DURATION_SECONDS_15",
"VIDEO_DURATION_SECONDS_30",
"VIDEO_DURATION_SECONDS_45",
"VIDEO_DURATION_SECONDS_60"
],
"enumDescriptions": [
"Value is not specified or is unknown in this version.",
"No duration value.",
"0 seconds.",
"1 second.",
"2 seconds.",
"3 seconds.",
"4 seconds.",
"5 seconds.",
"6 seconds.",
"7 seconds.",
"8 seconds.",
"9 seconds.",
"10 seconds.",
"11 seconds.",
"12 seconds.",
"13 seconds.",
"14 seconds.",
"15 seconds.",
"30 seconds.",
"45 seconds.",
"60 seconds."
],
"type": "string"
},
"minimumQuartile": {
"description": "The minimum visible video duration required, based on the video quartiles,\nin order for an impression to be recorded.\n\nYou must specify\nminimum_duration,\nminimum_quartile\nor both. If both are specified, an impression meets the metric criteria if\neither requirement is met (whichever happens first).",
"enum": [
"VIDEO_DURATION_QUARTILE_UNSPECIFIED",
"VIDEO_DURATION_QUARTILE_NONE",
"VIDEO_DURATION_QUARTILE_FIRST",
"VIDEO_DURATION_QUARTILE_SECOND",
"VIDEO_DURATION_QUARTILE_THIRD",
"VIDEO_DURATION_QUARTILE_FOURTH"
],
"enumDescriptions": [
"Value is not specified or is unknown in this version.",
"No quartile value.",
"First quartile.",
"Second quartile (midpoint).",
"Third quartile.",
"Fourth quartile (completion)."
],
"type": "string"
},
"minimumViewability": {
"description": "Required. The minimum percentage of the video ad's pixels visible on the screen in\norder for an impression to be recorded.",
"enum": [
"VIEWABILITY_PERCENT_UNSPECIFIED",
"VIEWABILITY_PERCENT_0",
"VIEWABILITY_PERCENT_25",
"VIEWABILITY_PERCENT_50",
"VIEWABILITY_PERCENT_75",
"VIEWABILITY_PERCENT_100"
],
"enumDescriptions": [
"Value is not specified or is unknown in this version.",
"0% viewable.",
"25% viewable.",
"50% viewable.",
"75% viewable.",
"100% viewable."
],
"type": "string"
},
"minimumVolume": {
"description": "Required. The minimum percentage of the video ad's volume required in order for an\nimpression to be recorded.",
"enum": [
"VIDEO_VOLUME_PERCENT_UNSPECIFIED",
"VIDEO_VOLUME_PERCENT_0",
"VIDEO_VOLUME_PERCENT_10"
],
"enumDescriptions": [
"Value is not specified or is unknown in this version.",
"0% volume.",
"10% volume."
],
"type": "string"
}
},
"type": "object"
},
"Adloox": {
"description": "Details of Adloox settings.",
"id": "Adloox",
"properties": {
"excludedAdlooxCategories": {
"description": "Adloox's brand safety settings.",
"enumDescriptions": [
"This enum is only a placeholder and it doesn't specify any Adloox option.",
"Adult content (hard).",
"Adult content (soft).",
"Illegal content.",
"Borderline content.",
"Discriminatory content.",
"Violent content \u0026 weapons.",
"Low viewability domains.",
"Fraud."
],
"items": {
"enum": [
"ADLOOX_UNSPECIFIED",
"ADULT_CONTENT_HARD",
"ADULT_CONTENT_SOFT",
"ILLEGAL_CONTENT",
"BORDERLINE_CONTENT",
"DISCRIMINATORY_CONTENT",
"VIOLENT_CONTENT_WEAPONS",
"LOW_VIEWABILITY_DOMAINS",
"FRAUD"
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Advertiser": {
"description": "A single advertiser in Display \u0026 Video 360 (DV360).",
"id": "Advertiser",
"properties": {
"adServerConfig": {
"$ref": "AdvertiserAdServerConfig",
"description": "Required. Immutable. Ad server related settings of the advertiser."
},
"advertiserId": {
"description": "Output only. The unique ID of the advertiser. Assigned by the system.",
"format": "int64",
"type": "string"
},
"creativeConfig": {
"$ref": "AdvertiserCreativeConfig",
"description": "Required. Creative related settings of the advertiser."
},
"dataAccessConfig": {
"$ref": "AdvertiserDataAccessConfig",
"description": "Settings that control how advertiser data may be accessed."
},
"displayName": {
"description": "Required. The display name of the advertiser.\n\nMust be UTF-8 encoded with a maximum size of 240 bytes.",
"type": "string"
},
"entityStatus": {
"description": "Required. Controls whether or not insertion orders and line items of the\nadvertiser can spend their budgets and bid on inventory.\n\n* Accepted values are `ENTITY_STATUS_ACTIVE` and\n`ENTITY_STATUS_SCHEDULED_FOR_DELETION`.\n* If set to\n`ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30\ndays from when it was first scheduled for deletion.",
"enum": [
"ENTITY_STATUS_UNSPECIFIED",
"ENTITY_STATUS_ACTIVE",
"ENTITY_STATUS_ARCHIVED",
"ENTITY_STATUS_DRAFT",
"ENTITY_STATUS_PAUSED",
"ENTITY_STATUS_SCHEDULED_FOR_DELETION"
],
"enumDescriptions": [
"Default value when status is not specified or is unknown in this version.",
"The entity is enabled to bid and spend budget.",
"The entity is archived. Bidding and budget spending are disabled. An\nentity can be deleted after archived. Deleted entities cannot be retrieved.",
"The entity is under draft. Bidding and budget spending are disabled.",
"Bidding and budget spending are paused for the entity.",
"The entity is scheduled for deletion."
],
"type": "string"
},
"generalConfig": {
"$ref": "AdvertiserGeneralConfig",
"description": "Required. General settings of the advertiser."
},
"integrationDetails": {
"$ref": "IntegrationDetails",
"description": "Integration details of the advertiser.\nOnly integrationCode is currently\napplicable to advertiser. Other fields of IntegrationDetails are not\nsupported and will be ignored if provided."
},
"name": {
"description": "Output only. The resource name of the advertiser.",
"type": "string"
},
"partnerId": {
"description": "Required. Immutable. The unique ID of the partner that the advertiser belongs to.",
"format": "int64",
"type": "string"
},
"servingConfig": {
"$ref": "AdvertiserTargetingConfig",
"description": "Targeting settings related to ad serving of the advertiser."
},
"updateTime": {
"description": "Output only. The timestamp when the advertiser was last updated. Assigned by the system.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"AdvertiserAdServerConfig": {
"description": "Ad server related settings of an advertiser.",
"id": "AdvertiserAdServerConfig",
"properties": {
"cmHybridConfig": {
"$ref": "CmHybridConfig",
"description": "The configuration for advertisers that use both Campaign Manager (CM) and\nthird-party ad servers."
},
"thirdPartyOnlyConfig": {
"$ref": "ThirdPartyOnlyConfig",
"description": "The configuration for advertisers that use third-party ad servers\nonly."
}
},
"type": "object"
},
"AdvertiserCreativeConfig": {
"description": "Creatives related settings of an advertiser.",
"id": "AdvertiserCreativeConfig",
"properties": {
"dynamicCreativeEnabled": {
"description": "Whether or not the advertiser is enabled for dynamic creatives.",
"type": "boolean"
},
"iasClientId": {
"description": "An ID for configuring campaign monitoring provided by Integral Ad Service\n(IAS). The DV360 system will append an IAS \"Campaign Monitor\" tag\ncontaining this ID to the creative tag.",
"format": "int64",
"type": "string"
},
"obaComplianceDisabled": {
"description": "Whether or not to use DV360's Online Behavioral Advertising (OBA)\ncompliance.\n\nWarning: Changing OBA settings may cause the audit status of your creatives\nto be reset by some ad exchanges, making them ineligible to serve until\nthey are re-approved.",
"type": "boolean"
},
"videoCreativeDataSharingAuthorized": {
"description": "By setting this field to `true`, you, on behalf of your company,\nauthorize Google to use video creatives associated with this Display \u0026\nVideo 360 advertiser to provide reporting and features related to the\nadvertiser's television campaigns.\n\nApplicable only when the advertiser has a\nCM hybrid ad server\nconfiguration.",
"type": "boolean"
}
},
"type": "object"
},
"AdvertiserDataAccessConfig": {
"description": "Settings that control how advertiser related data may be accessed.",
"id": "AdvertiserDataAccessConfig",
"properties": {
"sdfConfig": {
"$ref": "AdvertiserSdfConfig",
"description": "Structured Data Files (SDF) settings for the advertiser.\n\nIf not specified, the SDF settings of the parent partner are used."
}
},
"type": "object"
},
"AdvertiserGeneralConfig": {
"description": "General settings of an advertiser.",
"id": "AdvertiserGeneralConfig",
"properties": {
"currencyCode": {
"description": "Required. Immutable. Advertiser's currency in ISO 4217 format.\n\nAccepted codes and the currencies they represent are:\n\nCurrency Code : Currency Name\n\n* `ARS` : Argentine Peso\n* `AUD` : Australian Dollar\n* `BRL` : Brazilian Real\n* `CAD` : Canadian Dollar\n* `CHF` : Swiss Franc\n* `CLP` : Chilean Peso\n* `CNY` : Chinese Yuan\n* `COP` : Colombian Peso\n* `CZK` : Czech Koruna\n* `DKK` : Danish Krone\n* `EGP` : Egyption Pound\n* `EUR` : Euro\n* `GBP` : British Pound\n* `HKD` : Hong Kong Dollar\n* `HUF` : Hungarian Forint\n* `IDR` : Indonesian Rupiah\n* `ILS` : Israeli Shekel\n* `INR` : Indian Rupee\n* `JPY` : Japanese Yen\n* `KRW` : South Korean Won\n* `MXN` : Mexican Pesos\n* `MYR` : Malaysian Ringgit\n* `NGN` : Nigerian Naira\n* `NOK` : Norwegian Krone\n* `NZD` : New Zealand Dollar\n* `PEN` : Peruvian Nuevo Sol\n* `PLN` : Polish Zloty\n* `RON` : New Romanian Leu\n* `RUB` : Russian Ruble\n* `SEK` : Swedish Krona\n* `TRY` : Turkish Lira\n* `TWD` : New Taiwan Dollar\n* `USD` : US Dollar\n* `ZAR` : South African Rand",
"type": "string"
},
"domainUrl": {
"description": "Required. The domain URL of the advertiser's primary website.\nThe system will send this information to publishers that require website\nURL to associate a campaign with an advertiser.\n\nProvide a URL with no path or query string, beginning with `http:` or\n`https:`.\nFor example, http://www.example.com",
"type": "string"
},
"timeZone": {
"description": "Output only. The standard TZ database name of the advertiser's time zone.\nFor example, `America/New_York`.\n\nSee more at:\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones\n\nFor CM hybrid advertisers, the time zone is the same as that of the\nassociated CM account; for third-party only advertisers, the time zone is\nthe same as that of the parent partner.",
"type": "string"
}
},
"type": "object"
},
"AdvertiserSdfConfig": {
"description": "Structured Data Files (SDF) settings of an advertiser.",
"id": "AdvertiserSdfConfig",
"properties": {
"overridePartnerSdfConfig": {
"description": "Whether or not this advertiser overrides the SDF configuration of its\nparent partner.\n\nBy default, an advertiser inherits the SDF configuration from the parent\npartner. To override the partner configuration, set this field to `true`\nand provide the new configuration in\nsdfConfig.",
"type": "boolean"
},
"sdfConfig": {
"$ref": "SdfConfig",
"description": "The SDF configuration for the advertiser.\n\n* Required when\noverridePartnerSdfConfig\nis `true`.\n* Output only when\noverridePartnerSdfConfig\nis `false`."
}
},
"type": "object"
},
"AdvertiserTargetingConfig": {
"description": "Targeting settings related to ad serving of an advertiser.",
"id": "AdvertiserTargetingConfig",
"properties": {
"exemptTvFromViewabilityTargeting": {
"description": "Whether or not connected TV devices are exempt from viewability targeting\nfor all video line items under the advertiser.",
"type": "boolean"
}
},
"type": "object"
},
"AgeRangeAssignedTargetingOptionDetails": {
"description": "Represents a targetable age range. This will be populated in the details\nfield of an AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_AGE_RANGE`.",
"id": "AgeRangeAssignedTargetingOptionDetails",
"properties": {
"ageRange": {
"description": "Output only. The age range of an audience. We only support targeting a continuous age\nrange of an audience. Thus, the age range represented in this field can be\n1) targeted solely, or, 2) part of a larger continuous age range. The reach\nof a continuous age range targeting can be expanded by also targeting an\naudience of an unknown age.",
"enum": [
"AGE_RANGE_UNSPECIFIED",
"AGE_RANGE_18_24",
"AGE_RANGE_25_34",
"AGE_RANGE_35_44",
"AGE_RANGE_45_54",
"AGE_RANGE_55_64",
"AGE_RANGE_65_PLUS",
"AGE_RANGE_UNKNOWN"
],
"enumDescriptions": [
"Default value when age range is not specified in this version. This enum is\na placeholder for default value and does not represent a real age range\noption.",
"The age range of the audience is 18 to 24.",
"The age range of the audience is 25 to 34.",
"The age range of the audience is 35 to 44.",
"The age range of the audience is 45 to 54.",
"The age range of the audience is 55 to 64.",
"The age range of the audience is 65 and up.",
"The age range of the audience is unknown."
],
"type": "string"
},
"targetingOptionId": {
"description": "Required. The targeting_option_id of a\nTargetingOption of type `TARGETING_TYPE_AGE_RANGE`.",
"type": "string"
}
},
"type": "object"
},
"AgeRangeTargetingOptionDetails": {
"description": "Represents a targetable age range. This will be populated in the\nage_range_details field when\ntargeting_type is\n`TARGETING_TYPE_AGE_RANGE`.",
"id": "AgeRangeTargetingOptionDetails",
"properties": {
"ageRange": {
"description": "Output only. The age range of an audience.",
"enum": [
"AGE_RANGE_UNSPECIFIED",
"AGE_RANGE_18_24",
"AGE_RANGE_25_34",
"AGE_RANGE_35_44",
"AGE_RANGE_45_54",
"AGE_RANGE_55_64",
"AGE_RANGE_65_PLUS",
"AGE_RANGE_UNKNOWN"
],
"enumDescriptions": [
"Default value when age range is not specified in this version. This enum is\na placeholder for default value and does not represent a real age range\noption.",
"The age range of the audience is 18 to 24.",
"The age range of the audience is 25 to 34.",
"The age range of the audience is 35 to 44.",
"The age range of the audience is 45 to 54.",
"The age range of the audience is 55 to 64.",
"The age range of the audience is 65 and up.",
"The age range of the audience is unknown."
],
"type": "string"
}
},
"type": "object"
},
"AppAssignedTargetingOptionDetails": {
"description": "Details for assigned app targeting option. This will be populated in the\ndetails field of an AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_APP`.",
"id": "AppAssignedTargetingOptionDetails",
"properties": {
"appId": {
"description": "Required. The ID of the app.\n\nAndroid's Play store app uses bundle ID, for example\n`com.google.android.gm`. Apple's App store app ID uses 9 digit string, for\nexample `422689480`.",
"type": "string"
},
"displayName": {
"description": "Output only. The display name of the app.",
"type": "string"
},
"negative": {
"description": "Indicates if this option is being negatively targeted.",
"type": "boolean"
}
},
"type": "object"
},
"AppCategoryAssignedTargetingOptionDetails": {
"description": "Details for assigned app category targeting option. This will be\npopulated in the\napp_category_details field of\nan AssignedTargetingOption when\ntargeting_type\nis `TARGETING_TYPE_APP_CATEGORY`.",
"id": "AppCategoryAssignedTargetingOptionDetails",
"properties": {
"displayName": {
"description": "Output only. The display name of the app category.",
"type": "string"
},
"negative": {
"description": "Indicates if this option is being negatively targeted.",
"type": "boolean"
},
"targetingOptionId": {
"description": "Required. The targeting_option_id field when\ntargeting_type is\n`TARGETING_TYPE_APP_CATEGORY`.",
"type": "string"
}
},
"type": "object"
},
"AppCategoryTargetingOptionDetails": {
"description": "Represents a targetable collection of apps. A collection lets you target\ndynamic groups of related apps that are maintained by the platform, for\nexample `All Apps/Google Play/Games`. This will be populated in the\napp_category_details field when\ntargeting_type is\n`TARGETING_TYPE_APP_CATEGORY`.",
"id": "AppCategoryTargetingOptionDetails",
"properties": {
"displayName": {
"description": "Output only. The name of the app collection.",
"type": "string"
}
},
"type": "object"
},
"Asset": {
"description": "A single asset.",
"id": "Asset",
"properties": {
"content": {
"description": "The asset content.\nFor uploaded assets, the content is the serving path.",
"type": "string"
},
"mediaId": {
"description": "Media ID of the uploaded asset. This is a unique identifier for the asset.\nThis ID can be passed to other API calls, e.g.\nCreateCreative to associate\nthe asset with a creative.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"AssetAssociation": {
"description": "Asset association for the creative.",
"id": "AssetAssociation",
"properties": {
"asset": {
"$ref": "Asset",
"description": "The associated asset."
},
"role": {
"description": "The role of this asset for the creative.",
"enum": [
"ASSET_ROLE_UNSPECIFIED",
"ASSET_ROLE_MAIN",
"ASSET_ROLE_BACKUP",
"ASSET_ROLE_POLITE_LOAD",
"ASSET_ROLE_HEADLINE",
"ASSET_ROLE_LONG_HEADLINE",
"ASSET_ROLE_BODY",
"ASSET_ROLE_LONG_BODY",
"ASSET_ROLE_CAPTION_URL",
"ASSET_ROLE_CALL_TO_ACTION",
"ASSET_ROLE_ADVERTISER_NAME",
"ASSET_ROLE_PRICE",
"ASSET_ROLE_ANDROID_APP_ID",
"ASSET_ROLE_IOS_APP_ID",
"ASSET_ROLE_RATING",
"ASSET_ROLE_ICON",
"ASSET_ROLE_COVER_IMAGE"
],
"enumDescriptions": [
"Asset role is not specified or is unknown in this version.",
"The asset is the main asset of the creative.",
"The asset is a backup asset of the creative.",
"The asset is a polite load asset of the creative.",
"Headline of a native creative.\n\nThe content must be UTF-8 encoded with a length of no more\nthan 25 characters.\n\nThis role is only supported in following\ncreative_type:\n\n* `CREATIVE_TYPE_NATIVE`\n* `CREATIVE_TYPE_NATIVE_SITE_SQUARE`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`\n* `CREATIVE_TYPE_NATIVE_VIDEO`",
"Long headline of a native creative.\n\nThe content must be UTF-8 encoded with a length of no more\nthan 50 characters.\n\nThis role is only supported in following\ncreative_type:\n\n* `CREATIVE_TYPE_NATIVE`\n* `CREATIVE_TYPE_NATIVE_SITE_SQUARE`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`\n* `CREATIVE_TYPE_NATIVE_VIDEO`",
"Body text of a native creative.\n\nThe content must be UTF-8 encoded with a length of no more\nthan 90 characters.\n\nThis role is only supported in following\ncreative_type:\n\n* `CREATIVE_TYPE_NATIVE`\n* `CREATIVE_TYPE_NATIVE_SITE_SQUARE`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`\n* `CREATIVE_TYPE_NATIVE_VIDEO`",
"Long body text of a native creative.\n\nThe content must be UTF-8 encoded with a length of no more\nthan 150 characters.\n\nThis role is only supported in following\ncreative_type:\n\n* `CREATIVE_TYPE_NATIVE`\n* `CREATIVE_TYPE_NATIVE_SITE_SQUARE`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`\n* `CREATIVE_TYPE_NATIVE_VIDEO`",
"A short, friendly version of the landing page URL to show in the creative.\nThis URL gives people an idea of where they'll arrive after they click on\nthe creative.\n\nThe content must be UTF-8 encoded with a length of no more\nthan 30 characters.\n\nFor example, if the landing page URL is 'http://www.example.com/page',\nthe caption URL can be 'example.com'.\nThe protocol (http://) is optional, but the URL can't contain spaces or\nspecial characters.\n\nThis role is only supported in following\ncreative_type:\n\n* `CREATIVE_TYPE_NATIVE`\n* `CREATIVE_TYPE_NATIVE_SITE_SQUARE`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`\n* `CREATIVE_TYPE_NATIVE_VIDEO`",
"The text to use on the call-to-action button of a native creative.\n\nThe content must be UTF-8 encoded with a length of no more\nthan 15 characters.\n\nThis role is only supported in following\ncreative_type:\n\n* `CREATIVE_TYPE_NATIVE`\n* `CREATIVE_TYPE_NATIVE_SITE_SQUARE`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`\n* `CREATIVE_TYPE_NATIVE_VIDEO`",
"The text that identifies the advertiser or brand name.\n\nThe content must be UTF-8 encoded with a length of no more\nthan 25 characters.\n\nThis role is only supported in following\ncreative_type:\n\n* `CREATIVE_TYPE_NATIVE`\n* `CREATIVE_TYPE_NATIVE_SITE_SQUARE`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`\n* `CREATIVE_TYPE_NATIVE_VIDEO`",
"The purchase price of your app in the Google play store or iOS app store\n(for example, $5.99).\n\nNote that this value is not automatically synced with the actual value\nlisted in the store. It will always be the one provided when save the\ncreative.\n\nThe content must be UTF-8 encoded with a length of no more\nthan 15 characters.\n\nThis role is only supported in following\ncreative_type:\n\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`",
"The ID of an Android app in the Google play store.\n\nYou can find this ID in the App’s Google Play Store URL after ‘id’. For\nexample, in\nhttps://play.google.com/store/apps/details?id=com.company.appname the\nidentifier is com.company.appname.\n\nThis role is only supported in following\ncreative_type:\n\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`",
"The ID of an iOS app in the Apple app store.\n\nThis ID number can be found in the Apple App Store URL as the string of\nnumbers directly after \"id\". For example, in\nhttps://apps.apple.com/us/app/gmail-email-by-google/id422689480 the ID is\n422689480.\n\nThis role is only supported in following\ncreative_type:\n\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`",
"The rating of an app in the Google play store or iOS app store.\n\nNote that this value is not automatically synced with the actual rating\nin the store. It will always be the one provided when save the creative.\n\nThis role is only supported in following\ncreative_type:\n\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`",
"The icon of a creative.\n\nThis role is only supported and required in following\ncreative_type:\n\n* `CREATIVE_TYPE_NATIVE`\n* `CREATIVE_TYPE_NATIVE_SITE_SQUARE`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`",
"The cover image of a native video creative.\n\nThis role is only supported and required in following\ncreative_type:\n\n* `CREATIVE_TYPE_VIDEO`"
],
"type": "string"
}
},
"type": "object"
},
"AssignedInventorySource": {
"description": "An assignment between a targetable inventory source and an inventory source\ngroup.",
"id": "AssignedInventorySource",
"properties": {
"assignedInventorySourceId": {
"description": "Output only. The unique ID of the assigned inventory source. The ID is only\nunique within a given inventory source group. It may be reused in other\ncontexts.",
"format": "int64",
"type": "string"
},
"inventorySourceId": {
"description": "Required. The ID of the inventory source entity being targeted.",
"type": "string"
},
"name": {
"description": "Output only. The resource name of the assigned inventory source.",
"type": "string"
}
},
"type": "object"
},
"AssignedLocation": {
"description": "An assignment between a location list and a relevant targeting option.\nCurrently, geo region targeting options are the only supported option for\nassignment.",
"id": "AssignedLocation",
"properties": {
"assignedLocationId": {
"description": "Output only. The unique ID of the assigned location. The ID is only unique within a\nlocation list. It may be reused in other contexts.",
"format": "int64",
"type": "string"
},
"name": {
"description": "Output only. The resource name of the assigned location.",
"type": "string"
},
"targetingOptionId": {
"description": "Required. The ID of the targeting option assigned to the location list. Must be of\ntype TARGETING_TYPE_GEO_REGION.",
"type": "string"
}
},
"type": "object"
},
"AssignedTargetingOption": {
"description": "A single assigned targeting option, which defines the state of a targeting\noption for an entity with targeting settings.",
"id": "AssignedTargetingOption",
"properties": {
"ageRangeDetails": {
"$ref": "AgeRangeAssignedTargetingOptionDetails",
"description": "Age range details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_AGE_RANGE`."
},
"appCategoryDetails": {
"$ref": "AppCategoryAssignedTargetingOptionDetails",
"description": "App category details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_APP_CATEGORY`."
},
"appDetails": {
"$ref": "AppAssignedTargetingOptionDetails",
"description": "App details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_APP`."
},
"assignedTargetingOptionId": {
"description": "Output only. The unique ID of the assigned targeting option. The ID is only unique\nwithin a given line item and targeting type. It may be reused in other\ncontexts.",
"type": "string"
},
"audienceGroupDetails": {
"$ref": "AudienceGroupAssignedTargetingOptionDetails",
"description": "Audience targeting details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_AUDIENCE_GROUP`.\nYou can only target one audience group option per line item."
},
"authorizedSellerStatusDetails": {
"$ref": "AuthorizedSellerStatusAssignedTargetingOptionDetails",
"description": "Authorized seller status details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.\n\nYou can only target one authorized seller status option per line item.\n\nIf a line item doesn't have an authorized seller status option, all\nauthorized sellers indicated as DIRECT or RESELLER in the ads.txt file\nare targeted by default."
},
"browserDetails": {
"$ref": "BrowserAssignedTargetingOptionDetails",
"description": "Browser details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_BROWSER`."
},
"carrierAndIspDetails": {
"$ref": "CarrierAndIspAssignedTargetingOptionDetails",
"description": "Carrier and ISP details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_CARRIER_AND_ISP`."
},
"categoryDetails": {
"$ref": "CategoryAssignedTargetingOptionDetails",
"description": "Category details. This field will be populated when the TargetingType is\n`TARGETING_TYPE_CATEGORY`.\n\nTargeting a category will also target its subcategories. If a category is\nexcluded from targeting and a subcategory is included, the exclusion will\ntake precedence."
},
"channelDetails": {
"$ref": "ChannelAssignedTargetingOptionDetails",
"description": "Channel details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_CHANNEL`."
},
"contentInstreamPositionDetails": {
"$ref": "ContentInstreamPositionAssignedTargetingOptionDetails",
"description": "Content instream position details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`."
},
"contentOutstreamPositionDetails": {
"$ref": "ContentOutstreamPositionAssignedTargetingOptionDetails",
"description": "Content outstream position details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`."
},
"dayAndTimeDetails": {
"$ref": "DayAndTimeAssignedTargetingOptionDetails",
"description": "Day and time details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_DAY_AND_TIME`."
},
"deviceMakeModelDetails": {
"$ref": "DeviceMakeModelAssignedTargetingOptionDetails",
"description": "Device make and model details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_DEVICE_MAKE_MODEL`."
},
"deviceTypeDetails": {
"$ref": "DeviceTypeAssignedTargetingOptionDetails",
"description": "Device Type details. This field will be populated when the\nTargetingType is\n`TARGETING_TYPE_DEVICE_TYPE`."
},
"digitalContentLabelExclusionDetails": {
"$ref": "DigitalContentLabelAssignedTargetingOptionDetails",
"description": "Digital content label details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`.\n\nDigital content labels are targeting exclusions. Advertiser level digital\ncontent label exclusions, if set, are always applied in serving (even\nthough they aren't visible in line item settings). Line item settings can\nexclude content labels in addition to advertiser exclusions, but can't\noverride them. A line item won't serve if all the digital content labels\nare excluded."
},
"environmentDetails": {
"$ref": "EnvironmentAssignedTargetingOptionDetails",
"description": "Environment details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_ENVIRONMENT`."
},
"exchangeDetails": {
"$ref": "ExchangeAssignedTargetingOptionDetails",
"description": "Exchange details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_EXCHANGE`."
},
"genderDetails": {
"$ref": "GenderAssignedTargetingOptionDetails",
"description": "Gender details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_GENDER`."
},
"geoRegionDetails": {
"$ref": "GeoRegionAssignedTargetingOptionDetails",
"description": "Geographic region details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_GEO_REGION`."
},
"householdIncomeDetails": {
"$ref": "HouseholdIncomeAssignedTargetingOptionDetails",
"description": "Household income details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_HOUSEHOLD_INCOME`."
},
"inheritance": {
"description": "Output only. The inheritance status of the assigned targeting option.",
"enum": [
"INHERITANCE_UNSPECIFIED",
"NOT_INHERITED",
"INHERITED_FROM_PARTNER",
"INHERITED_FROM_ADVERTISER"
],
"enumDescriptions": [
"The inheritance is unspecified or unknown.",
"The assigned targeting option is not inherited from higher level entity.",
"The assigned targeting option is inherited from partner targeting\nsettings.",
"The assigned targeting option is inherited from advertiser targeting\nsettings."
],
"type": "string"
},
"inventorySourceDetails": {
"$ref": "InventorySourceAssignedTargetingOptionDetails",
"description": "Inventory source details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_INVENTORY_SOURCE`."
},
"inventorySourceGroupDetails": {
"$ref": "InventorySourceGroupAssignedTargetingOptionDetails",
"description": "Inventory source group details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`."
},
"keywordDetails": {
"$ref": "KeywordAssignedTargetingOptionDetails",
"description": "Keyword details. This field will be populated when the TargetingType is\n`TARGETING_TYPE_KEYWORD`.\n\nA maximum of 5000 direct negative keywords can be assigned to a\nline item. No limit on number of positive keywords that can be assigned."
},
"languageDetails": {
"$ref": "LanguageAssignedTargetingOptionDetails",
"description": "Language details. This field will be populated when the TargetingType is\n`TARGETING_TYPE_LANGUAGE`."
},
"name": {
"description": "Output only. The resource name for this assigned targeting option.",
"type": "string"
},
"negativeKeywordListDetails": {
"$ref": "NegativeKeywordListAssignedTargetingOptionDetails",
"description": "Keyword details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`.\n\nA maximum of 4 negative keyword lists can be assigned to a line item."
},
"onScreenPositionDetails": {
"$ref": "OnScreenPositionAssignedTargetingOptionDetails",
"description": "On screen position details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_ON_SCREEN_POSITION`."
},
"operatingSystemDetails": {
"$ref": "OperatingSystemAssignedTargetingOptionDetails",
"description": "Operating system details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_OPERATING_SYSTEM`."
},
"parentalStatusDetails": {
"$ref": "ParentalStatusAssignedTargetingOptionDetails",
"description": "Parental status details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_PARENTAL_STATUS`."
},
"proximityLocationListDetails": {
"$ref": "ProximityLocationListAssignedTargetingOptionDetails",
"description": "Proximity location list details. This field will be populated when the\nTargetingType is\n`TARGETING_TYPE_PROXIMITY_LOCATION_LIST`."
},
"regionalLocationListDetails": {
"$ref": "RegionalLocationListAssignedTargetingOptionDetails",
"description": "Regional location list details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`."
},
"sensitiveCategoryExclusionDetails": {
"$ref": "SensitiveCategoryAssignedTargetingOptionDetails",
"description": "Sensitive category details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.\n\nSensitive categories are targeting exclusions. Advertiser level sensitive\ncategory exclusions, if set, are always applied in serving (even though\nthey aren't visible in line item settings). Line item settings can\nexclude sensitive categories in addition to advertiser exclusions, but\ncan't override them."
},
"subExchangeDetails": {
"$ref": "SubExchangeAssignedTargetingOptionDetails",
"description": "Sub-exchange details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_SUB_EXCHANGE`."
},
"targetingType": {
"description": "Output only. Identifies the type of this assigned targeting option.",
"enum": [
"TARGETING_TYPE_UNSPECIFIED",
"TARGETING_TYPE_CHANNEL",
"TARGETING_TYPE_APP_CATEGORY",
"TARGETING_TYPE_APP",
"TARGETING_TYPE_URL",
"TARGETING_TYPE_DAY_AND_TIME",
"TARGETING_TYPE_AGE_RANGE",
"TARGETING_TYPE_REGIONAL_LOCATION_LIST",
"TARGETING_TYPE_PROXIMITY_LOCATION_LIST",
"TARGETING_TYPE_GENDER",
"TARGETING_TYPE_VIDEO_PLAYER_SIZE",
"TARGETING_TYPE_USER_REWARDED_CONTENT",
"TARGETING_TYPE_PARENTAL_STATUS",
"TARGETING_TYPE_CONTENT_INSTREAM_POSITION",
"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION",
"TARGETING_TYPE_DEVICE_TYPE",
"TARGETING_TYPE_AUDIENCE_GROUP",
"TARGETING_TYPE_BROWSER",
"TARGETING_TYPE_HOUSEHOLD_INCOME",
"TARGETING_TYPE_ON_SCREEN_POSITION",
"TARGETING_TYPE_THIRD_PARTY_VERIFIER",
"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION",
"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION",
"TARGETING_TYPE_ENVIRONMENT",
"TARGETING_TYPE_CARRIER_AND_ISP",
"TARGETING_TYPE_OPERATING_SYSTEM",
"TARGETING_TYPE_DEVICE_MAKE_MODEL",
"TARGETING_TYPE_KEYWORD",
"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST",
"TARGETING_TYPE_VIEWABILITY",
"TARGETING_TYPE_CATEGORY",
"TARGETING_TYPE_INVENTORY_SOURCE",
"TARGETING_TYPE_LANGUAGE",
"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS",
"TARGETING_TYPE_GEO_REGION",
"TARGETING_TYPE_INVENTORY_SOURCE_GROUP",
"TARGETING_TYPE_EXCHANGE",
"TARGETING_TYPE_SUB_EXCHANGE"
],
"enumDescriptions": [
"Default value when type is not specified or is unknown in this version.",
"Target a channel (a custom group of related websites or apps).",
"Target an app category (for example, education or puzzle games).",
"Target a specific app (for example, Angry Birds).",
"Target a specific url (for example, quora.com).",
"Target ads during a chosen time period on a specific day.",
"Target ads to a specific age range (for example, 18-24).",
"Target ads to the specified regions on a regional location list.",
"Target ads to the specified points of interest on a proximity location\nlist.",
"Target ads to a specific gender (for example, female or male).",
"Target a specific video player size for video ads.",
"Target user rewarded content for video ads.",
"Target ads to a specific parental status (for example, parent or not a\nparent).",
"Target video or audio ads in a specific content instream position (for\nexample, pre-roll, mid-roll, or post-roll).",
"Target ads in a specific content outstream position.",
"Target ads to a specific device type (for example, tablet or connected TV).",
"Target ads to an audience or groups of audiences.\nSingleton field, at most one can exist on a single Lineitem at a time.",
"Target ads to specific web browsers (for example, Chrome).",
"Target ads to a specific household income range (for example, top 10%).",
"Target ads in a specific on screen position.",
"Filter web sites through third party verification (for example, IAS or\nDoubleVerify).",
"Filter web sites by specific digital content label ratings (for example,\nDL-MA: suitable only for mature audiences).",
"Filter website content by sensitive categories (for example, adult).",
"Target ads to a specific environment (for example, web or app).",
"Target ads to a specific network carrier or internet service provider\n(ISP) (for example, Comcast or Orange).",
"Target ads to a specific operating system (for example, macOS).",
"Target ads to a specific device make or model (for example, Roku or\nSamsung).",
"Target ads to a specific keyword (for example, dog or retriever).",
"Target ads to a specific negative keyword list.",
"Target ads to a specific viewability (for example, 80% viewable).",
"Target ads to a specific content category (for example, arts \u0026\nentertainment).",
"Purchase impressions from specific deals and auction packages.",
"Target ads to a specific language (for example, English or Japanese).",
"Target ads to ads.txt authorized sellers.",
"Target ads to a specific regional location (for example, a city or state).",
"Purchase impressions from a group of deals and auction packages.",
"Purchase impressions from specific exchanges.",
"Purchase impressions from specific sub-exchanges."
],
"type": "string"
},
"thirdPartyVerifierDetails": {
"$ref": "ThirdPartyVerifierAssignedTargetingOptionDetails",
"description": "Third party verification details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`."
},
"urlDetails": {
"$ref": "UrlAssignedTargetingOptionDetails",
"description": "URL details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_URL`."
},
"userRewardedContentDetails": {
"$ref": "UserRewardedContentAssignedTargetingOptionDetails",
"description": "User rewarded content details. This field will be populated when the\nTargetingType is\n`TARGETING_TYPE_USER_REWARDED_CONTENT`."
},
"videoPlayerSizeDetails": {
"$ref": "VideoPlayerSizeAssignedTargetingOptionDetails",
"description": "Video player size details. This field will be populated when the\nTargetingType is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`."
},
"viewabilityDetails": {
"$ref": "ViewabilityAssignedTargetingOptionDetails",
"description": "Viewability details. This field will be populated when the TargetingType\nis `TARGETING_TYPE_VIEWABILITY`.\n\nYou can only target one viewability option per line item."
}
},
"type": "object"
},
"AudienceGroupAssignedTargetingOptionDetails": {
"description": "Assigned audience group targeting option details. This will be populated in\nthe details field of an AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_AUDIENCE_GROUP`.\nThe relation between each group is UNION, except for\nexcluded_first_and_third_party_audience_group and\nexcluded_google_audience_group, of which COMPLEMENT is UNION'ed with other\ngroups.",
"id": "AudienceGroupAssignedTargetingOptionDetails",
"properties": {
"excludedFirstAndThirdPartyAudienceGroup": {
"$ref": "FirstAndThirdPartyAudienceGroup",
"description": "The first and third party audience ids and recencies of the excluded\nfirst and third party audience group. Used for negative targeting. Its\nCOMPLEMENT is used to UNION other audience groups."
},
"excludedGoogleAudienceGroup": {
"$ref": "GoogleAudienceGroup",
"description": "The Google audience ids of the excluded Google audience group.\nUsed for negative targeting. It's COMPLEMENT is used to UNION other\naudience groups.\nOnly contains Affinity, In-market and Installed-apps type Google audiences.\nAll items are logically ‘OR’ of each other."
},
"includedCombinedAudienceGroup": {
"$ref": "CombinedAudienceGroup",
"description": "The combined audience ids of the included combined audience group.\nContains combined audience ids only."
},
"includedCustomListGroup": {
"$ref": "CustomListGroup",
"description": "The custom list ids of the included custom list group.\nContains custom list ids only."
},
"includedFirstAndThirdPartyAudienceGroups": {
"description": "The first and third party audience ids and recencies of included first\nand third party audience groups. Each first and third party audience group\ncontains first and third party audience ids only.\nThe relation between each first and third party audience group is\nINTERSECTION, and the result is UNION'ed with other audience groups.\nRepeated groups with same settings will be ignored.",
"items": {
"$ref": "FirstAndThirdPartyAudienceGroup"
},
"type": "array"
},
"includedGoogleAudienceGroup": {
"$ref": "GoogleAudienceGroup",
"description": "The Google audience ids of the included Google audience group.\nContains Google audience ids only."
}
},
"type": "object"
},
"AudioVideoOffset": {
"description": "The length an audio or a video has been played.",
"id": "AudioVideoOffset",
"properties": {
"percentage": {
"description": "The offset in percentage of the audio or video duration.",
"format": "int64",
"type": "string"
},
"seconds": {
"description": "The offset in seconds from the start of the audio or video.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"AuthorizedSellerStatusAssignedTargetingOptionDetails": {
"description": "Represents an assigned authorized seller status. This will be populated in\nthe details field of an AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.",
"id": "AuthorizedSellerStatusAssignedTargetingOptionDetails",
"properties": {
"authorizedSellerStatus": {
"description": "Output only. The authorized seller status to target.",
"enum": [
"AUTHORIZED_SELLER_STATUS_UNSPECIFIED",
"AUTHORIZED_SELLER_STATUS_AUTHORIZED_DIRECT_SELLERS_ONLY",
"AUTHORIZED_SELLER_STATUS_AUTHORIZED_AND_NON_PARTICIPATING_PUBLISHERS"
],
"enumDescriptions": [
"Default value when authorized seller status is not specified in this\nversion. This enum is a placeholder for default value and does not\nrepresent a real authorized seller status option.",
"Only authorized sellers that directly own the inventory being monetized, as\nindicated by a DIRECT declaration in the ads.txt file.",
"All authorized sellers, including publishers that have not posted an\nads.txt file. Display \u0026 Video 360 automatically disallows unauthorized\nsellers."
],
"type": "string"
},
"targetingOptionId": {
"description": "Required. The targeting_option_id of a\nTargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.",
"type": "string"
}
},
"type": "object"
},
"AuthorizedSellerStatusTargetingOptionDetails": {
"description": "Represents a targetable authorized seller status. This will be populated in\nthe\nauthorized_seller_status_details\nfield when targeting_type is\n`TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.",
"id": "AuthorizedSellerStatusTargetingOptionDetails",
"properties": {
"authorizedSellerStatus": {
"description": "Output only. The authorized seller status.",
"enum": [
"AUTHORIZED_SELLER_STATUS_UNSPECIFIED",
"AUTHORIZED_SELLER_STATUS_AUTHORIZED_DIRECT_SELLERS_ONLY",
"AUTHORIZED_SELLER_STATUS_AUTHORIZED_AND_NON_PARTICIPATING_PUBLISHERS"
],
"enumDescriptions": [
"Default value when authorized seller status is not specified in this\nversion. This enum is a placeholder for default value and does not\nrepresent a real authorized seller status option.",
"Only authorized sellers that directly own the inventory being monetized, as\nindicated by a DIRECT declaration in the ads.txt file.",
"All authorized sellers, including publishers that have not posted an\nads.txt file. Display \u0026 Video 360 automatically disallows unauthorized\nsellers."
],
"type": "string"
}
},
"type": "object"
},
"BiddingStrategy": {
"description": "Settings that control the bid strategy.\nBid strategy determines the bid price.",
"id": "BiddingStrategy",
"properties": {
"fixedBid": {
"$ref": "FixedBidStrategy",
"description": "A strategy that uses a fixed bid price."
},
"maximizeSpendAutoBid": {
"$ref": "MaximizeSpendBidStrategy",
"description": "A strategy that automatically adjusts the bid to optimize to your\nperformance goal while spending the full budget.\n\nAt insertion order level, the\nmarkup_type of line items\ncannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition,\nwhen\nperformance_goal_type\nis one of:\n\n* `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`\n* `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`\n* `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` ,\n\nthe line_item_type\nof the insertion order line items must be either:\n\n* `LINE_ITEM_TYPE_DISPLAY_DEFAULT`\n* `LINE_ITEM_TYPE_VIDEO_DEFAULT` ,\n\nand when\nperformance_goal_type\nis either:\n\n* `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA`\n* `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN`\n\nthe line_item_type\nof the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`."
},
"performanceGoalAutoBid": {
"$ref": "PerformanceGoalBidStrategy",
"description": "A strategy that automatically adjusts the bid to meet or beat a specified\nperformance goal. It is to be used only for a line item entity."
}
},
"type": "object"
},
"BrowserAssignedTargetingOptionDetails": {
"description": "Details for assigned browser targeting option. This will be populated in\nthe details field of an AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_BROWSER`.",
"id": "BrowserAssignedTargetingOptionDetails",
"properties": {
"displayName": {
"description": "Output only. The display name of the browser.",
"type": "string"
},
"negative": {
"description": "Indicates if this option is being negatively targeted. All assigned browser\ntargeting options on the same line item must have the same value for this\nfield.",
"type": "boolean"
},
"targetingOptionId": {
"description": "Required. The targeting_option_id of a\nTargetingOption of type `TARGETING_TYPE_BROWSER`.",
"type": "string"
}
},
"type": "object"
},
"BrowserTargetingOptionDetails": {
"description": "Represents a targetable browser. This will be populated in the\nbrowser_details field when\ntargeting_type is\n`TARGETING_TYPE_BROWSER`.",
"id": "BrowserTargetingOptionDetails",
"properties": {
"displayName": {
"description": "Output only. The display name of the browser.",
"type": "string"
}
},
"type": "object"
},
"BulkEditAdvertiserAssignedTargetingOptionsRequest": {
"description": "Request message for\nBulkEditAdvertiserAssignedTargetingOptions.",
"id": "BulkEditAdvertiserAssignedTargetingOptionsRequest",
"properties": {
"createRequests": {
"description": "The assigned targeting options to create in batch, specified as a list of\n`CreateAssignedTargetingOptionsRequest`.",
"items": {
"$ref": "CreateAssignedTargetingOptionsRequest"
},
"type": "array"
},
"deleteRequests": {
"description": "The assigned targeting options to delete in batch, specified as a list of\n`DeleteAssignedTargetingOptionsRequest`.",
"items": {
"$ref": "DeleteAssignedTargetingOptionsRequest"
},
"type": "array"
}
},
"type": "object"
},
"BulkEditAdvertiserAssignedTargetingOptionsResponse": {
"id": "BulkEditAdvertiserAssignedTargetingOptionsResponse",
"properties": {
"createdAssignedTargetingOptions": {
"description": "The list of assigned targeting options that have been successfully created.\n\nThis list will be absent if empty.",
"items": {
"$ref": "AssignedTargetingOption"
},
"type": "array"
}
},
"type": "object"
},
"BulkEditAssignedInventorySourcesRequest": {
"description": "Request message for AssignedInventorySourceService.BulkEdit.",
"id": "BulkEditAssignedInventorySourcesRequest",
"properties": {
"advertiserId": {
"description": "The ID of the advertiser that owns the parent inventory source group.\n\nThe parent partner does not have access to these assigned inventory\nsources.",
"format": "int64",
"type": "string"
},
"createdAssignedInventorySources": {
"description": "The assigned inventory sources to create in bulk, specified as a list of\nAssignedInventorySources.",
"items": {
"$ref": "AssignedInventorySource"
},
"type": "array"
},
"deletedAssignedInventorySources": {
"description": "The IDs of the assigned inventory sources to delete in bulk, specified as a\nlist of\nassigned_inventory_source_ids.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"partnerId": {
"description": "The ID of the partner that owns the inventory source group.\n\nOnly this partner has write access to these assigned inventory sources.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"BulkEditAssignedInventorySourcesResponse": {
"description": "Response message for AssignedInventorySourceService.BulkEdit.",
"id": "BulkEditAssignedInventorySourcesResponse",
"properties": {
"assignedInventorySources": {
"description": "The list of assigned inventory sources that have been successfully created.\n\nThis list will be absent if empty.",
"items": {
"$ref": "AssignedInventorySource"
},
"type": "array"
}
},
"type": "object"
},
"BulkEditAssignedLocationsRequest": {
"description": "Request message for AssignedLocationService.BulkEditAssignedLocations.",
"id": "BulkEditAssignedLocationsRequest",
"properties": {
"createdAssignedLocations": {
"description": "The assigned locations to create in bulk, specified as a list of\nAssignedLocations.",
"items": {
"$ref": "AssignedLocation"
},
"type": "array"
},
"deletedAssignedLocations": {
"description": "The IDs of the assigned locations to delete in bulk, specified as a list of\nassigned_location_ids.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"BulkEditAssignedLocationsResponse": {
"description": "Response message for AssignedLocationService.BulkEditAssignedLocations.",
"id": "BulkEditAssignedLocationsResponse",
"properties": {
"assignedLocations": {
"description": "The list of assigned locations that have been successfully created.\n\nThis list will be absent if empty.",
"items": {
"$ref": "AssignedLocation"
},
"type": "array"
}
},
"type": "object"
},
"BulkEditLineItemAssignedTargetingOptionsRequest": {
"description": "Request message for\nBulkEditLineItemAssignedTargetingOptions.",
"id": "BulkEditLineItemAssignedTargetingOptionsRequest",
"properties": {
"createRequests": {
"description": "The assigned targeting options to create in batch, specified as a list of\n`CreateAssignedTargetingOptionsRequest`.",
"items": {
"$ref": "CreateAssignedTargetingOptionsRequest"
},
"type": "array"
},
"deleteRequests": {
"description": "The assigned targeting options to delete in batch, specified as a list of\n`DeleteAssignedTargetingOptionsRequest`.",
"items": {
"$ref": "DeleteAssignedTargetingOptionsRequest"
},
"type": "array"
}
},
"type": "object"
},
"BulkEditLineItemAssignedTargetingOptionsResponse": {
"id": "BulkEditLineItemAssignedTargetingOptionsResponse",
"properties": {
"createdAssignedTargetingOptions": {
"description": "The list of assigned targeting options that have been successfully created.\n\nThis list will be absent if empty.",
"items": {
"$ref": "AssignedTargetingOption"
},
"type": "array"
}
},
"type": "object"
},
"BulkEditNegativeKeywordsRequest": {
"description": "Request message for NegativeKeywordService.BulkEditNegativeKeywords.",
"id": "BulkEditNegativeKeywordsRequest",
"properties": {
"createdNegativeKeywords": {
"description": "The negative keywords to create in batch, specified as a list of\nNegativeKeywords.",
"items": {
"$ref": "NegativeKeyword"
},
"type": "array"
},
"deletedNegativeKeywords": {
"description": "The negative keywords to delete in batch, specified as a list of\nkeyword_values.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"BulkEditNegativeKeywordsResponse": {
"description": "Response message for NegativeKeywordService.BulkEditNegativeKeywords.",
"id": "BulkEditNegativeKeywordsResponse",
"properties": {
"negativeKeywords": {
"description": "The list of negative keywords that have been successfully created.\n\nThis list will be absent if empty.",
"items": {
"$ref": "NegativeKeyword"
},
"type": "array"
}
},
"type": "object"
},
"BulkEditSitesRequest": {
"description": "Request message for SiteService.BulkEditSites.",
"id": "BulkEditSitesRequest",
"properties": {
"advertiserId": {
"description": "The ID of the advertiser that owns the parent channel.",
"format": "int64",
"type": "string"
},
"createdSites": {
"description": "The sites to create in batch, specified as a list of Sites.",
"items": {
"$ref": "Site"
},
"type": "array"
},
"deletedSites": {
"description": "The sites to delete in batch, specified as a list of site\nurl_or_app_ids.",
"items": {
"type": "string"
},
"type": "array"
},
"partnerId": {
"description": "The ID of the partner that owns the parent channel.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"BulkEditSitesResponse": {
"description": "Response message for SiteService.BulkEditSites.",
"id": "BulkEditSitesResponse",
"properties": {
"sites": {
"description": "The list of sites that have been successfully created.\n\nThis list will be absent if empty.",
"items": {
"$ref": "Site"
},
"type": "array"
}
},
"type": "object"
},
"BulkListAdvertiserAssignedTargetingOptionsResponse": {
"id": "BulkListAdvertiserAssignedTargetingOptionsResponse",
"properties": {
"assignedTargetingOptions": {
"description": "The list of assigned targeting options.\n\nThis list will be absent if empty.",
"items": {
"$ref": "AssignedTargetingOption"
},
"type": "array"
},
"nextPageToken": {
"description": "A token identifying the next page of results. This value should be\nspecified as the\npageToken\nin a subsequent BulkListAdvertiserAssignedTargetingOptionsRequest to\nfetch the next page of results. This token will be absent if there are no\nmore\nassigned_targeting_options\nto return.",
"type": "string"
}
},
"type": "object"
},
"BulkListLineItemAssignedTargetingOptionsResponse": {
"id": "BulkListLineItemAssignedTargetingOptionsResponse",
"properties": {
"assignedTargetingOptions": {
"description": "The list of assigned targeting options.\n\nThis list will be absent if empty.",
"items": {
"$ref": "AssignedTargetingOption"
},
"type": "array"
},
"nextPageToken": {
"description": "A token identifying the next page of results. This value should be\nspecified as the\npageToken in\na subsequent BulkListLineItemAssignedTargetingOptionsRequest to fetch\nthe next page of results. This token will be absent if there are no more\nassigned_targeting_options\nto return.",
"type": "string"
}
},
"type": "object"
},
"Campaign": {
"description": "A single campaign.",
"id": "Campaign",
"properties": {
"advertiserId": {
"description": "Output only. The unique ID of the advertiser the campaign belongs to.",
"format": "int64",
"type": "string"
},
"campaignFlight": {
"$ref": "CampaignFlight",
"description": "Required. The planned spend and duration of the campaign."
},
"campaignGoal": {
"$ref": "CampaignGoal",
"description": "Required. The goal of the campaign."
},
"campaignId": {
"description": "Output only. The unique ID of the campaign. Assigned by the system.",
"format": "int64",
"type": "string"
},
"displayName": {
"description": "Required. The display name of the campaign.\n\nMust be UTF-8 encoded with a maximum size of 240 bytes.",
"type": "string"
},
"entityStatus": {
"description": "Required. Controls whether or not the insertion orders under this campaign\ncan spend their budgets and bid on inventory.\n\n* Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and\n`ENTITY_STATUS_PAUSED`.\n* For\nCreateCampaign method,\n`ENTITY_STATUS_ARCHIVED` is not allowed.",
"enum": [
"ENTITY_STATUS_UNSPECIFIED",
"ENTITY_STATUS_ACTIVE",
"ENTITY_STATUS_ARCHIVED",
"ENTITY_STATUS_DRAFT",
"ENTITY_STATUS_PAUSED",
"ENTITY_STATUS_SCHEDULED_FOR_DELETION"
],
"enumDescriptions": [
"Default value when status is not specified or is unknown in this version.",
"The entity is enabled to bid and spend budget.",
"The entity is archived. Bidding and budget spending are disabled. An\nentity can be deleted after archived. Deleted entities cannot be retrieved.",
"The entity is under draft. Bidding and budget spending are disabled.",
"Bidding and budget spending are paused for the entity.",
"The entity is scheduled for deletion."
],
"type": "string"
},
"frequencyCap": {
"$ref": "FrequencyCap",
"description": "Required. The frequency cap setting of the campaign."
},
"name": {
"description": "Output only. The resource name of the campaign.",
"type": "string"
},
"updateTime": {
"description": "Output only. The timestamp when the campaign was last updated. Assigned by the system.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"CampaignFlight": {
"description": "Settings that track the planned spend and duration of a campaign.",
"id": "CampaignFlight",
"properties": {
"plannedDates": {
"$ref": "DateRange",
"description": "Required. The dates that the campaign is expected to run. They are resolved\nrelative to the parent advertiser's time zone.\n\n* The dates specified here will not affect serving. They are used to\ngenerate alerts and warnings. For example, if the flight date of any child\ninsertion order is outside the range of these dates, the user interface\nwill show a warning.\n* `start_date` is required and must be the current date or later.\n* `end_date` is optional. If specified, it must be the `start_date` or\nlater.\n* Any specified date must be before the year 2037."
},
"plannedSpendAmountMicros": {
"description": "The amount the campaign is expected to spend for its given\nplanned_dates. This will not limit serving,\nbut will be used for tracking spend in the DV360 UI.\n\nThe amount is in micros. Must be greater than or equal to 0. For example,\n500000000 represents 500 standard units of the currency.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"CampaignGoal": {
"description": "Settings that control the goal of a campaign.",
"id": "CampaignGoal",
"properties": {
"campaignGoalType": {
"description": "Required. The type of the campaign goal.",
"enum": [
"CAMPAIGN_GOAL_TYPE_UNSPECIFIED",
"CAMPAIGN_GOAL_TYPE_APP_INSTALL",
"CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS",
"CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION",
"CAMPAIGN_GOAL_TYPE_ONLINE_ACTION"
],
"enumDescriptions": [
"Goal value is not specified or unknown in this version.",
"Drive app installs or engagements.",
"Raise awareness of a brand or product.",
"Drive offline or in-store sales.",
"Drive online action or visits."
],
"type": "string"
},
"performanceGoal": {
"$ref": "PerformanceGoal",
"description": "Required. The performance goal of the campaign.\n\nAcceptable values for\nperformance_goal_type are:\n\n* `PERFORMANCE_GOAL_TYPE_CPM`\n* `PERFORMANCE_GOAL_TYPE_CPC`\n* `PERFORMANCE_GOAL_TYPE_CPA`\n* `PERFORMANCE_GOAL_TYPE_CPIAVC`\n* `PERFORMANCE_GOAL_TYPE_CTR`\n* `PERFORMANCE_GOAL_TYPE_VIEWABILITY`\n* `PERFORMANCE_GOAL_TYPE_OTHER`"
}
},
"type": "object"
},
"CarrierAndIspAssignedTargetingOptionDetails": {
"description": "Details for assigned carrier and ISP targeting option. This will be populated\nin the details field of an AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_CARRIER_AND_ISP`.",
"id": "CarrierAndIspAssignedTargetingOptionDetails",
"properties": {
"displayName": {
"description": "Output only. The display name of the carrier or ISP.",
"type": "string"
},
"negative": {
"description": "Indicates if this option is being negatively targeted. All assigned carrier\nand ISP targeting options on the same line item must have the same value\nfor this field.",
"type": "boolean"
},
"targetingOptionId": {
"description": "Required. The targeting_option_id of a\nTargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.",
"type": "string"
}
},
"type": "object"
},
"CarrierAndIspTargetingOptionDetails": {
"description": "Represents a targetable carrier or ISP. This will be populated in the\ncarrier_and_isp_details field of\na TargetingOption when\ntargeting_type is\n`TARGETING_TYPE_CARRIER_AND_ISP`.",
"id": "CarrierAndIspTargetingOptionDetails",
"properties": {
"displayName": {
"description": "Output only. The display name of the carrier or ISP.",
"type": "string"
},
"type": {
"description": "Output only. The type indicating if it's carrier or ISP.",
"enum": [
"CARRIER_AND_ISP_TYPE_UNSPECIFIED",
"CARRIER_AND_ISP_TYPE_ISP",
"CARRIER_AND_ISP_TYPE_CARRIER"
],
"enumDescriptions": [
"Default value when type is not specified or is unknown in this version.",
"Indicates this targeting resource refers to an ISP.",
"Indicates this targeting resource refers to a mobile carrier."
],
"type": "string"
}
},
"type": "object"
},
"CategoryAssignedTargetingOptionDetails": {
"description": "Assigned category targeting option details. This will be populated in the\ncategory_details field when\ntargeting_type is\n`TARGETING_TYPE_CATEGORY`.",
"id": "CategoryAssignedTargetingOptionDetails",
"properties": {
"displayName": {
"description": "Output only. The display name of the category.",
"type": "string"
},
"negative": {
"description": "Indicates if this option is being negatively targeted.",
"type": "boolean"
},
"targetingOptionId": {
"description": "Required. The targeting_option_id field when\ntargeting_type is\n`TARGETING_TYPE_CATEGORY`.",
"type": "string"
}
},
"type": "object"
},
"CategoryTargetingOptionDetails": {
"description": "Represents a targetable category. This will be populated in the\ncategory_details field of a\nTargetingOption when targeting_type is\n`TARGETING_TYPE_CATEGORY`.",
"id": "CategoryTargetingOptionDetails",
"properties": {
"displayName": {
"description": "Output only. The display name of the category.",
"type": "string"
}
},
"type": "object"
},
"Channel": {
"description": "A single channel. Channels are custom groups of related websites and apps.",
"id": "Channel",
"properties": {
"advertiserId": {
"description": "The ID of the advertiser that owns the channel.",
"format": "int64",
"type": "string"
},
"channelId": {
"description": "Output only. The unique ID of the channel. Assigned by the system.",
"format": "int64",
"type": "string"
},
"displayName": {
"description": "Required. The display name of the channel.\nMust be UTF-8 encoded with a maximum length of 240 bytes.",
"type": "string"
},
"name": {
"description": "Output only. The resource name of the channel.",
"type": "string"
},
"partnerId": {
"description": "The ID of the partner that owns the channel.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"ChannelAssignedTargetingOptionDetails": {
"description": "Details for assigned channel targeting option. This will be populated in\nthe details field of an AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_CHANNEL`.",
"id": "ChannelAssignedTargetingOptionDetails",
"properties": {
"channelId": {
"description": "Required. ID of the channel. Should refer to the channel ID\nfield on a\n[Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or\n[advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id)\nresource.",
"format": "int64",
"type": "string"
},
"negative": {
"description": "Indicates if this option is being negatively targeted. For advertiser\nlevel assigned targeting option, this field must be true.",
"type": "boolean"
}
},
"type": "object"
},
"CmHybridConfig": {
"description": "Settings for advertisers that use both Campaign Manager (CM) and third-party\nad servers.",
"id": "CmHybridConfig",
"properties": {
"cmAccountId": {
"description": "Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360\nadvertiser.",
"format": "int64",
"type": "string"
},
"cmFloodlightConfigId": {
"description": "Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser.",
"format": "int64",
"type": "string"
},
"cmFloodlightLinkingAuthorized": {
"description": "Required. Immutable. By setting this field to `true`, you, on behalf of your company,\nauthorize the sharing of information from the given Floodlight\nconfiguration to this Display \u0026 Video 360 advertiser.",
"type": "boolean"
},
"cmSyncableSiteIds": {
"description": "A list of CM sites whose placements will be synced to DV360 as creatives.\n\nIf absent or empty in\nCreateAdvertiser method, the system\nwill automatically create a CM site.\n\nRemoving sites from this list may cause DV360 creatives synced from CM to\nbe deleted. At least one site must be specified.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"dv360ToCmCostReportingEnabled": {
"description": "Whether or not to report DV360 cost to CM.",
"type": "boolean"
},
"dv360ToCmDataSharingEnabled": {
"description": "Whether or not to include DV360 data in CM data transfer reports.",
"type": "boolean"
}
},
"type": "object"
},
"CmTrackingAd": {
"description": "A Campaign Manager tracking ad.",
"id": "CmTrackingAd",
"properties": {
"cmAdId": {
"description": "The ad ID of the campaign manager tracking Ad.",
"format": "int64",
"type": "string"
},
"cmCreativeId": {
"description": "The creative ID of the campaign manager tracking Ad.",
"format": "int64",
"type": "string"
},
"cmPlacementId": {
"description": "The placement ID of the campaign manager tracking Ad.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"CombinedAudience": {
"description": "Describes a combined audience resource.",
"id": "CombinedAudience",
"properties": {
"combinedAudienceId": {
"description": "Output only. The unique ID of the combined audience. Assigned by the system.",
"format": "int64",
"type": "string"
},
"displayName": {
"description": "Output only. The display name of the combined audience.\n.",
"type": "string"
},
"name": {
"description": "Output only. The resource name of the combined audience.",
"type": "string"
}
},
"type": "object"
},
"CombinedAudienceGroup": {
"description": "Details of combined audience group.\nAll combined audience targeting settings are logically ‘OR’ of each other.",
"id": "CombinedAudienceGroup",
"properties": {
"settings": {
"description": "Required. All combined audience targeting settings in combined audience group.\nRepeated settings with same id will be ignored.\nThe number of combined audience settings should be no more than five, error\nwill be thrown otherwise.",
"items": {
"$ref": "CombinedAudienceTargetingSetting"
},
"type": "array"
}
},
"type": "object"
},
"CombinedAudienceTargetingSetting": {
"description": "Details of combined audience targeting setting.",
"id": "CombinedAudienceTargetingSetting",
"properties": {
"combinedAudienceId": {
"description": "Required. Combined audience id of combined audience targeting setting.\nThis id is combined_audience_id.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"ContentInstreamPositionAssignedTargetingOptionDetails": {
"description": "Assigned content instream position targeting option details. This will be\npopulated in the\ncontent_instream_position_details\nfield when\ntargeting_type is\n`TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.",
"id": "ContentInstreamPositionAssignedTargetingOptionDetails",
"properties": {
"contentInstreamPosition": {
"description": "Output only. The content instream position for video or audio ads.",
"enum": [
"CONTENT_INSTREAM_POSITION_UNSPECIFIED",
"CONTENT_INSTREAM_POSITION_PRE_ROLL",
"CONTENT_INSTREAM_POSITION_MID_ROLL",
"CONTENT_INSTREAM_POSITION_POST_ROLL"
],
"enumDescriptions": [
"Content instream position is not specified in this version. This enum is a\nplace holder for a default value and does not represent a real in stream ad\nposition.",
"Ads that play before streaming content.",
"Ads that play between the beginning and end of streaming content.",
"Ads that play at the end of streaming content."
],
"type": "string"
},
"targetingOptionId": {
"description": "Required. The targeting_option_id field when\ntargeting_type is\n`TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.",
"type": "string"
}
},
"type": "object"
},
"ContentInstreamPositionTargetingOptionDetails": {
"description": "Represents a targetable content instream position, which could be used by\nvideo and audio ads. This will be populated in the\ncontent_instream_position_details\nfield when targeting_type is\n`TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.",
"id": "ContentInstreamPositionTargetingOptionDetails",
"properties": {
"contentInstreamPosition": {
"description": "Output only. The content instream position.",
"enum": [
"CONTENT_INSTREAM_POSITION_UNSPECIFIED",
"CONTENT_INSTREAM_POSITION_PRE_ROLL",
"CONTENT_INSTREAM_POSITION_MID_ROLL",
"CONTENT_INSTREAM_POSITION_POST_ROLL"
],
"enumDescriptions": [
"Content instream position is not specified in this version. This enum is a\nplace holder for a default value and does not represent a real in stream ad\nposition.",
"Ads that play before streaming content.",
"Ads that play between the beginning and end of streaming content.",
"Ads that play at the end of streaming content."
],
"type": "string"
}
},
"type": "object"
},
"ContentOutstreamPositionAssignedTargetingOptionDetails": {
"description": "Assigned content outstream position targeting option details. This will be\npopulated in the\ncontent_outstream_position_details\nfield when\ntargeting_type is\n`TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.",
"id": "ContentOutstreamPositionAssignedTargetingOptionDetails",
"properties": {
"contentOutstreamPosition": {
"description": "Output only. The content outstream position.",
"enum": [
"CONTENT_OUTSTREAM_POSITION_UNSPECIFIED",
"CONTENT_OUTSTREAM_POSITION_UNKNOWN",
"CONTENT_OUTSTREAM_POSITION_IN_ARTICLE",
"CONTENT_OUTSTREAM_POSITION_IN_BANNER",
"CONTENT_OUTSTREAM_POSITION_IN_FEED",
"CONTENT_OUTSTREAM_POSITION_INTERSTITIAL"
],
"enumDescriptions": [
"Content outstream position is not specified in this version. This enum is a\nplace holder for a default value and does not represent a real content\noutstream position.",
"The ad position is unknown in the content outstream.",
"Ads that appear between the paragraphs of your pages.",
"Ads that display on the top and the sides of a page.",
"Ads that appear in a scrollable stream of content. A feed is typically\neditorial (e.g. a list of articles or news) or listings (e.g. a list of\nproducts or services).",
"Ads shown before or between content loads."
],
"type": "string"
},
"targetingOptionId": {
"description": "Required. The targeting_option_id field when\ntargeting_type is\n`TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.",
"type": "string"
}
},
"type": "object"
},
"ContentOutstreamPositionTargetingOptionDetails": {
"description": "Represents a targetable content outstream position, which could be used by\ndisplay and video ads. This will be populated in the\ncontent_outstream_position_details\nfield when targeting_type is\n`TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.",
"id": "ContentOutstreamPositionTargetingOptionDetails",
"properties": {
"contentOutstreamPosition": {
"description": "Output only. The content outstream position.",
"enum": [
"CONTENT_OUTSTREAM_POSITION_UNSPECIFIED",
"CONTENT_OUTSTREAM_POSITION_UNKNOWN",
"CONTENT_OUTSTREAM_POSITION_IN_ARTICLE",
"CONTENT_OUTSTREAM_POSITION_IN_BANNER",
"CONTENT_OUTSTREAM_POSITION_IN_FEED",
"CONTENT_OUTSTREAM_POSITION_INTERSTITIAL"
],
"enumDescriptions": [
"Content outstream position is not specified in this version. This enum is a\nplace holder for a default value and does not represent a real content\noutstream position.",
"The ad position is unknown in the content outstream.",
"Ads that appear between the paragraphs of your pages.",
"Ads that display on the top and the sides of a page.",
"Ads that appear in a scrollable stream of content. A feed is typically\neditorial (e.g. a list of articles or news) or listings (e.g. a list of\nproducts or services).",
"Ads shown before or between content loads."
],
"type": "string"
}
},
"type": "object"
},
"ConversionCountingConfig": {
"description": "Settings that control how conversions are counted.\n\nAll post-click conversions will be counted. A percentage value can be set\nfor post-view conversions counting.",
"id": "ConversionCountingConfig",
"properties": {
"floodlightActivityConfigs": {
"description": "The Floodlight activity configs used to track conversions.\n\nThe number of conversions counted is the sum of all of the conversions\ncounted by all of the Floodlight activity IDs specified in this field.",
"items": {
"$ref": "TrackingFloodlightActivityConfig"
},
"type": "array"
},
"postViewCountPercentageMillis": {
"description": "The percentage of post-view conversions to count, in millis (1/1000 of a\npercent). Must be between 0 and 100000 inclusive.\n\nFor example, to track 50% of the post-click conversions, set a value of\n50000.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"CounterEvent": {
"description": "Counter event of the creative.",
"id": "CounterEvent",
"properties": {
"name": {
"description": "Required. The name of the counter event.",
"type": "string"
},
"reportingName": {
"description": "Required. The name used to identify this counter event in reports.",
"type": "string"
}
},
"type": "object"
},
"CreateAssetRequest": {
"description": "A request message for CreateAsset.",
"id": "CreateAssetRequest",
"properties": {
"filename": {
"description": "Required. The filename of the asset, including the file extension.\n\nThe filename must be UTF-8 encoded with a maximum size of 240 bytes.",
"type": "string"
}
},
"type": "object"
},
"CreateAssetResponse": {
"description": "A response message for CreateAsset.",
"id": "CreateAssetResponse",
"properties": {
"asset": {
"$ref": "Asset",
"description": "The uploaded asset, if successful."
}
},
"type": "object"
},
"CreateAssignedTargetingOptionsRequest": {
"description": "A request listing which assigned targeting options of a given targeting type\nshould be created and added.",
"id": "CreateAssignedTargetingOptionsRequest",
"properties": {
"assignedTargetingOptions": {
"description": "Required. The assigned targeting options to create and add.",
"items": {
"$ref": "AssignedTargetingOption"
},
"type": "array"
},
"targetingType": {
"description": "Required. Identifies the type of this assigned targeting option.",
"enum": [
"TARGETING_TYPE_UNSPECIFIED",
"TARGETING_TYPE_CHANNEL",
"TARGETING_TYPE_APP_CATEGORY",
"TARGETING_TYPE_APP",
"TARGETING_TYPE_URL",
"TARGETING_TYPE_DAY_AND_TIME",
"TARGETING_TYPE_AGE_RANGE",
"TARGETING_TYPE_REGIONAL_LOCATION_LIST",
"TARGETING_TYPE_PROXIMITY_LOCATION_LIST",
"TARGETING_TYPE_GENDER",
"TARGETING_TYPE_VIDEO_PLAYER_SIZE",
"TARGETING_TYPE_USER_REWARDED_CONTENT",
"TARGETING_TYPE_PARENTAL_STATUS",
"TARGETING_TYPE_CONTENT_INSTREAM_POSITION",
"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION",
"TARGETING_TYPE_DEVICE_TYPE",
"TARGETING_TYPE_AUDIENCE_GROUP",
"TARGETING_TYPE_BROWSER",
"TARGETING_TYPE_HOUSEHOLD_INCOME",
"TARGETING_TYPE_ON_SCREEN_POSITION",
"TARGETING_TYPE_THIRD_PARTY_VERIFIER",
"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION",
"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION",
"TARGETING_TYPE_ENVIRONMENT",
"TARGETING_TYPE_CARRIER_AND_ISP",
"TARGETING_TYPE_OPERATING_SYSTEM",
"TARGETING_TYPE_DEVICE_MAKE_MODEL",
"TARGETING_TYPE_KEYWORD",
"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST",
"TARGETING_TYPE_VIEWABILITY",
"TARGETING_TYPE_CATEGORY",
"TARGETING_TYPE_INVENTORY_SOURCE",
"TARGETING_TYPE_LANGUAGE",
"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS",
"TARGETING_TYPE_GEO_REGION",
"TARGETING_TYPE_INVENTORY_SOURCE_GROUP",
"TARGETING_TYPE_EXCHANGE",
"TARGETING_TYPE_SUB_EXCHANGE"
],
"enumDescriptions": [
"Default value when type is not specified or is unknown in this version.",
"Target a channel (a custom group of related websites or apps).",
"Target an app category (for example, education or puzzle games).",
"Target a specific app (for example, Angry Birds).",
"Target a specific url (for example, quora.com).",
"Target ads during a chosen time period on a specific day.",
"Target ads to a specific age range (for example, 18-24).",
"Target ads to the specified regions on a regional location list.",
"Target ads to the specified points of interest on a proximity location\nlist.",
"Target ads to a specific gender (for example, female or male).",
"Target a specific video player size for video ads.",
"Target user rewarded content for video ads.",
"Target ads to a specific parental status (for example, parent or not a\nparent).",
"Target video or audio ads in a specific content instream position (for\nexample, pre-roll, mid-roll, or post-roll).",
"Target ads in a specific content outstream position.",
"Target ads to a specific device type (for example, tablet or connected TV).",
"Target ads to an audience or groups of audiences.\nSingleton field, at most one can exist on a single Lineitem at a time.",
"Target ads to specific web browsers (for example, Chrome).",
"Target ads to a specific household income range (for example, top 10%).",
"Target ads in a specific on screen position.",
"Filter web sites through third party verification (for example, IAS or\nDoubleVerify).",
"Filter web sites by specific digital content label ratings (for example,\nDL-MA: suitable only for mature audiences).",
"Filter website content by sensitive categories (for example, adult).",
"Target ads to a specific environment (for example, web or app).",
"Target ads to a specific network carrier or internet service provider\n(ISP) (for example, Comcast or Orange).",
"Target ads to a specific operating system (for example, macOS).",
"Target ads to a specific device make or model (for example, Roku or\nSamsung).",
"Target ads to a specific keyword (for example, dog or retriever).",
"Target ads to a specific negative keyword list.",
"Target ads to a specific viewability (for example, 80% viewable).",
"Target ads to a specific content category (for example, arts \u0026\nentertainment).",
"Purchase impressions from specific deals and auction packages.",
"Target ads to a specific language (for example, English or Japanese).",
"Target ads to ads.txt authorized sellers.",
"Target ads to a specific regional location (for example, a city or state).",
"Purchase impressions from a group of deals and auction packages.",
"Purchase impressions from specific exchanges.",
"Purchase impressions from specific sub-exchanges."
],
"type": "string"
}
},
"type": "object"
},
"CreateSdfDownloadTaskRequest": {
"description": "Request message for [SdfDownloadTaskService.CreateSdfDownloadTask].",
"id": "CreateSdfDownloadTaskRequest",
"properties": {
"advertiserId": {
"description": "The ID of the advertiser to download SDF for.",
"format": "int64",
"type": "string"
},
"idFilter": {
"$ref": "IdFilter",
"description": "Filters on entities by their entity IDs."
},
"inventorySourceFilter": {
"$ref": "InventorySourceFilter",
"description": "Filters on Inventory Sources by their IDs."
},
"parentEntityFilter": {
"$ref": "ParentEntityFilter",
"description": "Filters on selected file types. The entities in each file are filtered\n by a chosen set of filter entities. The filter entities must be the same\n type as, or a parent type of, the selected file types."
},
"partnerId": {
"description": "The ID of the partner to download SDF for.",
"format": "int64",
"type": "string"
},
"version": {
"description": "Required. The SDF version of the downloaded file. If set to\n`SDF_VERSION_UNSPECIFIED`, this will default to the version specified by\nthe advertiser or partner identified by `root_id`. An advertiser inherits\nits SDF version from its partner unless configured otherwise.",
"enum": [
"SDF_VERSION_UNSPECIFIED",
"SDF_VERSION_3_1",
"SDF_VERSION_4",
"SDF_VERSION_4_1",
"SDF_VERSION_4_2",
"SDF_VERSION_5",
"SDF_VERSION_5_1"
],
"enumDescriptions": [
"SDF version value is not specified or is unknown in this version.",
"SDF version 3.1",
"SDF version 4",
"SDF version 4.1",
"SDF version 4.2",
"SDF version 5.",
"SDF version 5.1"
],
"type": "string"
}
},
"type": "object"
},
"Creative": {
"description": "A single Creative.",
"id": "Creative",
"properties": {
"additionalDimensions": {
"description": "Additional dimensions.\nApplicable when creative_type is one of:\n\n* `CREATIVE_TYPE_STANDARD`\n* `CREATIVE_TYPE_EXPANDABLE`\n* `CREATIVE_TYPE_NATIVE`\n* `CREATIVE_TYPE_TEMPLATED_APP_INSTALL`\n* `CREATIVE_TYPE_NATIVE_SITE_SQUARE`\n* `CREATIVE_TYPE_LIGHTBOX`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`\n* `CREATIVE_TYPE_PUBLISHER_HOSTED`\n\nIf this field is specified, width_pixels and\nheight_pixels are both required and must be\ngreater than or equal to 0.",
"items": {
"$ref": "Dimensions"
},
"type": "array"
},
"advertiserId": {
"description": "Output only. The unique ID of the advertiser the creative belongs to.",
"format": "int64",
"type": "string"
},
"appendedTag": {
"description": "Third-party HTML tracking tag to be appended to the creative tag.",
"type": "string"
},
"assets": {
"description": "Required. Assets associated to this creative.\nAssets can be associated to the creative in one of following roles:\n\n* `ASSET_ROLE_UNSPECIFIED`\n* `ASSET_ROLE_MAIN`\n* `ASSET_ROLE_BACKUP`\n* `ASSET_ROLE_POLITE_LOAD`",
"items": {
"$ref": "AssetAssociation"
},
"type": "array"
},
"cmPlacementId": {
"description": "Output only. The unique ID of the Campaign Manager placement associated with the\ncreative.\nThis field is only applicable for creatives that are synced from Campaign\nManager.",
"format": "int64",
"type": "string"
},
"cmTrackingAd": {
"$ref": "CmTrackingAd",
"description": "The Campaign Manager tracking ad associated with the creative.\n\nOptional for the following creative_type when\ncreated by an advertiser that uses both Campaign Manager and third-party ad\nserving:\n\n* `CREATIVE_TYPE_NATIVE`\n* `CREATIVE_TYPE_NATIVE_SITE_SQUARE`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`\n\nOutput only for other cases."
},
"companionCreativeIds": {
"description": "The IDs of companion creatives for a video creative.\n\nYou can assign existing display creatives (with image or HTML5 assets)\nto serve surrounding the publisher's video player. Companions display\naround the video player while the video is playing and remain after the\nvideo has completed.\n\nCreatives contain additional dimensions\ncan not be companion creatives.\n\nThis field is only supported for following\ncreative_type:\n\n* `CREATIVE_TYPE_AUDIO`\n* `CREATIVE_TYPE_VIDEO`",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"counterEvents": {
"description": "Counter events for a rich media creative.\nCounters track the number of times that a user interacts with any part of a\nrich media creative in a specified way (mouse-overs, mouse-outs, clicks,\ntaps, data loading, keyboard entries, etc.).\nAny event that can be captured in the creative can be recorded as a\ncounter.\nLeave it empty or unset for creatives containing image assets only.",
"items": {
"$ref": "CounterEvent"
},
"type": "array"
},
"createTime": {
"description": "Output only. The timestamp when the creative was created. Assigned by\nthe system.",
"format": "google-datetime",
"type": "string"
},
"creativeAttributes": {
"description": "Output only. A list of attributes of the creative that is generated by the system.",
"enumDescriptions": [
"The creative attribute is not specified or is unknown in this version.",
"The creative is a VAST creative.",
"The creative is a linear VPAID creative.",
"The creative is a non-linear VPAID creative."
],
"items": {
"enum": [
"CREATIVE_ATTRIBUTE_UNSPECIFIED",
"CREATIVE_ATTRIBUTE_VAST",
"CREATIVE_ATTRIBUTE_VPAID_LINEAR",
"CREATIVE_ATTRIBUTE_VPAID_NON_LINEAR"
],
"type": "string"
},
"type": "array"
},
"creativeId": {
"description": "Output only. The unique ID of the creative. Assigned by the system.",
"format": "int64",
"type": "string"
},
"creativeType": {
"description": "Required. Immutable. The type of the creative.",
"enum": [
"CREATIVE_TYPE_UNSPECIFIED",
"CREATIVE_TYPE_STANDARD",
"CREATIVE_TYPE_EXPANDABLE",
"CREATIVE_TYPE_VIDEO",
"CREATIVE_TYPE_NATIVE",
"CREATIVE_TYPE_TEMPLATED_APP_INSTALL",
"CREATIVE_TYPE_NATIVE_SITE_SQUARE",
"CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL",
"CREATIVE_TYPE_LIGHTBOX",
"CREATIVE_TYPE_NATIVE_APP_INSTALL",
"CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE",
"CREATIVE_TYPE_AUDIO",
"CREATIVE_TYPE_PUBLISHER_HOSTED",
"CREATIVE_TYPE_NATIVE_VIDEO",
"CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO"
],
"enumDescriptions": [
"Type value is not specified or is unknown in this version.",
"Standard display creative.\n\nCreate and update methods are supported for this creative type if the\nhosting_source is one of the following:\n\n* `HOSTING_SOURCE_HOSTED`\n* `HOSTING_SOURCE_THIRD_PARTY`",
"Expandable creative.\n\nCreate and update methods are supported for this creative type if the\nhosting_source is `HOSTING_SOURCE_THIRD_PARTY`",
"Video creative.\n\nCreate and update methods are supported for this creative type if the\nhosting_source is one of the following:\n\n* `HOSTING_SOURCE_HOSTED`\n* `HOSTING_SOURCE_THIRD_PARTY`",
"Native creative rendered by publishers with assets from advertiser.\n\nCreate and update methods are supported for this creative type if the\nhosting_source is `HOSTING_SOURCE_HOSTED`",
"Templated app install mobile creative (banner).\n\nCreate and update methods are **not** supported for this creative type.",
"Square native creative.\n\nCreate and update methods are supported for this creative type if the\nhosting_source is `HOSTING_SOURCE_HOSTED`",
"Interstitial creative including both display and video.\n\nCreate and update methods are **not** supported for this creative type.",
"Responsive and expandable Lightbox creative.\n\nCreate and update methods are **not** supported for this creative type.",
"Native app install creative.\n\nCreate and update methods are supported for this creative type if the\nhosting_source is `HOSTING_SOURCE_HOSTED`",
"Square native app install creative.\n\nCreate and update methods are supported for this creative type if the\nhosting_source is `HOSTING_SOURCE_HOSTED`",
"Audio creative.\n\nCreate and update methods are supported for this creative type if the\nhosting_source is `HOSTING_SOURCE_HOSTED`",
"Publisher hosted creative.\n\nCreate and update methods are **not** supported for this creative type.",
"Native video creative.\n\nCreate and update methods are supported for this creative type if the\nhosting_source is `HOSTING_SOURCE_HOSTED`",
"Templated app install mobile video creative.\n\nCreate and update methods are **not** supported for this creative type."
],
"type": "string"
},
"dimensions": {
"$ref": "Dimensions",
"description": "Required. Primary dimensions of the creative.\nApplicable to all creative types. The value of\nwidth_pixels and\nheight_pixels defaults to `0`\nwhen creative_type is one of:\n\n* `CREATIVE_TYPE_VIDEO`\n* `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL`\n* `CREATIVE_TYPE_AUDIO`\n* `CREATIVE_TYPE_NATIVE_VIDEO`\n* `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO`"
},
"displayName": {
"description": "Required. The display name of the creative.\n\nMust be UTF-8 encoded with a maximum size of 240 bytes.",
"type": "string"
},
"dynamic": {
"description": "Output only. Indicates whether the creative is dynamic.",
"type": "boolean"
},
"entityStatus": {
"description": "Required. Controls whether or not the creative can serve.\n\nAccepted values are:\n\n* `ENTITY_STATUS_ACTIVE`\n* `ENTITY_STATUS_ARCHIVED`\n* `ENTITY_STATUS_PAUSED`",
"enum": [
"ENTITY_STATUS_UNSPECIFIED",
"ENTITY_STATUS_ACTIVE",
"ENTITY_STATUS_ARCHIVED",
"ENTITY_STATUS_DRAFT",
"ENTITY_STATUS_PAUSED",
"ENTITY_STATUS_SCHEDULED_FOR_DELETION"
],
"enumDescriptions": [
"Default value when status is not specified or is unknown in this version.",
"The entity is enabled to bid and spend budget.",
"The entity is archived. Bidding and budget spending are disabled. An\nentity can be deleted after archived. Deleted entities cannot be retrieved.",
"The entity is under draft. Bidding and budget spending are disabled.",
"Bidding and budget spending are paused for the entity.",
"The entity is scheduled for deletion."
],
"type": "string"
},
"exitEvents": {
"description": "Required. Exit events for this creative.\nAn exit (also known as a click tag) is any area in your creative that\nsomeone can click or tap to open an advertiser's landing page.\nEvery creative must include at least one exit.\nYou can add an exit to your creative in any of the following ways:\n\n* Use Google Web Designer's tap area.\n* Define a JavaScript variable called \"clickTag\".\n* Use the Enabler (Enabler.exit()) to track exits in rich media formats.",
"items": {
"$ref": "ExitEvent"
},
"type": "array"
},
"expandOnHover": {
"description": "Optional. Indicates the creative will automatically expand on hover.\n\nOptional and only valid for third-party expandable creatives.\nThird-party expandable creatives are creatives with following hosting\nsource:\n\n* `HOSTING_SOURCE_THIRD_PARTY`\n\ncombined with following creative_type:\n\n* `CREATIVE_TYPE_EXPANDABLE`",
"type": "boolean"
},
"expandingDirection": {
"description": "Optional. Specifies the expanding direction of the creative.\n\nRequired and only valid for third-party expandable creatives.\n\nThird-party expandable creatives are creatives with following hosting\nsource:\n\n* `HOSTING_SOURCE_THIRD_PARTY`\n\ncombined with following creative_type:\n\n* `CREATIVE_TYPE_EXPANDABLE`",
"enum": [
"EXPANDING_DIRECTION_UNSPECIFIED",
"EXPANDING_DIRECTION_NONE",
"EXPANDING_DIRECTION_UP",
"EXPANDING_DIRECTION_DOWN",
"EXPANDING_DIRECTION_LEFT",
"EXPANDING_DIRECTION_RIGHT",
"EXPANDING_DIRECTION_UP_AND_LEFT",
"EXPANDING_DIRECTION_UP_AND_RIGHT",
"EXPANDING_DIRECTION_DOWN_AND_LEFT",
"EXPANDING_DIRECTION_DOWN_AND_RIGHT",
"EXPANDING_DIRECTION_UP_OR_DOWN",
"EXPANDING_DIRECTION_LEFT_OR_RIGHT",
"EXPANDING_DIRECTION_ANY_DIAGONAL"
],
"enumDescriptions": [
"The expanding direction is not specified.",
"Does not expand in any direction.",
"Expands up.",
"Expands down.",
"Expands left.",
"Expands right.",
"Expands up and to the left side.",
"Expands up and to the right side.",
"Expands down and to the left side.",
"Expands down and to the right side.",
"Expands either up or down.",
"Expands to either the left or the right side.",
"Can expand in any diagonal direction."
],
"type": "string"
},
"hostingSource": {
"description": "Required. Indicates where the creative is hosted.",
"enum": [
"HOSTING_SOURCE_UNSPECIFIED",
"HOSTING_SOURCE_CM",
"HOSTING_SOURCE_THIRD_PARTY",
"HOSTING_SOURCE_HOSTED",
"HOSTING_SOURCE_RICH_MEDIA"
],
"enumDescriptions": [
"Hosting source is not specified or is unknown in this version.",
"A creative synced from Campaign Manager.\n\nCreate and update methods are **not** supported for this hosting type.",
"A creative hosted by a third-party ad server (3PAS).\n\nCreate and update methods are supported for this hosting type if the\ncreative_type is one of the following:\n\n* `CREATIVE_TYPE_EXPANDABLE`\n* `CREATIVE_TYPE_STANDARD`\n* `CREATIVE_TYPE_VIDEO`",
"A creative created in DV360 and hosted by Campaign Manager.\n\nCreate and update methods are supported for this hosting type if the\ncreative_type is one of the following:\n\n* `CREATIVE_TYPE_AUDIO`\n* `CREATIVE_TYPE_NATIVE`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`\n* `CREATIVE_TYPE_NATIVE_SITE_SQUARE`\n* `CREATIVE_TYPE_NATIVE_VIDEO`\n* `CREATIVE_TYPE_STANDARD`\n* `CREATIVE_TYPE_VIDEO`",
"A rich media creative created in Studio and hosted by Campaign Manager.\n\nCreate and update methods are **not** supported for this hosting type."
],
"type": "string"
},
"html5Video": {
"description": "Output only. Indicates the third-party VAST tag creative requires HTML5 Video support.\n\nOutput only and only valid for third-party VAST tag creatives.\n\nThird-party VAST tag creatives are creatives with following\nhosting_source:\n\n* `HOSTING_SOURCE_THIRD_PARTY`\n\ncombined with following creative_type:\n\n* `CREATIVE_TYPE_VIDEO`",
"type": "boolean"
},
"iasCampaignMonitoring": {
"description": "Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled.\nTo enable this for the creative, make sure the\nAdvertiser.creative_config.ias_client_id\nhas been set to your IAS client ID.",
"type": "boolean"
},
"integrationCode": {
"description": "ID information used to link this creative to an external system.\nMust be UTF-8 encoded with a length of no more than 10,000 characters.",
"type": "string"
},
"jsTrackerUrl": {
"description": "JavaScript measurement URL from supported third-party verification\nproviders (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not\nsupported.\n\nThis field is only supported in following\ncreative_type:\n\n* `CREATIVE_TYPE_NATIVE`\n* `CREATIVE_TYPE_NATIVE_SITE_SQUARE`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`\n* `CREATIVE_TYPE_NATIVE_VIDEO`",
"type": "string"
},
"lineItemIds": {
"description": "Output only. The IDs of the line items this creative is associated with.\n\nTo associate a creative to a line item, use\nLineItem.creative_ids instead.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"mediaDuration": {
"description": "Output only. Media duration of the creative.\nApplicable when creative_type\nis one of:\n\n* `CREATIVE_TYPE_VIDEO`\n* `CREATIVE_TYPE_AUDIO`\n* `CREATIVE_TYPE_NATIVE_VIDEO`\n* `CREATIVE_TYPE_PUBLISHER_HOSTED`",
"format": "google-duration",
"type": "string"
},
"name": {
"description": "Output only. The resource name of the creative.",
"type": "string"
},
"notes": {
"description": "User notes for this creative.\nMust be UTF-8 encoded with a length of no more than 20,000 characters.",
"type": "string"
},
"obaIcon": {
"$ref": "ObaIcon",
"description": "Specifies the OBA icon for a video creative.\n\nThis field is only supported in following\ncreative_type:\n\n* `CREATIVE_TYPE_VIDEO`"
},
"progressOffset": {
"$ref": "AudioVideoOffset",
"description": "Amount of time to play the video before counting a view.\n\nThis field is required when skippable is true.\n\nThis field is only supported for the following\ncreative_type:\n\n* `CREATIVE_TYPE_VIDEO`"
},
"requireHtml5": {
"description": "Optional. Indicates that the creative relies on HTML5 to render properly.\n\nOptional and only valid for third-party tag creatives.\nThird-party tag creatives are creatives with following\nhosting_source:\n\n* `HOSTING_SOURCE_THIRD_PARTY`\n\ncombined with following creative_type:\n\n* `CREATIVE_TYPE_STANDARD`\n* `CREATIVE_TYPE_EXPANDABLE`",
"type": "boolean"
},
"requireMraid": {
"description": "Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface\nDefinitions system).\n\nSet this if the creative relies on mobile gestures for interactivity, such\nas swiping or tapping.\n\nOptional and only valid for third-party tag creatives.\n\nThird-party tag creatives are creatives with following\nhosting_source:\n\n* `HOSTING_SOURCE_THIRD_PARTY`\n\ncombined with following creative_type:\n\n* `CREATIVE_TYPE_STANDARD`\n* `CREATIVE_TYPE_EXPANDABLE`",
"type": "boolean"
},
"requirePingForAttribution": {
"description": "Optional. Indicates that the creative will wait for a return ping for attribution.\n\nOnly valid when using a Campaign Manager tracking ad with a third-party ad\nserver parameter and the ${DC_DBM_TOKEN} macro.\n\nOptional and only valid for third-party tag creatives or third-party VAST\ntag creatives.\n\nThird-party tag creatives are creatives with following\nhosting_source:\n\n* `HOSTING_SOURCE_THIRD_PARTY`\n\ncombined with following creative_type:\n\n* `CREATIVE_TYPE_STANDARD`\n* `CREATIVE_TYPE_EXPANDABLE`\n\nThird-party VAST tag creatives are creatives with following\nhosting_source:\n\n* `HOSTING_SOURCE_THIRD_PARTY`\n\ncombined with following creative_type:\n\n* `CREATIVE_TYPE_VIDEO`",
"type": "boolean"
},
"reviewStatus": {
"$ref": "ReviewStatusInfo",
"description": "Output only. The current status of the creative review process."
},
"skipOffset": {
"$ref": "AudioVideoOffset",
"description": "Amount of time to play the video before the skip button appears.\n\nThis field is required when skippable is true.\n\nThis field is only supported for the following\ncreative_type:\n\n* `CREATIVE_TYPE_VIDEO`"
},
"skippable": {
"description": "Whether the user can choose to skip a video creative.\n\nThis field is only supported for the following\ncreative_type:\n\n* `CREATIVE_TYPE_VIDEO`",
"type": "boolean"
},
"thirdPartyTag": {
"description": "Optional. The original third-party tag used for the creative.\n\nRequired and only valid for third-party tag creatives.\n\nThird-party tag creatives are creatives with following\nhosting_source:\n\n* `HOSTING_SOURCE_THIRD_PARTY`\n\ncombined with following creative_type:\n\n* `CREATIVE_TYPE_STANDARD`\n* `CREATIVE_TYPE_EXPANDABLE`",
"type": "string"
},
"thirdPartyUrls": {
"description": "Tracking URLs from third parties to track interactions with a video\ncreative.\n\nThis field is only supported for the following\ncreative_type:\n\n* `CREATIVE_TYPE_AUDIO`\n* `CREATIVE_TYPE_VIDEO`\n* `CREATIVE_TYPE_NATIVE_VIDEO`",
"items": {
"$ref": "ThirdPartyUrl"
},
"type": "array"
},
"timerEvents": {
"description": "Timer custom events for a rich media creative.\nTimers track the time during which a user views and interacts with a\nspecified part of a rich media creative.\nA creative can have multiple timer events, each timed independently.\nLeave it empty or unset for creatives containing image assets only.",
"items": {
"$ref": "TimerEvent"
},
"type": "array"
},
"trackerUrls": {
"description": "Tracking URLs for analytics providers or third-party ad technology vendors.\n\nThe URLs must start with https (except on inventory that doesn't require\nSSL compliance).\nIf using macros in your URL, use only macros supported by Display \u0026 Video\n360.\n\nStandard URLs only, no IMG or SCRIPT tags.\n\nThis field is only supported in following\ncreative_type:\n\n* `CREATIVE_TYPE_NATIVE`\n* `CREATIVE_TYPE_NATIVE_SITE_SQUARE`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL`\n* `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`\n* `CREATIVE_TYPE_NATIVE_VIDEO`",
"items": {
"type": "string"
},
"type": "array"
},
"transcodes": {
"description": "Output only. Audio/Video transcodes.\n\nDisplay \u0026 Video 360 transcodes the main asset into a number of alternative\nversions that use different file formats or have different properties\n(resolution, audio bit rate, and video bit rate), each designed for\nspecific video players or bandwidths.\n\nThese transcodes give a publisher's system more options to choose from for\neach impression on your video and ensures that the appropriate file serves\nbased on the viewer’s connection and screen size.\n\nThis field is only supported in following\ncreative_type:\n\n* `CREATIVE_TYPE_VIDEO`\n* `CREATIVE_TYPE_NATIVE_VIDEO`\n* `CREATIVE_TYPE_AUDIO`",
"items": {
"$ref": "Transcode"
},
"type": "array"
},
"universalAdId": {
"$ref": "UniversalAdId",
"description": "Optional. An optional creative identifier provided by a registry that is unique\nacross all platforms.\n\nUniversal Ad ID is part of the VAST 4.0 standard. It can be modified after\nthe creative is created.\n\nThis field is only supported for the following\ncreative_type:\n\n* `CREATIVE_TYPE_VIDEO`"
},
"updateTime": {
"description": "Output only. The timestamp when the creative was last updated. Assigned by\nthe system.",
"format": "google-datetime",
"type": "string"
},
"vastTagUrl": {
"description": "Optional. The URL of the VAST tag for a third-party VAST tag creative.\n\nRequired and only valid for third-party VAST tag creatives.\n\nThird-party VAST tag creatives are creatives with following\nhosting_source:\n\n* `HOSTING_SOURCE_THIRD_PARTY`\n\ncombined with following creative_type:\n\n* `CREATIVE_TYPE_VIDEO`",
"type": "string"
},
"vpaid": {
"description": "Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video\nPlayer-Ad Interface).\n\nOutput only and only valid for third-party VAST tag creatives.\n\nThird-party VAST tag creatives are creatives with following\nhosting_source:\n\n* `HOSTING_SOURCE_THIRD_PARTY`\n\ncombined with following creative_type:\n\n* `CREATIVE_TYPE_VIDEO`",
"type": "boolean"
}
},
"type": "object"
},
"CreativeConfig": {
"description": "Creative requirements configuration for the inventory source.",
"id": "CreativeConfig",
"properties": {
"creativeType": {
"description": "The type of creative that can be assigned to the inventory source.",
"enum": [
"CREATIVE_TYPE_UNSPECIFIED",
"CREATIVE_TYPE_STANDARD",
"CREATIVE_TYPE_EXPANDABLE",
"CREATIVE_TYPE_VIDEO",
"CREATIVE_TYPE_NATIVE",
"CREATIVE_TYPE_TEMPLATED_APP_INSTALL",
"CREATIVE_TYPE_NATIVE_SITE_SQUARE",
"CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL",
"CREATIVE_TYPE_LIGHTBOX",
"CREATIVE_TYPE_NATIVE_APP_INSTALL",
"CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE",
"CREATIVE_TYPE_AUDIO",
"CREATIVE_TYPE_PUBLISHER_HOSTED",
"CREATIVE_TYPE_NATIVE_VIDEO",
"CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO"
],
"enumDescriptions": [
"Type value is not specified or is unknown in this version.",
"Standard display creative.\n\nCreate and update methods are supported for this creative type if the\nhosting_source is one of the following:\n\n* `HOSTING_SOURCE_HOSTED`\n* `HOSTING_SOURCE_THIRD_PARTY`",
"Expandable creative.\n\nCreate and update methods are supported for this creative type if the\nhosting_source is `HOSTING_SOURCE_THIRD_PARTY`",
"Video creative.\n\nCreate and update methods are supported for this creative type if the\nhosting_source is one of the following:\n\n* `HOSTING_SOURCE_HOSTED`\n* `HOSTING_SOURCE_THIRD_PARTY`",
"Native creative rendered by publishers with assets from advertiser.\n\nCreate and update methods are supported for this creative type if the\nhosting_source is `HOSTING_SOURCE_HOSTED`",
"Templated app install mobile creative (banner).\n\nCreate and update methods are **not** supported for this creative type.",
"Square native creative.\n\nCreate and update methods are supported for this creative type if the\nhosting_source is `HOSTING_SOURCE_HOSTED`",
"Interstitial creative including both display and video.\n\nCreate and update methods are **not** supported for this creative type.",
"Responsive and expandable Lightbox creative.\n\nCreate and update methods are **not** supported for this creative type.",
"Native app install creative.\n\nCreate and update methods are supported for this creative type if the\nhosting_source is `HOSTING_SOURCE_HOSTED`",
"Square native app install creative.\n\nCreate and update methods are supported for this creative type if the\nhosting_source is `HOSTING_SOURCE_HOSTED`",
"Audio creative.\n\nCreate and update methods are supported for this creative type if the\nhosting_source is `HOSTING_SOURCE_HOSTED`",
"Publisher hosted creative.\n\nCreate and update methods are **not** supported for this creative type.",
"Native video creative.\n\nCreate and update methods are supported for this creative type if the\nhosting_source is `HOSTING_SOURCE_HOSTED`",
"Templated app install mobile video creative.\n\nCreate and update methods are **not** supported for this creative type."
],
"type": "string"
},
"displayCreativeConfig": {
"$ref": "InventorySourceDisplayCreativeConfig",
"description": "The configuration for display creatives.\nApplicable when creative_type is\n`CREATIVE_TYPE_STANDARD`."
},
"videoCreativeConfig": {
"$ref": "InventorySourceVideoCreativeConfig",
"description": "The configuration for video creatives.\nApplicable when creative_type is\n`CREATIVE_TYPE_VIDEO`."
}
},
"type": "object"
},
"CustomList": {
"description": "Describes a custom list entity, such as a custom affinity or custom intent\naudience list.",
"id": "CustomList",
"properties": {
"customListId": {
"description": "Output only. The unique ID of the custom list. Assigned by the system.",
"format": "int64",
"type": "string"
},
"displayName": {
"description": "Output only. The display name of the custom list.\n.",
"type": "string"
},
"name": {
"description": "Output only. The resource name of the custom list.",
"type": "string"
}
},
"type": "object"
},
"CustomListGroup": {
"description": "Details of custom list group.\nAll custom list targeting settings are logically ‘OR’ of each other.",
"id": "CustomListGroup",
"properties": {
"settings": {
"description": "Required. All custom list targeting settings in custom list group.\nRepeated settings with same id will be ignored.",
"items": {
"$ref": "CustomListTargetingSetting"
},
"type": "array"
}
},
"type": "object"
},
"CustomListTargetingSetting": {
"description": "Details of custom list targeting setting.",
"id": "CustomListTargetingSetting",
"properties": {
"customListId": {
"description": "Required. Custom id of custom list targeting setting.\nThis id is custom_list_id.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"Date": {
"description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day\nand time zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. This can represent:\n\n* A full date, with non-zero year, month and day values\n* A month and day value, with a zero year, e.g. an anniversary\n* A year on its own, with zero month and day values\n* A year and month value, with a zero day, e.g. a credit card expiration date\n\nRelated types are google.type.TimeOfDay and `google.protobuf.Timestamp`.",
"id": "Date",
"properties": {
"day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year by itself or a year and month where the day is not\nsignificant.",
"format": "int32",
"type": "integer"
},
"month": {
"description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a\nmonth and day.",
"format": "int32",
"type": "integer"
},
"year": {
"description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"DateRange": {
"description": "A date range.",
"id": "DateRange",
"properties": {
"endDate": {
"$ref": "Date",
"description": "The upper bound of the date range, inclusive. Must specify a positive value\nfor `year`, `month`, and `day`."
},
"startDate": {
"$ref": "Date",
"description": "The lower bound of the date range, inclusive. Must specify a positive value\nfor `year`, `month`, and `day`."
}
},
"type": "object"
},
"DayAndTimeAssignedTargetingOptionDetails": {
"description": "Representation of a segment of time defined on a specific day of the week and\nwith a start and end time.\nThe time represented by `start_hour` must be before the time represented by\n`end_hour`.",
"id": "DayAndTimeAssignedTargetingOptionDetails",
"properties": {
"dayOfWeek": {
"description": "Required. The day of the week for this day and time targeting setting.",
"enum": [
"DAY_OF_WEEK_UNSPECIFIED",
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"enumDescriptions": [
"The day of the week is unspecified.",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
],
"type": "string"
},
"endHour": {
"description": "Required. The end hour for day and time targeting. Must be between 1 (1 hour after\nstart of day) and 24 (end of day).",
"format": "int32",
"type": "integer"
},
"startHour": {
"description": "Required. The start hour for day and time targeting. Must be between 0 (start of day)\nand 23 (1 hour before end of day).",
"format": "int32",
"type": "integer"
},
"timeZoneResolution": {
"description": "Required. The mechanism used to determine which timezone to use for this day and time\ntargeting setting.",
"enum": [
"TIME_ZONE_RESOLUTION_UNSPECIFIED",
"TIME_ZONE_RESOLUTION_END_USER",
"TIME_ZONE_RESOLUTION_ADVERTISER"
],
"enumDescriptions": [
"Time zone resolution is either unspecific or unknown.",
"Times are resolved in the time zone of the user that saw the ad.",
"Times are resolved in the time zone of the advertiser that served the ad."
],
"type": "string"
}
},
"type": "object"
},
"DeleteAssignedTargetingOptionsRequest": {
"description": "A request listing which assigned targeting options of a given targeting type\nshould be deleted.",
"id": "DeleteAssignedTargetingOptionsRequest",
"properties": {
"assignedTargetingOptionIds": {
"description": "Required. The assigned targeting option IDs to delete.",
"items": {
"type": "string"
},
"type": "array"
},
"targetingType": {
"description": "Required. Identifies the type of this assigned targeting option.",
"enum": [
"TARGETING_TYPE_UNSPECIFIED",
"TARGETING_TYPE_CHANNEL",
"TARGETING_TYPE_APP_CATEGORY",
"TARGETING_TYPE_APP",
"TARGETING_TYPE_URL",
"TARGETING_TYPE_DAY_AND_TIME",
"TARGETING_TYPE_AGE_RANGE",
"TARGETING_TYPE_REGIONAL_LOCATION_LIST",
"TARGETING_TYPE_PROXIMITY_LOCATION_LIST",
"TARGETING_TYPE_GENDER",
"TARGETING_TYPE_VIDEO_PLAYER_SIZE",
"TARGETING_TYPE_USER_REWARDED_CONTENT",
"TARGETING_TYPE_PARENTAL_STATUS",
"TARGETING_TYPE_CONTENT_INSTREAM_POSITION",
"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION",
"TARGETING_TYPE_DEVICE_TYPE",
"TARGETING_TYPE_AUDIENCE_GROUP",
"TARGETING_TYPE_BROWSER",
"TARGETING_TYPE_HOUSEHOLD_INCOME",
"TARGETING_TYPE_ON_SCREEN_POSITION",
"TARGETING_TYPE_THIRD_PARTY_VERIFIER",
"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION",
"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION",
"TARGETING_TYPE_ENVIRONMENT",
"TARGETING_TYPE_CARRIER_AND_ISP",
"TARGETING_TYPE_OPERATING_SYSTEM",
"TARGETING_TYPE_DEVICE_MAKE_MODEL",
"TARGETING_TYPE_KEYWORD",
"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST",
"TARGETING_TYPE_VIEWABILITY",
"TARGETING_TYPE_CATEGORY",
"TARGETING_TYPE_INVENTORY_SOURCE",
"TARGETING_TYPE_LANGUAGE",
"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS",
"TARGETING_TYPE_GEO_REGION",
"TARGETING_TYPE_INVENTORY_SOURCE_GROUP",
"TARGETING_TYPE_EXCHANGE",
"TARGETING_TYPE_SUB_EXCHANGE"
],
"enumDescriptions": [
"Default value when type is not specified or is unknown in this version.",
"Target a channel (a custom group of related websites or apps).",
"Target an app category (for example, education or puzzle games).",
"Target a specific app (for example, Angry Birds).",
"Target a specific url (for example, quora.com).",
"Target ads during a chosen time period on a specific day.",
"Target ads to a specific age range (for example, 18-24).",
"Target ads to the specified regions on a regional location list.",
"Target ads to the specified points of interest on a proximity location\nlist.",
"Target ads to a specific gender (for example, female or male).",
"Target a specific video player size for video ads.",
"Target user rewarded content for video ads.",
"Target ads to a specific parental status (for example, parent or not a\nparent).",
"Target video or audio ads in a specific content instream position (for\nexample, pre-roll, mid-roll, or post-roll).",
"Target ads in a specific content outstream position.",
"Target ads to a specific device type (for example, tablet or connected TV).",
"Target ads to an audience or groups of audiences.\nSingleton field, at most one can exist on a single Lineitem at a time.",
"Target ads to specific web browsers (for example, Chrome).",
"Target ads to a specific household income range (for example, top 10%).",
"Target ads in a specific on screen position.",
"Filter web sites through third party verification (for example, IAS or\nDoubleVerify).",
"Filter web sites by specific digital content label ratings (for example,\nDL-MA: suitable only for mature audiences).",
"Filter website content by sensitive categories (for example, adult).",
"Target ads to a specific environment (for example, web or app).",
"Target ads to a specific network carrier or internet service provider\n(ISP) (for example, Comcast or Orange).",
"Target ads to a specific operating system (for example, macOS).",
"Target ads to a specific device make or model (for example, Roku or\nSamsung).",
"Target ads to a specific keyword (for example, dog or retriever).",
"Target ads to a specific negative keyword list.",
"Target ads to a specific viewability (for example, 80% viewable).",
"Target ads to a specific content category (for example, arts \u0026\nentertainment).",
"Purchase impressions from specific deals and auction packages.",
"Target ads to a specific language (for example, English or Japanese).",
"Target ads to ads.txt authorized sellers.",
"Target ads to a specific regional location (for example, a city or state).",
"Purchase impressions from a group of deals and auction packages.",
"Purchase impressions from specific exchanges.",
"Purchase impressions from specific sub-exchanges."
],
"type": "string"
}
},
"type": "object"
},
"DeviceMakeModelAssignedTargetingOptionDetails": {
"description": "Assigned device make and model targeting option details. This will be\npopulated in the\ndevice_make_model_details\nfield when\ntargeting_type is\n`TARGETING_TYPE_DEVICE_MAKE_MODEL`.",
"id": "DeviceMakeModelAssignedTargetingOptionDetails",
"properties": {
"displayName": {
"description": "Output only. The display name of the device make and model.",
"type": "string"
},
"negative": {
"description": "Indicates if this option is being negatively targeted.",
"type": "boolean"
},
"targetingOptionId": {
"description": "Required. The targeting_option_id field when\ntargeting_type is\n`TARGETING_TYPE_DEVICE_MAKE_MODEL`.",
"type": "string"
}
},
"type": "object"
},
"DeviceMakeModelTargetingOptionDetails": {
"description": "Represents a targetable device make and model. This will be populated in the\ndevice_make_model_details\nfield of a TargetingOption when\ntargeting_type is\n`TARGETING_TYPE_DEVICE_MAKE_MODEL`.",
"id": "DeviceMakeModelTargetingOptionDetails",
"properties": {
"displayName": {
"description": "Output only. The display name of the device make and model.",
"type": "string"
}
},
"type": "object"
},
"DeviceTypeAssignedTargetingOptionDetails": {
"description": "Targeting details for device type. This will be\npopulated in the details field of an AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_DEVICE_TYPE`.",
"id": "DeviceTypeAssignedTargetingOptionDetails",
"properties": {
"deviceType": {
"description": "Output only. The display name of the device type.",
"enum": [
"DEVICE_TYPE_UNSPECIFIED",
"DEVICE_TYPE_COMPUTER",
"DEVICE_TYPE_CONNECTED_TV",
"DEVICE_TYPE_SMART_PHONE",
"DEVICE_TYPE_TABLET"
],
"enumDescriptions": [
"Default value when device type is not specified in this version. This\nenum is a placeholder for default value and does not represent a real\ndevice type option.",
"The device type is computer.",
"The device type is connected TV.",
"The device type is smart phone..",
"The device type is tablet."
],
"type": "string"
},
"targetingOptionId": {
"description": "Required. ID of the device type.",
"type": "string"
}
},
"type": "object"
},
"DeviceTypeTargetingOptionDetails": {
"description": "Represents a targetable device type. This will be populated in the\ndevice_type_details field of a\nTargetingOption when targeting_type is\n`TARGETING_TYPE_DEVICE_TYPE`.",
"id": "DeviceTypeTargetingOptionDetails",
"properties": {
"deviceType": {
"description": "Output only. The device type that is used to be targeted.",
"enum": [
"DEVICE_TYPE_UNSPECIFIED",
"DEVICE_TYPE_COMPUTER",
"DEVICE_TYPE_CONNECTED_TV",
"DEVICE_TYPE_SMART_PHONE",
"DEVICE_TYPE_TABLET"
],
"enumDescriptions": [
"Default value when device type is not specified in this version. This\nenum is a placeholder for default value and does not represent a real\ndevice type option.",
"The device type is computer.",
"The device type is connected TV.",
"The device type is smart phone..",
"The device type is tablet."
],
"type": "string"
}
},
"type": "object"
},
"DigitalContentLabelAssignedTargetingOptionDetails": {
"description": "Targeting details for digital content label. This will be\npopulated in the details field of an AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`.",
"id": "DigitalContentLabelAssignedTargetingOptionDetails",
"properties": {
"contentRatingTier": {
"description": "Output only. The display name of the digital content label rating tier.",
"enum": [
"CONTENT_RATING_TIER_UNSPECIFIED",
"CONTENT_RATING_TIER_UNRATED",
"CONTENT_RATING_TIER_GENERAL",
"CONTENT_RATING_TIER_PARENTAL_GUIDANCE",
"CONTENT_RATING_TIER_TEENS",
"CONTENT_RATING_TIER_MATURE"
],
"enumDescriptions": [
"Content label is not specified in this version. This enum is a place\nholder for a default value and does not represent a real content rating.",
"Content that has not been labeled.",
"Content suitable for general audiences.",
"Content suitable for most audiences with parental guidance.",
"Content suitable for teen and older audiences.",
"Content suitable only for mature audiences."
],
"type": "string"
},
"excludedTargetingOptionId": {
"description": "Required. ID of the digital content label to be EXCLUDED.",
"type": "string"
}
},
"type": "object"
},
"DigitalContentLabelTargetingOptionDetails": {
"description": "Represents a targetable digital content label rating tier. This will be\npopulated in the\ndigital_content_label_details\nfield of the TargetingOption when\ntargeting_type is\n`TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`.",
"id": "DigitalContentLabelTargetingOptionDetails",
"properties": {
"contentRatingTier": {
"description": "Output only. An enum for the content label brand safety tiers.",
"enum": [
"CONTENT_RATING_TIER_UNSPECIFIED",
"CONTENT_RATING_TIER_UNRATED",
"CONTENT_RATING_TIER_GENERAL",
"CONTENT_RATING_TIER_PARENTAL_GUIDANCE",
"CONTENT_RATING_TIER_TEENS",
"CONTENT_RATING_TIER_MATURE"
],
"enumDescriptions": [
"Content label is not specified in this version. This enum is a place\nholder for a default value and does not represent a real content rating.",
"Content that has not been labeled.",
"Content suitable for general audiences.",
"Content suitable for most audiences with parental guidance.",
"Content suitable for teen and older audiences.",
"Content suitable only for mature audiences."
],
"type": "string"
}
},
"type": "object"
},
"Dimensions": {
"description": "Dimensions.",
"id": "Dimensions",
"properties": {
"heightPixels": {
"description": "The height in pixels.",
"format": "int32",
"type": "integer"
},
"widthPixels": {
"description": "The width in pixels.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"DoubleVerify": {
"description": "Details of DoubleVerify settings.",
"id": "DoubleVerify",
"properties": {
"appStarRating": {
"$ref": "DoubleVerifyAppStarRating",
"description": "Avoid bidding on apps with the star ratings."
},
"avoidedAgeRatings": {
"description": "Avoid bidding on apps with the age rating.",
"enumDescriptions": [
"This enum is only a placeholder and it doesn't specify any age rating\noptions.",
"Apps with unknown age rating.",
"Apps rated for Everyone (4+).",
"Apps rated for Everyone (9+).",
"Apps rated for Teens (12+).",
"Apps rated for Mature (17+).",
"Apps rated for Adults Only (18+)."
],
"items": {
"enum": [
"AGE_RATING_UNSPECIFIED",
"APP_AGE_RATE_UNKNOWN",
"APP_AGE_RATE_4_PLUS",
"APP_AGE_RATE_9_PLUS",
"APP_AGE_RATE_12_PLUS",
"APP_AGE_RATE_17_PLUS",
"APP_AGE_RATE_18_PLUS"
],
"type": "string"
},
"type": "array"
},
"brandSafetyCategories": {
"$ref": "DoubleVerifyBrandSafetyCategories",
"description": "DV Brand Safety Controls."
},
"displayViewability": {
"$ref": "DoubleVerifyDisplayViewability",
"description": "Display viewability settings (applicable to display line items only)."
},
"fraudInvalidTraffic": {
"$ref": "DoubleVerifyFraudInvalidTraffic",
"description": "Avoid Sites and Apps with historical Fraud \u0026 IVT Rates."
},
"videoViewability": {
"$ref": "DoubleVerifyVideoViewability",
"description": "Video viewability settings (applicable to video line items only)."
}
},
"type": "object"
},
"DoubleVerifyAppStarRating": {
"description": "Details of DoubleVerify star ratings settings.",
"id": "DoubleVerifyAppStarRating",
"properties": {
"avoidInsufficientStarRating": {
"description": "Avoid bidding on apps with insufficient star ratings.",
"type": "boolean"
},
"avoidedStarRating": {
"description": "Avoid bidding on apps with the star ratings.",
"enum": [
"APP_STAR_RATE_UNSPECIFIED",
"APP_STAR_RATE_1_POINT_5_LESS",
"APP_STAR_RATE_2_LESS",
"APP_STAR_RATE_2_POINT_5_LESS",
"APP_STAR_RATE_3_LESS",
"APP_STAR_RATE_3_POINT_5_LESS",
"APP_STAR_RATE_4_LESS",
"APP_STAR_RATE_4_POINT_5_LESS"
],
"enumDescriptions": [
"This enum is only a placeholder and it doesn't specify any app star\nrating options.",
"Official Apps with rating \u003c 1.5 Stars.",
"Official Apps with rating \u003c 2 Stars.",
"Official Apps with rating \u003c 2.5 Stars.",
"Official Apps with rating \u003c 3 Stars.",
"Official Apps with rating \u003c 3.5 Stars.",
"Official Apps with rating \u003c 4 Stars.",
"Official Apps with rating \u003c 4.5 Stars."
],
"type": "string"
}
},
"type": "object"
},
"DoubleVerifyBrandSafetyCategories": {
"description": "Settings for brand safety controls.",
"id": "DoubleVerifyBrandSafetyCategories",
"properties": {
"avoidUnknownBrandSafetyCategory": {
"description": "Unknown or unrateable.",
"type": "boolean"
},
"avoidedHighSeverityCategories": {
"description": "Brand safety high severity avoidance categories.",
"enumDescriptions": [
"This enum is only a placeholder and it doesn't specify any high\nseverity categories.",
"Adult Content: Pornography, Mature Topics \u0026 Nudity.",
"Copyright Infringement.",
"Drugs/Alcohol/Controlled Substances: Substance Abuse.",
"Extreme Graphic/Explicit Violence/Weapons.",
"Hate/Profanity.",
"Illegal Activities: Criminal Skills.",
"Incentivized/Malware/Clutter."
],
"items": {
"enum": [
"HIGHER_SEVERITY_UNSPECIFIED",
"ADULT_CONTENT_PORNOGRAPHY",
"COPYRIGHT_INFRINGEMENT",
"SUBSTANCE_ABUSE",
"GRAPHIC_VIOLENCE_WEAPONS",
"HATE_PROFANITY",
"CRIMINAL_SKILLS",
"NUISANCE_INCENTIVIZED_MALWARE_CLUTTER"
],
"type": "string"
},
"type": "array"
},
"avoidedMediumSeverityCategories": {
"description": "Brand safety medium severity avoidance categories.",
"enumDescriptions": [
"This enum is only a placeholder and it doesn't specify any medium\nseverity categories.",
"Ad Servers.",
"Adult Content: Swimsuit.",
"Controversial Subjects: Alternative Lifestyles.",
"Controversial Subjects: Celebrity Gossip.",
"Controversial Subjects: Gambling.",
"Controversial Subjects: Occult.",
"Controversial Subjects: Sex Education.",
"Disaster: Aviation.",
"Disaster: Man-made.",
"Disaster: Natural.",
"Disaster: Terrorist Events.",
"Disaster: Vehicle.",
"Drugs/Alcohol/Controlled Substances: Alcohol.",
"Drugs/Alcohol/Controlled Substances: Smoking.",
"Negative News: Financial.",
"Non-Std Content: Non-English.",
"Non-Std Content: Parking Page.",
"Unmoderated UGC: Forums, Images \u0026 Video.",
"Controversial Subjects: Inflammatory Politics and News.",
"Negative News: Pharmaceutical."
],
"items": {
"enum": [
"MEDIUM_SEVERITY_UNSPECIFIED",
"AD_SERVERS",
"ADULT_CONTENT_SWIMSUIT",
"ALTERNATIVE_LIFESTYLES",
"CELEBRITY_GOSSIP",
"GAMBLING",
"OCCULT",
"SEX_EDUCATION",
"DISASTER_AVIATION",
"DISASTER_MAN_MADE",
"DISASTER_NATURAL",
"DISASTER_TERRORIST_EVENTS",
"DISASTER_VEHICLE",
"ALCOHOL",
"SMOKING",
"NEGATIVE_NEWS_FINANCIAL",
"NON_ENGLISH",
"PARKING_PAGE",
"UNMODERATED_UGC",
"INFLAMMATORY_POLITICS_AND_NEWS",
"NEGATIVE_NEWS_PHARMACEUTICAL"
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"DoubleVerifyDisplayViewability": {
"description": "Details of DoubleVerify display viewability settings.",
"id": "DoubleVerifyDisplayViewability",
"properties": {
"iab": {
"description": "Target web and app inventory to maximize IAB viewable rate.",
"enum": [
"IAB_VIEWED_RATE_UNSPECIFIED",
"IAB_VIEWED_RATE_80_PERCENT_HIGHER",
"IAB_VIEWED_RATE_75_PERCENT_HIGHER",
"IAB_VIEWED_RATE_70_PERCENT_HIGHER",
"IAB_VIEWED_RATE_65_PERCENT_HIGHER",
"IAB_VIEWED_RATE_60_PERCENT_HIGHER",
"IAB_VIEWED_RATE_55_PERCENT_HIGHER",
"IAB_VIEWED_RATE_50_PERCENT_HIGHER",
"IAB_VIEWED_RATE_40_PERCENT_HIGHER",
"IAB_VIEWED_RATE_30_PERCENT_HIGHER"
],
"enumDescriptions": [
"This enum is only a placeholder and it doesn't specify any IAB viewed\nrate options.",
"Target web and app inventory to maximize IAB viewable rate 80% or\nhigher.",
"Target web and app inventory to maximize IAB viewable rate 75% or\nhigher.",
"Target web and app inventory to maximize IAB viewable rate 70% or\nhigher.",
"Target web and app inventory to maximize IAB viewable rate 65% or\nhigher.",
"Target web and app inventory to maximize IAB viewable rate 60% or\nhigher.",
"Target web and app inventory to maximize IAB viewable rate 55% or\nhigher.",
"Target web and app inventory to maximize IAB viewable rate 50% or\nhigher.",
"Target web and app inventory to maximize IAB viewable rate 40% or\nhigher.",
"Target web and app inventory to maximize IAB viewable rate 30% or\nhigher."
],
"type": "string"
},
"viewableDuring": {
"description": "Target web and app inventory to maximize 100% viewable duration.",
"enum": [
"AVERAGE_VIEW_DURATION_UNSPECIFIED",
"AVERAGE_VIEW_DURATION_5_SEC",
"AVERAGE_VIEW_DURATION_10_SEC",
"AVERAGE_VIEW_DURATION_15_SEC"
],
"enumDescriptions": [
"This enum is only a placeholder and it doesn't specify any average view\nduration options.",
"Target web and app inventory to maximize 100% viewable duration 5\nseconds or more.",
"Target web and app inventory to maximize 100% viewable duration 10\nseconds or more.",
"Target web and app inventory to maximize 100% viewable duration 15\nseconds or more."
],
"type": "string"
}
},
"type": "object"
},
"DoubleVerifyFraudInvalidTraffic": {
"description": "DoubleVerify Fraud \u0026 Invalid Traffic settings.",
"id": "DoubleVerifyFraudInvalidTraffic",
"properties": {
"avoidInsufficientOption": {
"description": "Insufficient Historical Fraud \u0026 IVT Stats.",
"type": "boolean"
},
"avoidedFraudOption": {
"description": "Avoid Sites and Apps with historical Fraud \u0026 IVT.",
"enum": [
"FRAUD_UNSPECIFIED",
"AD_IMPRESSION_FRAUD_100",
"AD_IMPRESSION_FRAUD_50",
"AD_IMPRESSION_FRAUD_25",
"AD_IMPRESSION_FRAUD_10",
"AD_IMPRESSION_FRAUD_8",
"AD_IMPRESSION_FRAUD_6",
"AD_IMPRESSION_FRAUD_4",
"AD_IMPRESSION_FRAUD_2"
],
"enumDescriptions": [
"This enum is only a placeholder and it doesn't specify any fraud and\ninvalid traffic options.",
"100% Fraud \u0026 IVT.",
"50% or Higher Fraud \u0026 IVT.",
"25% or Higher Fraud \u0026 IVT.",
"10% or Higher Fraud \u0026 IVT.",
"8% or Higher Fraud \u0026 IVT.",
"6% or Higher Fraud \u0026 IVT.",
"4% or Higher Fraud \u0026 IVT.",
"2% or Higher Fraud \u0026 IVT."
],
"type": "string"
}
},
"type": "object"
},
"DoubleVerifyVideoViewability": {
"description": "Details of DoubleVerify video viewability settings.",
"id": "DoubleVerifyVideoViewability",
"properties": {
"playerImpressionRate": {
"description": "Target inventory to maximize impressions with 400x300 or greater player\nsize.",
"enum": [
"PLAYER_SIZE_400X300_UNSPECIFIED",
"PLAYER_SIZE_400X300_95",
"PLAYER_SIZE_400X300_70",
"PLAYER_SIZE_400X300_25",
"PLAYER_SIZE_400X300_5"
],
"enumDescriptions": [
"This enum is only a placeholder and it doesn't specify any impressions\noptions.",
"Sites with 95%+ of impressions.",
"Sites with 70%+ of impressions.",
"Sites with 25%+ of impressions.",
"Sites with 5%+ of impressions."
],
"type": "string"
},
"videoIab": {
"description": "Target web inventory to maximize IAB viewable rate.",
"enum": [
"VIDEO_IAB_UNSPECIFIED",
"IAB_VIEWABILITY_80_PERCENT_HIGHER",
"IAB_VIEWABILITY_75_PERCENT_HIGHER",
"IAB_VIEWABILITY_70_PERCENT_HIGHER",
"IAB_VIEWABILITY_65_PERCENT_HIHGER",
"IAB_VIEWABILITY_60_PERCENT_HIGHER",
"IAB_VIEWABILITY_55_PERCENT_HIHGER",
"IAB_VIEWABILITY_50_PERCENT_HIGHER",
"IAB_VIEWABILITY_40_PERCENT_HIHGER",
"IAB_VIEWABILITY_30_PERCENT_HIHGER"
],
"enumDescriptions": [
"This enum is only a placeholder and it doesn't specify any video IAB\nviewable rate options.",
"Target web and app inventory to maximize IAB viewable rate 80% or\nhigher.",
"Target web and app inventory to maximize IAB viewable rate 75% or\nhigher.",
"Target web and app inventory to maximize IAB viewable rate 70% or\nhigher.",
"Target web and app inventory to maximize IAB viewable rate 65% or\nhigher.",
"Target web and app inventory to maximize IAB viewable rate 60% or\nhigher.",
"Target web and app inventory to maximize IAB viewable rate 55% or\nhigher.",
"Target web and app inventory to maximize IAB viewable rate 50% or\nhigher.",
"Target web and app inventory to maximize IAB viewable rate 40% or\nhigher.",
"Target web and app inventory to maximize IAB viewable rate 30% or\nhigher."
],
"type": "string"
},
"videoViewableRate": {
"description": "Target web inventory to maximize fully viewable rate.",
"enum": [
"VIDEO_VIEWABLE_RATE_UNSPECIFIED",
"VIEWED_PERFORMANCE_40_PERCENT_HIGHER",
"VIEWED_PERFORMANCE_35_PERCENT_HIGHER",
"VIEWED_PERFORMANCE_30_PERCENT_HIGHER",
"VIEWED_PERFORMANCE_25_PERCENT_HIGHER",
"VIEWED_PERFORMANCE_20_PERCENT_HIGHER",
"VIEWED_PERFORMANCE_10_PERCENT_HIGHER"
],
"enumDescriptions": [
"This enum is only a placeholder and it doesn't specify any video\nviewable rate options.",
"Target web inventory to maximize fully viewable rate 40% or higher.",
"Target web inventory to maximize fully viewable rate 35% or higher.",
"Target web inventory to maximize fully viewable rate 30% or higher.",
"Target web inventory to maximize fully viewable rate 25% or higher.",
"Target web inventory to maximize fully viewable rate 20% or higher.",
"Target web inventory to maximize fully viewable rate 10% or higher."
],
"type": "string"
}
},
"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"
},
"EnvironmentAssignedTargetingOptionDetails": {
"description": "Assigned environment targeting option details. This will be populated\nin the details field of an AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_ENVIRONMENT`.",
"id": "EnvironmentAssignedTargetingOptionDetails",
"properties": {
"environment": {
"description": "Output only. The serving environment.",
"enum": [
"ENVIRONMENT_UNSPECIFIED",
"ENVIRONMENT_WEB_OPTIMIZED",
"ENVIRONMENT_WEB_NOT_OPTIMIZED",
"ENVIRONMENT_APP"
],
"enumDescriptions": [
"Default value when environment is not specified in this version. This enum\nis a placeholder for default value and does not represent a real\nenvironment option.",
"Target inventory displayed in browsers. This includes inventory that was\ndesigned for the device it was viewed on, such as mobile websites viewed on\na mobile device. ENVIRONMENT_WEB_NOT_OPTIMIZED, if targeted, should be\ndeleted prior to the deletion of this targeting option.",
"Target inventory displayed in browsers. This includes inventory that was\nnot designed for the device but viewed on it, such as websites optimized\nfor desktop but viewed on a mobile device. ENVIRONMENT_WEB_OPTIMIZED should\nbe targeted prior to the addition of this targeting option.",
"Target inventory displayed in apps."
],
"type": "string"
},
"targetingOptionId": {
"description": "Required. The targeting_option_id of a\nTargetingOption of type `TARGETING_TYPE_ENVIRONMENT` (e.g., \"508010\"\nfor targeting the `ENVIRONMENT_WEB_OPTIMIZED` option).",
"type": "string"
}
},
"type": "object"
},
"EnvironmentTargetingOptionDetails": {
"description": "Represents a targetable environment. This will be populated in the\nenvironment_details field of a\nTargetingOption when targeting_type is\n`TARGETING_TYPE_ENVIRONMENT`.",
"id": "EnvironmentTargetingOptionDetails",
"properties": {
"environment": {
"description": "Output only. The serving environment.",
"enum": [
"ENVIRONMENT_UNSPECIFIED",
"ENVIRONMENT_WEB_OPTIMIZED",
"ENVIRONMENT_WEB_NOT_OPTIMIZED",
"ENVIRONMENT_APP"
],
"enumDescriptions": [
"Default value when environment is not specified in this version. This enum\nis a placeholder for default value and does not represent a real\nenvironment option.",
"Target inventory displayed in browsers. This includes inventory that was\ndesigned for the device it was viewed on, such as mobile websites viewed on\na mobile device. ENVIRONMENT_WEB_NOT_OPTIMIZED, if targeted, should be\ndeleted prior to the deletion of this targeting option.",
"Target inventory displayed in browsers. This includes inventory that was\nnot designed for the device but viewed on it, such as websites optimized\nfor desktop but viewed on a mobile device. ENVIRONMENT_WEB_OPTIMIZED should\nbe targeted prior to the addition of this targeting option.",
"Target inventory displayed in apps."
],
"type": "string"
}
},
"type": "object"
},
"ExchangeAssignedTargetingOptionDetails": {
"description": "Details for assigned exchange targeting option. This will be populated in\nthe details field of an AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_EXCHANGE`.",
"id": "ExchangeAssignedTargetingOptionDetails",
"properties": {
"targetingOptionId": {
"description": "Required. The targeting_option_id of a\nTargetingOption of type `TARGETING_TYPE_EXCHANGE`.",
"type": "string"
}
},
"type": "object"
},
"ExchangeReviewStatus": {
"description": "Exchange review status for the creative.",
"id": "ExchangeReviewStatus",
"properties": {
"exchange": {
"description": "The exchange reviewing the creative.",
"enum": [
"EXCHANGE_UNSPECIFIED",
"EXCHANGE_GOOGLE_AD_MANAGER",
"EXCHANGE_APPNEXUS",
"EXCHANGE_BRIGHTROLL",
"EXCHANGE_ADFORM",
"EXCHANGE_ADMETA",
"EXCHANGE_ADMIXER",
"EXCHANGE_ADSMOGO",
"EXCHANGE_ADSWIZZ",
"EXCHANGE_BIDSWITCH",
"EXCHANGE_BRIGHTROLL_DISPLAY",
"EXCHANGE_CADREON",
"EXCHANGE_DAILYMOTION",
"EXCHANGE_FIVE",
"EXCHANGE_FLUCT",
"EXCHANGE_FREEWHEEL",
"EXCHANGE_GENIEE",
"EXCHANGE_GUMGUM",
"EXCHANGE_IMOBILE",
"EXCHANGE_IBILLBOARD",
"EXCHANGE_IMPROVE_DIGITAL",
"EXCHANGE_INDEX",
"EXCHANGE_KARGO",
"EXCHANGE_MICROAD",
"EXCHANGE_MOPUB",
"EXCHANGE_NEND",
"EXCHANGE_ONE_BY_AOL_DISPLAY",
"EXCHANGE_ONE_BY_AOL_MOBILE",
"EXCHANGE_ONE_BY_AOL_VIDEO",
"EXCHANGE_OOYALA",
"EXCHANGE_OPENX",
"EXCHANGE_PERMODO",
"EXCHANGE_PLATFORMONE",
"EXCHANGE_PLATFORMID",
"EXCHANGE_PUBMATIC",
"EXCHANGE_PULSEPOINT",
"EXCHANGE_REVENUEMAX",
"EXCHANGE_RUBICON",
"EXCHANGE_SMARTCLIP",
"EXCHANGE_SMARTRTB",
"EXCHANGE_SMARTSTREAMTV",
"EXCHANGE_SOVRN",
"EXCHANGE_SPOTXCHANGE",
"EXCHANGE_STROER",
"EXCHANGE_TEADSTV",
"EXCHANGE_TELARIA",
"EXCHANGE_TVN",
"EXCHANGE_UNITED",
"EXCHANGE_YIELDLAB",
"EXCHANGE_YIELDMO",
"EXCHANGE_UNRULYX",
"EXCHANGE_OPEN8",
"EXCHANGE_TRITON",
"EXCHANGE_TRIPLELIFT",
"EXCHANGE_TABOOLA",
"EXCHANGE_INMOBI",
"EXCHANGE_SMAATO",
"EXCHANGE_AJA",
"EXCHANGE_NEXSTAR_DIGITAL",
"EXCHANGE_WAZE"
],
"enumDescriptions": [
"Exchange is not specified or is unknown in this version.",
"Google Ad Manager.",
"AppNexus.",
"BrightRoll Exchange for Video from Yahoo!.",
"Adform.",
"Admeta.",
"Admixer.",
"AdsMogo.",
"AdsWizz.",
"BidSwitch.",
"BrightRoll Exchange for Display from Yahoo!.",
"Cadreon.",
"Dailymotion.",
"Five.",
"Fluct.",
"FreeWheel SSP.",
"Geniee.",
"GumGum.",
"i-mobile.",
"iBILLBOARD.",
"Improve Digital.",
"Index Exchange.",
"Kargo.",
"MicroAd.",
"MoPub.",
"Nend.",
"ONE by AOL: Display Market Place.",
"ONE by AOL: Mobile.",
"ONE by AOL: Video.",
"Ooyala.",
"OpenX.",
"Permodo.",
"Platform One.",
"PlatformId.",
"PubMatic.",
"PulsePoint.",
"RevenueMax.",
"Rubicon.",
"SmartClip.",
"SmartRTB+.",
"SmartstreamTv.",
"Sovrn.",
"SpotXchange.",
"Ströer SSP.",
"TeadsTv.",
"Telaria.",
"TVN.",
"United.",
"Yieldlab.",
"Yieldmo.",
"UnrulyX",
"Open8",
"Triton.",
"TripleLift",
"Taboola",
"InMobi.",
"Smaato",
"Aja.",
"Nexstar Digital.",
"Waze."
],
"type": "string"
},
"status": {
"description": "Status of the exchange review.",
"enum": [
"REVIEW_STATUS_UNSPECIFIED",
"REVIEW_STATUS_APPROVED",
"REVIEW_STATUS_REJECTED",
"REVIEW_STATUS_PENDING"
],
"enumDescriptions": [
"Type value is not specified or is unknown in this version.",
"The creative is approved.",
"The creative is rejected.",
"The creative is pending review."
],
"type": "string"
}
},
"type": "object"
},
"ExchangeTargetingOptionDetails": {
"description": "Represents a targetable exchange. This will be populated in the\nexchange_details field\nof a TargetingOption when\ntargeting_type is\n`TARGETING_TYPE_EXCHANGE`.",
"id": "ExchangeTargetingOptionDetails",
"properties": {
"exchange": {
"description": "Output only. The type of exchange.",
"enum": [
"EXCHANGE_UNSPECIFIED",
"EXCHANGE_GOOGLE_AD_MANAGER",
"EXCHANGE_APPNEXUS",
"EXCHANGE_BRIGHTROLL",
"EXCHANGE_ADFORM",
"EXCHANGE_ADMETA",
"EXCHANGE_ADMIXER",
"EXCHANGE_ADSMOGO",
"EXCHANGE_ADSWIZZ",
"EXCHANGE_BIDSWITCH",
"EXCHANGE_BRIGHTROLL_DISPLAY",
"EXCHANGE_CADREON",
"EXCHANGE_DAILYMOTION",
"EXCHANGE_FIVE",
"EXCHANGE_FLUCT",
"EXCHANGE_FREEWHEEL",
"EXCHANGE_GENIEE",
"EXCHANGE_GUMGUM",
"EXCHANGE_IMOBILE",
"EXCHANGE_IBILLBOARD",
"EXCHANGE_IMPROVE_DIGITAL",
"EXCHANGE_INDEX",
"EXCHANGE_KARGO",
"EXCHANGE_MICROAD",
"EXCHANGE_MOPUB",
"EXCHANGE_NEND",
"EXCHANGE_ONE_BY_AOL_DISPLAY",
"EXCHANGE_ONE_BY_AOL_MOBILE",
"EXCHANGE_ONE_BY_AOL_VIDEO",
"EXCHANGE_OOYALA",
"EXCHANGE_OPENX",
"EXCHANGE_PERMODO",
"EXCHANGE_PLATFORMONE",
"EXCHANGE_PLATFORMID",
"EXCHANGE_PUBMATIC",
"EXCHANGE_PULSEPOINT",
"EXCHANGE_REVENUEMAX",
"EXCHANGE_RUBICON",
"EXCHANGE_SMARTCLIP",
"EXCHANGE_SMARTRTB",
"EXCHANGE_SMARTSTREAMTV",
"EXCHANGE_SOVRN",
"EXCHANGE_SPOTXCHANGE",
"EXCHANGE_STROER",
"EXCHANGE_TEADSTV",
"EXCHANGE_TELARIA",
"EXCHANGE_TVN",
"EXCHANGE_UNITED",
"EXCHANGE_YIELDLAB",
"EXCHANGE_YIELDMO",
"EXCHANGE_UNRULYX",
"EXCHANGE_OPEN8",
"EXCHANGE_TRITON",
"EXCHANGE_TRIPLELIFT",
"EXCHANGE_TABOOLA",
"EXCHANGE_INMOBI",
"EXCHANGE_SMAATO",
"EXCHANGE_AJA",
"EXCHANGE_NEXSTAR_DIGITAL",
"EXCHANGE_WAZE"
],
"enumDescriptions": [
"Exchange is not specified or is unknown in this version.",
"Google Ad Manager.",
"AppNexus.",
"BrightRoll Exchange for Video from Yahoo!.",
"Adform.",
"Admeta.",
"Admixer.",
"AdsMogo.",
"AdsWizz.",
"BidSwitch.",
"BrightRoll Exchange for Display from Yahoo!.",
"Cadreon.",
"Dailymotion.",
"Five.",
"Fluct.",
"FreeWheel SSP.",
"Geniee.",
"GumGum.",
"i-mobile.",
"iBILLBOARD.",
"Improve Digital.",
"Index Exchange.",
"Kargo.",
"MicroAd.",
"MoPub.",
"Nend.",
"ONE by AOL: Display Market Place.",
"ONE by AOL: Mobile.",
"ONE by AOL: Video.",
"Ooyala.",
"OpenX.",
"Permodo.",
"Platform One.",
"PlatformId.",
"PubMatic.",
"PulsePoint.",
"RevenueMax.",
"Rubicon.",
"SmartClip.",
"SmartRTB+.",
"SmartstreamTv.",
"Sovrn.",
"SpotXchange.",
"Ströer SSP.",
"TeadsTv.",
"Telaria.",
"TVN.",
"United.",
"Yieldlab.",
"Yieldmo.",
"UnrulyX",
"Open8",
"Triton.",
"TripleLift",
"Taboola",
"InMobi.",
"Smaato",
"Aja.",
"Nexstar Digital.",
"Waze."
],
"type": "string"
}
},
"type": "object"
},
"ExitEvent": {
"description": "Exit event of the creative.",
"id": "ExitEvent",
"properties": {
"name": {
"description": "The name of the click tag of the exit event.\n\nThe name must be unique within one creative.\n\nLeave it empty or unset for creatives containing image assets only.",
"type": "string"
},
"reportingName": {
"description": "The name used to identify this event in reports.\nLeave it empty or unset for creatives containing image assets only.",
"type": "string"
},
"type": {
"description": "Required. The type of the exit event.",
"enum": [
"EXIT_EVENT_TYPE_UNSPECIFIED",
"EXIT_EVENT_TYPE_DEFAULT",
"EXIT_EVENT_TYPE_BACKUP"
],
"enumDescriptions": [
"Exit event type is not specified or is unknown in this version.",
"The exit event is the default one.",
"The exit event is a backup exit event.\nThere could be multiple backup exit events in a creative."
],
"type": "string"
},
"url": {
"description": "Required. The click through URL of the exit event.\nThis is required when type is:\n\n* `EXIT_EVENT_TYPE_DEFAULT`\n* `EXIT_EVENT_TYPE_BACKUP`",
"type": "string"
}
},
"type": "object"
},
"FirstAndThirdPartyAudience": {
"description": "Describes a first or third party audience list used for targeting.\nFirst party audiences are created via usage of client data.\nThird party audiences are provided by Third Party data providers and can only\nbe licensed to customers.",
"id": "FirstAndThirdPartyAudience",
"properties": {
"activeDisplayAudienceSize": {
"description": "Output only. The estimated audience size for the Display network in the past month.\n\nIf the size is less than 1000, the number will be hidden and 0 will be\nreturned due to privacy reasons. Otherwise, the number will be rounded off\nto two significant digits.\n\nOnly returned in GET request.",
"format": "int64",
"type": "string"
},
"audienceSource": {
"description": "Output only. The source of the audience.",
"enum": [
"AUDIENCE_SOURCE_UNSPECIFIED",
"DISPLAY_VIDEO_360",
"CAMPAIGN_MANAGER",
"AD_MANAGER",
"SEARCH_ADS_360",
"YOUTUBE",
"ADS_DATA_HUB"
],
"enumDescriptions": [
"Default value when audience source is not specified or is unknown.",
"Originated from Display \u0026 Video 360.",
"Originated from Campaign Manager.",
"Originated from Google Ad Manager.",
"Originated from Search Ads 360.",
"Originated from Youtube.",
"Originated from Ads Data Hub."
],
"type": "string"
},
"audienceType": {
"description": "Output only. The type of the audience.",
"enum": [
"AUDIENCE_TYPE_UNSPECIFIED",
"CUSTOMER_MATCH_CONTACT_INFO",
"CUSTOMER_MATCH_DEVICE_ID",
"CUSTOMER_MATCH_USER_ID",
"ACTIVITY_BASED",
"FREQUENCY_CAP",
"TAG_BASED",
"YOUTUBE_USERS",
"LICENSED"
],
"enumDescriptions": [
"Default value when type is not specified or is unknown.",
"Audience was generated through matching customers to known contact\ninformation.",
"Audience was generated through matching customers to known Mobile device\nIDs.",
"Audience was generated through matching customers to known User IDs.",
"Audience was created based on campaign activity.",
"Audience was created based on excluding the number of impressions they\nwere served.",
"Audience was created based on custom variables attached to pixel.",
"Audience was created based on past interactions with videos, TrueView\nads, or YouTube channel.",
"Subtype of third party audience type."
],
"type": "string"
},
"description": {
"description": "The user-provided description of the audience.\n\nOnly applicable to first party audiences.",
"type": "string"
},
"displayAudienceSize": {
"description": "Output only. The estimated audience size for the Display network.\n\nIf the size is less than 1000, the number will be hidden and 0 will be\nreturned due to privacy reasons. Otherwise, the number will be rounded off\nto two significant digits.\n\nOnly returned in GET request.",
"format": "int64",
"type": "string"
},
"displayDesktopAudienceSize": {
"description": "Output only. The estimated desktop audience size in Display network.\n\nIf the size is less than 1000, the number will be hidden and 0 will be\nreturned due to privacy reasons. Otherwise, the number will be rounded off\nto two significant digits.\n\nOnly applicable to first party audiences.\n\nOnly returned in GET request.",
"format": "int64",
"type": "string"
},
"displayMobileAppAudienceSize": {
"description": "Output only. The estimated mobile app audience size in Display network.\n\nIf the size is less than 1000, the number will be hidden and 0 will be\nreturned due to privacy reasons. Otherwise, the number will be rounded off\nto two significant digits.\n\nOnly applicable to first party audiences.\n\nOnly returned in GET request.",
"format": "int64",
"type": "string"
},
"displayMobileWebAudienceSize": {
"description": "Output only. The estimated mobile web audience size in Display network.\n\nIf the size is less than 1000, the number will be hidden and 0 will be\nreturned due to privacy reasons. Otherwise, the number will be rounded off\nto two significant digits.\n\nOnly applicable to first party audiences.\n\nOnly returned in GET request.",
"format": "int64",
"type": "string"
},
"displayName": {
"description": "The display name of the first and third party audience.",
"type": "string"
},
"firstAndThirdPartyAudienceId": {
"description": "Output only. The unique ID of the first and third party audience. Assigned by the\nsystem.",
"format": "int64",
"type": "string"
},
"firstAndThirdPartyAudienceType": {
"description": "Output only. Whether the audience is a first or third party audience.",
"enum": [
"FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_UNSPECIFIED",
"FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_FIRST_PARTY",
"FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_THIRD_PARTY"
],
"enumDescriptions": [
"Default value when type is not specified or is unknown.",
"Audience that is created via usage of client data.",
"Audience that is provided by Third Party data providers."
],
"type": "string"
},
"gmailAudienceSize": {
"description": "Output only. The estimated audience size for Gmail network.\n\nIf the size is less than 1000, the number will be hidden and 0 will be\nreturned due to privacy reasons. Otherwise, the number will be rounded off\nto two significant digits.\n\nOnly applicable to first party audiences.\n\nOnly returned in GET request.",
"format": "int64",
"type": "string"
},
"membershipDurationDays": {
"description": "The duration in days that an entry remains in the audience after the\nqualifying event.\n\nOnly applicable to first party audiences.",
"format": "int64",
"type": "string"
},
"name": {
"description": "Output only. The resource name of the first and third party audience.",
"type": "string"
},
"youtubeAudienceSize": {
"description": "Output only. The estimated audience size for YouTube network.\n\nIf the size is less than 1000, the number will be hidden and 0 will be\nreturned due to privacy reasons. Otherwise, the number will be rounded off\nto two significant digits.\n\nOnly applicable to first party audiences.\n\nOnly returned in GET request.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"FirstAndThirdPartyAudienceGroup": {
"description": "Details of first and third party audience group.\nAll first and third party audience targeting settings are logically ‘OR’ of\neach other.",
"id": "FirstAndThirdPartyAudienceGroup",
"properties": {
"settings": {
"description": "Required. All first and third party audience targeting settings in first and\nthird party audience group.\nRepeated settings with same id are not allowed.",
"items": {
"$ref": "FirstAndThirdPartyAudienceTargetingSetting"
},
"type": "array"
}
},
"type": "object"
},
"FirstAndThirdPartyAudienceTargetingSetting": {
"description": "Details of first and third party audience targeting setting.",
"id": "FirstAndThirdPartyAudienceTargetingSetting",
"properties": {
"firstAndThirdPartyAudienceId": {
"description": "Required. First and third party audience id of the first and third party audience\ntargeting setting. This id is\nfirst_and_third_party_audience_id.",
"format": "int64",
"type": "string"
},
"recency": {
"description": "The recency of the first and third party audience targeting setting.\nOnly applicable to first party audiences, otherwise\nwill be ignored. For more info, refer to\nhttps://support.google.com/displayvideo/answer/2949947#recency\nWhen unspecified, no recency limit will be used.",
"enum": [
"RECENCY_NO_LIMIT",
"RECENCY_1_MINUTE",
"RECENCY_5_MINUTES",
"RECENCY_10_MINUTES",
"RECENCY_15_MINUTES",
"RECENCY_30_MINUTES",
"RECENCY_1_HOUR",
"RECENCY_2_HOURS",
"RECENCY_3_HOURS",
"RECENCY_6_HOURS",
"RECENCY_12_HOURS",
"RECENCY_1_DAY",
"RECENCY_2_DAYS",
"RECENCY_3_DAYS",
"RECENCY_5_DAYS",
"RECENCY_7_DAYS",
"RECENCY_10_DAYS",
"RECENCY_14_DAYS",
"RECENCY_15_DAYS",
"RECENCY_21_DAYS",
"RECENCY_28_DAYS",
"RECENCY_30_DAYS",
"RECENCY_40_DAYS",
"RECENCY_60_DAYS",
"RECENCY_90_DAYS",
"RECENCY_120_DAYS",
"RECENCY_180_DAYS",
"RECENCY_270_DAYS",
"RECENCY_365_DAYS"
],
"enumDescriptions": [
"No limit of recency.",
"Recency is 1 minute.",
"Recency is 5 minutes.",
"Recency is 10 minutes.",
"Recency is 15 minutes.",
"Recency is 30 minutes.",
"Recency is 1 hour.",
"Recency is 2 hours.",
"Recency is 3 hours.",
"Recency is 6 hours.",
"Recency is 12 hours.",
"Recency is 1 day.",
"Recency is 2 days.",
"Recency is 3 days.",
"Recency is 5 days.",
"Recency is 7 days.",
"Recency is 10 days.",
"Recency is 14 days.",
"Recency is 15 days.",
"Recency is 21 days.",
"Recency is 28 days.",
"Recency is 30 days.",
"Recency is 40 days.",
"Recency is 60 days.",
"Recency is 90 days.",
"Recency is 120 days.",
"Recency is 180 days.",
"Recency is 270 days.",
"Recency is 365 days."
],
"type": "string"
}
},
"type": "object"
},
"FixedBidStrategy": {
"description": "A strategy that uses a fixed bidding price.",
"id": "FixedBidStrategy",
"properties": {
"bidAmountMicros": {
"description": "The fixed bid amount, in micros of the advertiser's currency.\nFor insertion order entity,\nbid_amount_micros should be set as 0.\nFor line item entity,\nbid_amount_micros must be greater\nthan or equal to billable unit of the given currency and smaller than or\nequal to the upper limit 1000000000.\n\nFor example, 1500000 represents 1.5 standard units of the currency.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"FloodlightGroup": {
"description": "A single Floodlight group.",
"id": "FloodlightGroup",
"properties": {
"activeViewConfig": {
"$ref": "ActiveViewVideoViewabilityMetricConfig",
"description": "The Active View video viewability metric configuration for the Floodlight\ngroup."
},
"customVariables": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "User-defined custom variables owned by the Floodlight group.\nUse custom Floodlight variables to create reporting data that is tailored\nto your unique business needs. Custom Floodlight variables use the keys\n`U1=`, `U2=`, and so on, and can take any values that you choose to pass to\nthem. You can use them to track virtually any type of data that you collect\nabout your customers, such as the genre of movie that a customer purchases,\nthe country to which the item is shipped, and so on.\n\nCustom Floodlight variables may not be used to pass any data that could be\nused or recognized as personally identifiable information (PII).\n\nExample:\n`custom_variables {\n fields {\n \"U1\": value { number_value: 123.4 },\n \"U2\": value { string_value: \"MyVariable2\" },\n \"U3\": value { string_value: \"MyVariable3\" }\n }\n}`\n\nAcceptable values for keys are \"U1\" through \"U100\", inclusive. String\nvalues must be less than 64 characters long, and cannot contain the\nfollowing characters: `\"\u003c\u003e`.",
"type": "object"
},
"displayName": {
"description": "Required. The display name of the Floodlight group.",
"type": "string"
},
"floodlightGroupId": {
"description": "Output only. The unique ID of the Floodlight group. Assigned by the system.",
"format": "int64",
"type": "string"
},
"lookbackWindow": {
"$ref": "LookbackWindow",
"description": "Required. The lookback window for the Floodlight group.\nBoth click_days and\nimpression_days are required. Acceptable\nvalues for both are `0` to `90`, inclusive."
},
"name": {
"description": "Output only. The resource name of the Floodlight group.",
"type": "string"
},
"webTagType": {
"description": "Required. The web tag type enabled for the Floodlight group.",
"enum": [
"WEB_TAG_TYPE_UNSPECIFIED",
"WEB_TAG_TYPE_NONE",
"WEB_TAG_TYPE_IMAGE",
"WEB_TAG_TYPE_DYNAMIC"
],
"enumDescriptions": [
"Type value is not specified or is unknown in this version.",
"No tag type.",
"Image tag.",
"Dynamic tag."
],
"type": "string"
}
},
"type": "object"
},
"FrequencyCap": {
"description": "Settings that control the number of times a user may be shown with the same\nad during a given time period.",
"id": "FrequencyCap",
"properties": {
"maxImpressions": {
"description": "The maximum number of times a user may be shown with the same ad\nduring this period. Must be greater than 0.\n\nApplicable when unlimited is `false`.",
"format": "int32",
"type": "integer"
},
"timeUnit": {
"description": "The time unit in which the frequency cap will be applied.\n\nApplicable when unlimited is `false`.",
"enum": [
"TIME_UNIT_UNSPECIFIED",
"TIME_UNIT_LIFETIME",
"TIME_UNIT_MONTHS",
"TIME_UNIT_WEEKS",
"TIME_UNIT_DAYS",
"TIME_UNIT_HOURS",
"TIME_UNIT_MINUTES"
],
"enumDescriptions": [
"Time unit value is not specified or is unknown in this version.",
"The frequency cap will be applied to the whole life time of the line\nitem.",
"The frequency cap will be applied to a number of months.",
"The frequency cap will be applied to a number of weeks.",
"The frequency cap will be applied to a number of days.",
"The frequency cap will be applied to a number of hours.",
"The frequency cap will be applied to a number of minutes."
],
"type": "string"
},
"timeUnitCount": {
"description": "The number of time_unit the frequency cap will\nlast.\n\nApplicable when unlimited is `false`.\nThe following restrictions apply based on the value of\ntime_unit:\n\n* `TIME_UNIT_LIFETIME` - this field is output only and will\ndefault to 1\n* `TIME_UNIT_MONTHS` - must be between 1 and 2\n* `TIME_UNIT_WEEKS` - must be between 1 and 4\n* `TIME_UNIT_DAYS` - must be between 1 and 6\n* `TIME_UNIT_HOURS` - must be between 1 and 23\n* `TIME_UNIT_MINUTES` - must be between 1 and 59",
"format": "int32",
"type": "integer"
},
"unlimited": {
"description": "Whether unlimited frequency capping is applied. When this field is set to\n`true`, the remaining frequency cap fields are not applicable.",
"type": "boolean"
}
},
"type": "object"
},
"GenderAssignedTargetingOptionDetails": {
"description": "Details for assigned gender targeting option. This will be populated in\nthe details field of an AssignedTargetingOption when\ntargeting_type is\n`TARTGETING_TYPE_GENDER`.",
"id": "GenderAssignedTargetingOptionDetails",
"properties": {
"gender": {
"description": "Output only. The gender of the audience.",
"enum": [
"GENDER_UNSPECIFIED",
"GENDER_MALE",
"GENDER_FEMALE",
"GENDER_UNKNOWN"
],
"enumDescriptions": [
"Default value when gender is not specified in this version. This enum is a\nplace holder for default value and does not represent a real gender option.",
"The audience gender is male.",
"The audience gender is female.",
"The audience gender is unknown."
],
"type": "string"
},
"targetingOptionId": {
"description": "Required. The targeting_option_id of a\nTargetingOption of type `TARGETING_TYPE_GENDER`.",
"type": "string"
}
},
"type": "object"
},
"GenderTargetingOptionDetails": {
"description": "Represents a targetable gender. This will be populated in the\ngender_details field of a TargetingOption\nwhen targeting_type is\n`TARGETING_TYPE_GENDER`.",
"id": "GenderTargetingOptionDetails",
"properties": {
"gender": {
"description": "Output only. The gender of an audience.",
"enum": [
"GENDER_UNSPECIFIED",
"GENDER_MALE",
"GENDER_FEMALE",
"GENDER_UNKNOWN"
],
"enumDescriptions": [
"Default value when gender is not specified in this version. This enum is a\nplace holder for default value and does not represent a real gender option.",
"The audience gender is male.",
"The audience gender is female.",
"The audience gender is unknown."
],
"type": "string"
}
},
"type": "object"
},
"GeoRegionAssignedTargetingOptionDetails": {
"description": "Details for assigned geographic region targeting option. This will be\npopulated in the details field of an AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_GEO_REGION`.",
"id": "GeoRegionAssignedTargetingOptionDetails",
"properties": {
"displayName": {
"description": "Output only. The display name of the geographic region (e.g., \"Ontario, Canada\").",
"type": "string"
},
"geoRegionType": {
"description": "Output only. The type of geographic region targeting.",
"enum": [
"GEO_REGION_TYPE_UNKNOWN",
"GEO_REGION_TYPE_OTHER",
"GEO_REGION_TYPE_COUNTRY",
"GEO_REGION_TYPE_REGION",
"GEO_REGION_TYPE_TERRITORY",
"GEO_REGION_TYPE_PROVINCE",
"GEO_REGION_TYPE_STATE",
"GEO_REGION_TYPE_PREFECTURE",
"GEO_REGION_TYPE_GOVERNORATE",
"GEO_REGION_TYPE_CANTON",
"GEO_REGION_TYPE_UNION_TERRITORY",
"GEO_REGION_TYPE_AUTONOMOUS_COMMUNITY",
"GEO_REGION_TYPE_DMA_REGION",
"GEO_REGION_TYPE_METRO",
"GEO_REGION_TYPE_CONGRESSIONAL_DISTRICT",
"GEO_REGION_TYPE_COUNTY",
"GEO_REGION_TYPE_MUNICIPALITY",
"GEO_REGION_TYPE_CITY",
"GEO_REGION_TYPE_POSTAL_CODE",
"GEO_REGION_TYPE_DEPARTMENT",
"GEO_REGION_TYPE_AIRPORT",
"GEO_REGION_TYPE_TV_REGION",
"GEO_REGION_TYPE_OKRUG",
"GEO_REGION_TYPE_BOROUGH",
"GEO_REGION_TYPE_CITY_REGION",
"GEO_REGION_TYPE_ARRONDISSEMENT",
"GEO_REGION_TYPE_NEIGHBORHOOD",
"GEO_REGION_TYPE_UNIVERSITY",
"GEO_REGION_TYPE_DISTRICT"
],
"enumDescriptions": [
"The geographic region type is unknown.",
"The geographic region type is other.",
"The geographic region is a country.",
"The geographic region type is region.",
"The geographic region is a territory.",
"The geographic region is a province.",
"The geographic region is a state.",
"The geographic region is a prefecture.",
"The geographic region is a governorate.",
"The geographic region is a canton.",
"The geographic region is a union territory.",
"The geographic region is an autonomous community.",
"The geographic region is a designated market area (DMA) region.",
"The geographic region type is metro.",
"The geographic region is a congressional district.",
"The geographic region is a county.",
"The geographic region is a municipality.",
"The geographic region is a city.",
"The geographic region targeting type is postal code.",
"The geographic region targeting type is department.",
"The geographic region is an airport.",
"The geographic region is a TV region.",
"The geographic region is an okrug.",
"The geographic region is a borough.",
"The geographic region is a city region.",
"The geographic region is an arrondissement.",
"The geographic region is a neighborhood.",
"The geographic region is a university.",
"The geographic region is a district."
],
"type": "string"
},
"negative": {
"description": "Indicates if this option is being negatively targeted.",
"type": "boolean"
},
"targetingOptionId": {
"description": "Required. The targeting_option_id of a\nTargetingOption of type `TARGETING_TYPE_GEO_REGION`.",
"type": "string"
}
},
"type": "object"
},
"GeoRegionTargetingOptionDetails": {
"description": "Represents a targetable geographic region. This will be populated in the\ngeo_region_details field when\ntargeting_type is\n`TARGETING_TYPE_GEO_REGION`.",
"id": "GeoRegionTargetingOptionDetails",
"properties": {
"displayName": {
"description": "Output only. The display name of the geographic region (e.g., \"Ontario, Canada\").",
"type": "string"
},
"geoRegionType": {
"description": "Output only. The type of geographic region targeting.",
"enum": [
"GEO_REGION_TYPE_UNKNOWN",
"GEO_REGION_TYPE_OTHER",
"GEO_REGION_TYPE_COUNTRY",
"GEO_REGION_TYPE_REGION",
"GEO_REGION_TYPE_TERRITORY",
"GEO_REGION_TYPE_PROVINCE",
"GEO_REGION_TYPE_STATE",
"GEO_REGION_TYPE_PREFECTURE",
"GEO_REGION_TYPE_GOVERNORATE",
"GEO_REGION_TYPE_CANTON",
"GEO_REGION_TYPE_UNION_TERRITORY",
"GEO_REGION_TYPE_AUTONOMOUS_COMMUNITY",
"GEO_REGION_TYPE_DMA_REGION",
"GEO_REGION_TYPE_METRO",
"GEO_REGION_TYPE_CONGRESSIONAL_DISTRICT",
"GEO_REGION_TYPE_COUNTY",
"GEO_REGION_TYPE_MUNICIPALITY",
"GEO_REGION_TYPE_CITY",
"GEO_REGION_TYPE_POSTAL_CODE",
"GEO_REGION_TYPE_DEPARTMENT",
"GEO_REGION_TYPE_AIRPORT",
"GEO_REGION_TYPE_TV_REGION",
"GEO_REGION_TYPE_OKRUG",
"GEO_REGION_TYPE_BOROUGH",
"GEO_REGION_TYPE_CITY_REGION",
"GEO_REGION_TYPE_ARRONDISSEMENT",
"GEO_REGION_TYPE_NEIGHBORHOOD",
"GEO_REGION_TYPE_UNIVERSITY",
"GEO_REGION_TYPE_DISTRICT"
],
"enumDescriptions": [
"The geographic region type is unknown.",
"The geographic region type is other.",
"The geographic region is a country.",
"The geographic region type is region.",
"The geographic region is a territory.",
"The geographic region is a province.",
"The geographic region is a state.",
"The geographic region is a prefecture.",
"The geographic region is a governorate.",
"The geographic region is a canton.",
"The geographic region is a union territory.",
"The geographic region is an autonomous community.",
"The geographic region is a designated market area (DMA) region.",
"The geographic region type is metro.",
"The geographic region is a congressional district.",
"The geographic region is a county.",
"The geographic region is a municipality.",
"The geographic region is a city.",
"The geographic region targeting type is postal code.",
"The geographic region targeting type is department.",
"The geographic region is an airport.",
"The geographic region is a TV region.",
"The geographic region is an okrug.",
"The geographic region is a borough.",
"The geographic region is a city region.",
"The geographic region is an arrondissement.",
"The geographic region is a neighborhood.",
"The geographic region is a university.",
"The geographic region is a district."
],
"type": "string"
}
},
"type": "object"
},
"GoogleAudience": {
"description": "Describes a Google audience resource.\nIncludes Google audience lists.",
"id": "GoogleAudience",
"properties": {
"displayName": {
"description": "Output only. The display name of the Google audience.\n.",
"type": "string"
},
"googleAudienceId": {
"description": "Output only. The unique ID of the Google audience. Assigned by the system.",
"format": "int64",
"type": "string"
},
"googleAudienceType": {
"description": "Output only. The type of Google audience.\n.",
"enum": [
"GOOGLE_AUDIENCE_TYPE_UNSPECIFIED",
"GOOGLE_AUDIENCE_TYPE_AFFINITY",
"GOOGLE_AUDIENCE_TYPE_IN_MARKET",
"GOOGLE_AUDIENCE_TYPE_INSTALLED_APPS",
"GOOGLE_AUDIENCE_TYPE_NEW_MOBILE_DEVICES"
],
"enumDescriptions": [
"Default value when type is not specified or is unknown.",
"Affinity type Google audience.",
"In-Market type Google audience.",
"Installed-apps type Google audience.",
"New-mobile-devices type Google audience."
],
"type": "string"
},
"name": {
"description": "Output only. The resource name of the google audience.",
"type": "string"
}
},
"type": "object"
},
"GoogleAudienceGroup": {
"description": "Details of Google audience group.\nAll Google audience targeting settings are logically ‘OR’ of each other.",
"id": "GoogleAudienceGroup",
"properties": {
"settings": {
"description": "Required. All Google audience targeting settings in Google audience group.\nRepeated settings with same id will be ignored.",
"items": {
"$ref": "GoogleAudienceTargetingSetting"
},
"type": "array"
}
},
"type": "object"
},
"GoogleAudienceTargetingSetting": {
"description": "Details of Google audience targeting setting.",
"id": "GoogleAudienceTargetingSetting",
"properties": {
"googleAudienceId": {
"description": "Required. Google audience id of the Google audience targeting setting.\nThis id is google_audience_id.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleBytestreamMedia": {
"description": "Media resource.",
"id": "GoogleBytestreamMedia",
"properties": {
"resourceName": {
"description": "Name of the media resource.",
"type": "string"
}
},
"type": "object"
},
"HouseholdIncomeAssignedTargetingOptionDetails": {
"description": "Details for assigned household income targeting option. This will be\npopulated in the details field of an AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_HOUSEHOLD_INCOME`.",
"id": "HouseholdIncomeAssignedTargetingOptionDetails",
"properties": {
"householdIncome": {
"description": "Output only. The household income of the audience.",
"enum": [
"HOUSEHOLD_INCOME_UNSPECIFIED",
"HOUSEHOLD_INCOME_UNKNOWN",
"HOUSEHOLD_INCOME_LOWER_50_PERCENT",
"HOUSEHOLD_INCOME_TOP_41_TO_50_PERCENT",
"HOUSEHOLD_INCOME_TOP_31_TO_40_PERCENT",
"HOUSEHOLD_INCOME_TOP_21_TO_30_PERCENT",
"HOUSEHOLD_INCOME_TOP_11_TO_20_PERCENT",
"HOUSEHOLD_INCOME_TOP_10_PERCENT"
],
"enumDescriptions": [
"Default value when household income is not specified in this version. This\nenum is a placeholder for default value and does not represent a real\nhousehold income option.",
"The household income of the audience is unknown.",
"The audience is in the lower 50% of U.S. household incomes.",
"The audience is in the top 41-50% of U.S. household incomes.",
"The audience is in the top 31-40% of U.S. household incomes.",
"The audience is in the top 21-30% of U.S. household incomes.",
"The audience is in the top 11-20% of U.S. household incomes.",
"The audience is in the top 10% of U.S. household incomes."
],
"type": "string"
},
"targetingOptionId": {
"description": "Required. The targeting_option_id of a\nTargetingOption of type `TARGETING_TYPE_HOUSEHOLD_INCOME`.",
"type": "string"
}
},
"type": "object"
},
"HouseholdIncomeTargetingOptionDetails": {
"description": "Represents a targetable household income. This will be populated in the\nhousehold_income_details field of\na TargetingOption when targeting_type is\n`TARGETING_TYPE_HOUSEHOLD_INCOME`.",
"id": "HouseholdIncomeTargetingOptionDetails",
"properties": {
"householdIncome": {
"description": "Output only. The household income of an audience.",
"enum": [
"HOUSEHOLD_INCOME_UNSPECIFIED",
"HOUSEHOLD_INCOME_UNKNOWN",
"HOUSEHOLD_INCOME_LOWER_50_PERCENT",
"HOUSEHOLD_INCOME_TOP_41_TO_50_PERCENT",
"HOUSEHOLD_INCOME_TOP_31_TO_40_PERCENT",
"HOUSEHOLD_INCOME_TOP_21_TO_30_PERCENT",
"HOUSEHOLD_INCOME_TOP_11_TO_20_PERCENT",
"HOUSEHOLD_INCOME_TOP_10_PERCENT"
],
"enumDescriptions": [
"Default value when household income is not specified in this version. This\nenum is a placeholder for default value and does not represent a real\nhousehold income option.",
"The household income of the audience is unknown.",
"The audience is in the lower 50% of U.S. household incomes.",
"The audience is in the top 41-50% of U.S. household incomes.",
"The audience is in the top 31-40% of U.S. household incomes.",
"The audience is in the top 21-30% of U.S. household incomes.",
"The audience is in the top 11-20% of U.S. household incomes.",
"The audience is in the top 10% of U.S. household incomes."
],
"type": "string"
}
},
"type": "object"
},
"IdFilter": {
"description": "A filtering option that filters entities by their entity IDs.",
"id": "IdFilter",
"properties": {
"adGroupAdIds": {
"description": "TrueView Ads to download by ID. All IDs must belong to the same\nAdvertiser or\nPartner specified in\nCreateSdfDownloadTaskRequest.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"adGroupIds": {
"description": "TrueView Ad Groups to download by ID. All IDs must belong to the same\nAdvertiser or\nPartner specified in\nCreateSdfDownloadTaskRequest.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"campaignIds": {
"description": "Campaigns to download by ID. All IDs must belong to the same\nAdvertiser or\nPartner specified in\nCreateSdfDownloadTaskRequest.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"insertionOrderIds": {
"description": "Insertion Orders to download by ID. All IDs must belong to the same\nAdvertiser or\nPartner specified in\nCreateSdfDownloadTaskRequest.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"lineItemIds": {
"description": "Line Items to download by ID. All IDs must belong to the same\nAdvertiser or\nPartner specified in\nCreateSdfDownloadTaskRequest.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"mediaProductIds": {
"description": "Media Products to download by ID. All IDs must belong to the same\nAdvertiser or\nPartner specified in\nCreateSdfDownloadTaskRequest.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"InsertionOrder": {
"description": "A single insertion order.",
"id": "InsertionOrder",
"properties": {
"advertiserId": {
"description": "Output only. The unique ID of the advertiser the insertion order belongs to.",
"format": "int64",
"type": "string"
},
"bidStrategy": {
"$ref": "BiddingStrategy",
"description": "Optional. The bidding strategy of the insertion order. By default,\nfixed_bid is set."
},
"budget": {
"$ref": "InsertionOrderBudget",
"description": "Required. The budget allocation settings of the insertion order."
},
"campaignId": {
"description": "Required. Immutable. The unique ID of the campaign that the insertion order belongs to.",
"format": "int64",
"type": "string"
},
"displayName": {
"description": "Required. The display name of the insertion order.\n\nMust be UTF-8 encoded with a maximum size of 240 bytes.",
"type": "string"
},
"entityStatus": {
"description": "Required. Controls whether or not the insertion order can spend its budget\nand bid on inventory.\n\n* For\nCreateInsertionOrder method,\nonly `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use\nUpdateInsertionOrder method\nand update the status to `ENTITY_STATUS_ACTIVE` after creation.\n* An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status\nfrom any other status.\n* An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent\ncampaign is not active.",
"enum": [
"ENTITY_STATUS_UNSPECIFIED",
"ENTITY_STATUS_ACTIVE",
"ENTITY_STATUS_ARCHIVED",
"ENTITY_STATUS_DRAFT",
"ENTITY_STATUS_PAUSED",
"ENTITY_STATUS_SCHEDULED_FOR_DELETION"
],
"enumDescriptions": [
"Default value when status is not specified or is unknown in this version.",
"The entity is enabled to bid and spend budget.",
"The entity is archived. Bidding and budget spending are disabled. An\nentity can be deleted after archived. Deleted entities cannot be retrieved.",
"The entity is under draft. Bidding and budget spending are disabled.",
"Bidding and budget spending are paused for the entity.",
"The entity is scheduled for deletion."
],
"type": "string"
},
"frequencyCap": {
"$ref": "FrequencyCap",
"description": "Required. The frequency capping setting of the insertion order."
},
"insertionOrderId": {
"description": "Output only. The unique ID of the insertion order. Assigned by the system.",
"format": "int64",
"type": "string"
},
"integrationDetails": {
"$ref": "IntegrationDetails",
"description": "Additional integration details of the insertion order."
},
"name": {
"description": "Output only. The resource name of the insertion order.",
"type": "string"
},
"pacing": {
"$ref": "Pacing",
"description": "Required. The budget spending speed setting of the insertion order."
},
"partnerCosts": {
"description": "The partner costs associated with the insertion order.\n\nIf absent or empty in\nCreateInsertionOrder\nmethod, the newly created insertion order will inherit partner costs from\nthe partner settings.",
"items": {
"$ref": "PartnerCost"
},
"type": "array"
},
"performanceGoal": {
"$ref": "PerformanceGoal",
"description": "Required. Performance goal of the insertion order."
},
"updateTime": {
"description": "Output only. The timestamp when the insertion order was last updated.\nAssigned by the system.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"InsertionOrderBudget": {
"description": "Settings that control how insertion order budget is allocated.",
"id": "InsertionOrderBudget",
"properties": {
"automationType": {
"description": "The type of automation used to manage bid and budget for\nthe insertion order.\n\nIf this field is unspecified in creation, the value defaults to\n`INSERTION_ORDER_AUTOMATION_TYPE_NONE`.",
"enum": [
"INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED",
"INSERTION_ORDER_AUTOMATION_TYPE_BUDGET",
"INSERTION_ORDER_AUTOMATION_TYPE_NONE",
"INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET"
],
"enumDescriptions": [
"Insertion order automation option is not specified or is unknown in\nthis version.",
"Automatic budget allocation. Allow the system to automatically shift\nbudget to owning line items to optimize performance defined by\nperformance_goal. No automation\non bid settings.",
"No automation of bid or budget on insertion order level.\nBid and budget must be manually configured at the line item level.",
"Allow the system to automatically adjust bids and shift budget to\nowning line items to optimize performance defined by\nperformance_goal."
],
"type": "string"
},
"budgetSegments": {
"description": "Required. The list of budget segments. Use a budget segment to specify\na specific budget for a given period of time an insertion order is running.",
"items": {
"$ref": "InsertionOrderBudgetSegment"
},
"type": "array"
},
"budgetUnit": {
"description": "Required. Immutable. The budget unit specifies whether the budget is currency based or\nimpression based.",
"enum": [
"BUDGET_UNIT_UNSPECIFIED",
"BUDGET_UNIT_CURRENCY",
"BUDGET_UNIT_IMPRESSIONS"
],
"enumDescriptions": [
"Type value is not specified or is unknown in this version.",
"Budgeting in currency amounts.",
"Budgeting in impression amounts."
],
"type": "string"
}
},
"type": "object"
},
"InsertionOrderBudgetSegment": {
"description": "Settings that control the budget of a single budget segment.",
"id": "InsertionOrderBudgetSegment",
"properties": {
"budgetAmountMicros": {
"description": "Required. The budget amount the insertion order will spend for the given\ndate_range.\nThe amount is in micros. Must be greater than 0. For example, 500000000\nrepresents 500 standard units of the currency.",
"format": "int64",
"type": "string"
},
"campaignBudgetId": {
"description": "The ID of the campaign budget linked to this insertion order budget\nsegment.",
"format": "int64",
"type": "string"
},
"dateRange": {
"$ref": "DateRange",
"description": "Required. The start and end date settings of the budget segment. They are resolved\nrelative to the parent advertiser's time zone.\n\n* When creating a new budget segment, both `start_date` and `end_date`\nmust be in the future.\n* An existing budget segment with a `start_date` in the past has a mutable\n`end_date` but an immutable `start_date`.\n* `end_date` must be the `start_date` or later, both before the year 2037."
},
"description": {
"description": "The budget segment description. It can be used to enter Purchase Order\ninformation for each budget segment and have that information printed on\nthe invoices.\n\nMust be UTF-8 encoded with a length of no more than 80 characters.",
"type": "string"
}
},
"type": "object"
},
"IntegralAdScience": {
"description": "Details of Integral Ad Science settings.",
"id": "IntegralAdScience",
"properties": {
"displayViewability": {
"description": "Display Viewability section (applicable to display line items only).",
"enum": [
"PERFORMANCE_VIEWABILITY_UNSPECIFIED",
"PERFORMANCE_VIEWABILITY_40",
"PERFORMANCE_VIEWABILITY_50",
"PERFORMANCE_VIEWABILITY_60",
"PERFORMANCE_VIEWABILITY_70"
],
"enumDescriptions": [
"This enum is only a placeholder and it doesn't specify any display\nviewability options.",
"Target 40% Viewability or Higher.",
"Target 50% Viewability or Higher.",
"Target 60% Viewability or Higher.",
"Target 70% Viewability or Higher."
],
"type": "string"
},
"excludeUnrateable": {
"description": "Brand Safety - **Unrateable**.",
"type": "boolean"
},
"excludedAdFraudRisk": {
"description": "Ad Fraud settings.",
"enum": [
"SUSPICIOUS_ACTIVITY_UNSPECIFIED",
"SUSPICIOUS_ACTIVITY_HR",
"SUSPICIOUS_ACTIVITY_HMR"
],
"enumDescriptions": [
"This enum is only a placeholder and it doesn't specify any ad fraud\nprevention options.",
"Ad Fraud - Exclude High Risk.",
"Ad Fraud - Exclude High and Moderate Risk."
],
"type": "string"
},
"excludedAdultRisk": {
"description": "Brand Safety - **Adult content**.",
"enum": [
"ADULT_UNSPECIFIED",
"ADULT_HR",
"ADULT_HMR"
],
"enumDescriptions": [
"This enum is only a placeholder and it doesn't specify any adult options.",
"Adult - Exclude High Risk.",
"Adult - Exclude High and Moderate Risk."
],
"type": "string"
},
"excludedAlcoholRisk": {
"description": "Brand Safety - **Alcohol**.",
"enum": [
"ALCOHOL_UNSPECIFIED",
"ALCOHOL_HR",
"ALCOHOL_HMR"
],
"enumDescriptions": [
"This enum is only a placeholder and it doesn't specify any alcohol\noptions.",
"Alcohol - Exclude High Risk.",
"Alcohol - Exclude High and Moderate Risk."
],
"type": "string"
},
"excludedDrugsRisk": {
"description": "Brand Safety - **Drugs**.",
"enum": [
"DRUGS_UNSPECIFIED",
"DRUGS_HR",
"DRUGS_HMR"
],
"enumDescriptions": [
"This enum is only a placeholder and it doesn't specify any drugs options.",
"Drugs - Exclude High Risk.",
"Drugs - Exclude High and Moderate Risk."
],
"type": "string"
},
"excludedGamblingRisk": {
"description": "Brand Safety - **Gambling**.",
"enum": [
"GAMBLING_UNSPECIFIED",
"GAMBLING_HR",
"GAMBLING_HMR"
],
"enumDescriptions": [
"This enum is only a placeholder and it doesn't specify any gambling\noptions.",
"Gambling - Exclude High Risk.",
"Gambling - Exclude High and Moderate Risk."
],
"type": "string"
},
"excludedHateSpeechRisk": {
"description": "Brand Safety - **Hate speech**.",
"enum": [
"HATE_SPEECH_UNSPECIFIED",
"HATE_SPEECH_HR",
"HATE_SPEECH_HMR"
],
"enumDescriptions": [
"This enum is only a placeholder and it doesn't specify any hate speech\noptions.",
"Hate Speech - Exclude High Risk.",
"Hate Speech - Exclude High and Moderate Risk."
],
"type": "string"
},
"excludedIllegalDownloadsRisk": {
"description": "Brand Safety - **Illegal downloads**.",
"enum": [
"ILLEGAL_DOWNLOADS_UNSPECIFIED",
"ILLEGAL_DOWNLOADS_HR",
"ILLEGAL_DOWNLOADS_HMR"
],
"enumDescriptions": [
"This enum is only a placeholder and it doesn't specify any illegal\ndownloads options.",
"Illegal Downloads - Exclude High Risk.",
"Illegal Downloads - Exclude High and Moderate Risk."
],
"type": "string"
},
"excludedOffensiveLanguageRisk": {
"description": "Brand Safety - **Offensive language**.",
"enum": [
"OFFENSIVE_LANGUAGE_UNSPECIFIED",
"OFFENSIVE_LANGUAGE_HR",
"OFFENSIVE_LANGUAGE_HMR"
],
"enumDescriptions": [
"This enum is only a placeholder and it doesn't specify any language\noptions.",
"Offensive Language - Exclude High Risk.",
"Offensive Language - Exclude High and Moderate Risk."
],
"type": "string"
},
"excludedViolenceRisk": {
"description": "Brand Safety - **Violence**.",
"enum": [
"VIOLENCE_UNSPECIFIED",
"VIOLENCE_HR",
"VIOLENCE_HMR"
],
"enumDescriptions": [
"This enum is only a placeholder and it doesn't specify any violence\noptions.",
"Violence - Exclude High Risk.",
"Violence - Exclude High and Moderate Risk."
],
"type": "string"
},
"traqScoreOption": {
"description": "True advertising quality (applicable to Display line items only).",
"enum": [
"TRAQ_UNSPECIFIED",
"TRAQ_250",
"TRAQ_500",
"TRAQ_600",
"TRAQ_700",
"TRAQ_750",
"TRAQ_875",
"TRAQ_1000"
],
"enumDescriptions": [
"This enum is only a placeholder and it doesn't specify any true\nadvertising quality scores.",
"TRAQ score 250-1000.",
"TRAQ score 500-1000.",
"TRAQ score 600-1000.",
"TRAQ score 700-1000.",
"TRAQ score 750-1000.",
"TRAQ score 875-1000.",
"TRAQ score 1000."
],
"type": "string"
},
"videoViewability": {
"description": "Video Viewability Section (applicable to video line items only).",
"enum": [
"VIDEO_VIEWABILITY_UNSPECIFIED",
"VIDEO_VIEWABILITY_40",
"VIDEO_VIEWABILITY_50",
"VIDEO_VIEWABILITY_60",
"VIDEO_VIEWABILITY_70"
],
"enumDescriptions": [
"This enum is only a placeholder and it doesn't specify any video\nviewability options.",
"40%+ in view (IAB video viewability standard).",
"50%+ in view (IAB video viewability standard).",
"60%+ in view (IAB video viewability standard).",
"70%+ in view (IAB video viewability standard)."
],
"type": "string"
}
},
"type": "object"
},
"IntegrationDetails": {
"description": "Integration details of an entry.",
"id": "IntegrationDetails",
"properties": {
"details": {
"description": "Additional details of the entry in string format.\n\nMust be UTF-8 encoded with a length of no more than 1000 characters.",
"type": "string"
},
"integrationCode": {
"description": "An external identifier to be associated with the entry.\nThe integration code will show up together with the entry in many\nplaces in the system, for example, reporting.\n\nMust be UTF-8 encoded with a length of no more than 500 characters.",
"type": "string"
}
},
"type": "object"
},
"InventorySource": {
"description": "An inventory source.",
"id": "InventorySource",
"properties": {
"commitment": {
"description": "Whether the inventory source has a guaranteed or non-guaranteed delivery.",
"enum": [
"INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED",
"INVENTORY_SOURCE_COMMITMENT_GUARANTEED",
"INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED"
],
"enumDescriptions": [
"The commitment is not specified or is unknown in this version.",
"The commitment is guaranteed delivery.",
"The commitment is non-guaranteed delivery."
],
"type": "string"
},
"creativeConfigs": {
"description": "The creative requirements of the inventory source.\n\nNot applicable for auction packages.",
"items": {
"$ref": "CreativeConfig"
},
"type": "array"
},
"dealId": {
"description": "The ID in the exchange space that uniquely identifies the inventory source.\n\nMust be unique across buyers within each exchange but not necessarily\nunique across exchanges.",
"type": "string"
},
"deliveryMethod": {
"description": "The delivery method of the inventory source.\n\n* For non-guaranteed inventory sources, the only acceptable value is\n`INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.\n* For guaranteed inventory sources, acceptable values are\n`INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and\n`INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.",
"enum": [
"INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED",
"INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC",
"INVENTORY_SOURCE_DELIVERY_METHOD_TAG"
],
"enumDescriptions": [
"The delivery method is not specified or is unknown in this version.",
"The delivery method is programmatic.",
"The delivery method is tag."
],
"type": "string"
},
"displayName": {
"description": "The display name of the inventory source.\n\nMust be UTF-8 encoded with a maximum size of 240 bytes.",
"type": "string"
},
"exchange": {
"description": "The exchange to which the inventory source belongs.",
"enum": [
"EXCHANGE_UNSPECIFIED",
"EXCHANGE_GOOGLE_AD_MANAGER",
"EXCHANGE_APPNEXUS",
"EXCHANGE_BRIGHTROLL",
"EXCHANGE_ADFORM",
"EXCHANGE_ADMETA",
"EXCHANGE_ADMIXER",
"EXCHANGE_ADSMOGO",
"EXCHANGE_ADSWIZZ",
"EXCHANGE_BIDSWITCH",
"EXCHANGE_BRIGHTROLL_DISPLAY",
"EXCHANGE_CADREON",
"EXCHANGE_DAILYMOTION",
"EXCHANGE_FIVE",
"EXCHANGE_FLUCT",
"EXCHANGE_FREEWHEEL",
"EXCHANGE_GENIEE",
"EXCHANGE_GUMGUM",
"EXCHANGE_IMOBILE",
"EXCHANGE_IBILLBOARD",
"EXCHANGE_IMPROVE_DIGITAL",
"EXCHANGE_INDEX",
"EXCHANGE_KARGO",
"EXCHANGE_MICROAD",
"EXCHANGE_MOPUB",
"EXCHANGE_NEND",
"EXCHANGE_ONE_BY_AOL_DISPLAY",
"EXCHANGE_ONE_BY_AOL_MOBILE",
"EXCHANGE_ONE_BY_AOL_VIDEO",
"EXCHANGE_OOYALA",
"EXCHANGE_OPENX",
"EXCHANGE_PERMODO",
"EXCHANGE_PLATFORMONE",
"EXCHANGE_PLATFORMID",
"EXCHANGE_PUBMATIC",
"EXCHANGE_PULSEPOINT",
"EXCHANGE_REVENUEMAX",
"EXCHANGE_RUBICON",
"EXCHANGE_SMARTCLIP",
"EXCHANGE_SMARTRTB",
"EXCHANGE_SMARTSTREAMTV",
"EXCHANGE_SOVRN",
"EXCHANGE_SPOTXCHANGE",
"EXCHANGE_STROER",
"EXCHANGE_TEADSTV",
"EXCHANGE_TELARIA",
"EXCHANGE_TVN",
"EXCHANGE_UNITED",
"EXCHANGE_YIELDLAB",
"EXCHANGE_YIELDMO",
"EXCHANGE_UNRULYX",
"EXCHANGE_OPEN8",
"EXCHANGE_TRITON",
"EXCHANGE_TRIPLELIFT",
"EXCHANGE_TABOOLA",
"EXCHANGE_INMOBI",
"EXCHANGE_SMAATO",
"EXCHANGE_AJA",
"EXCHANGE_NEXSTAR_DIGITAL",
"EXCHANGE_WAZE"
],
"enumDescriptions": [
"Exchange is not specified or is unknown in this version.",
"Google Ad Manager.",
"AppNexus.",
"BrightRoll Exchange for Video from Yahoo!.",
"Adform.",
"Admeta.",
"Admixer.",
"AdsMogo.",
"AdsWizz.",
"BidSwitch.",
"BrightRoll Exchange for Display from Yahoo!.",
"Cadreon.",
"Dailymotion.",
"Five.",
"Fluct.",
"FreeWheel SSP.",
"Geniee.",
"GumGum.",
"i-mobile.",
"iBILLBOARD.",
"Improve Digital.",
"Index Exchange.",
"Kargo.",
"MicroAd.",
"MoPub.",
"Nend.",
"ONE by AOL: Display Market Place.",
"ONE by AOL: Mobile.",
"ONE by AOL: Video.",
"Ooyala.",
"OpenX.",
"Permodo.",
"Platform One.",
"PlatformId.",
"PubMatic.",
"PulsePoint.",
"RevenueMax.",
"Rubicon.",
"SmartClip.",
"SmartRTB+.",
"SmartstreamTv.",
"Sovrn.",
"SpotXchange.",
"Ströer SSP.",
"TeadsTv.",
"Telaria.",
"TVN.",
"United.",
"Yieldlab.",
"Yieldmo.",
"UnrulyX",
"Open8",
"Triton.",
"TripleLift",
"Taboola",
"InMobi.",
"Smaato",
"Aja.",
"Nexstar Digital.",
"Waze."
],
"type": "string"
},
"inventorySourceId": {
"description": "Output only. The unique ID of the inventory source. Assigned by the system.",
"format": "int64",
"type": "string"
},
"inventorySourceType": {
"description": "Denotes the type of the inventory source.",
"enum": [
"INVENTORY_SOURCE_TYPE_UNSPECIFIED",
"INVENTORY_SOURCE_TYPE_PRIVATE",
"INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE"
],
"enumDescriptions": [
"The inventory source type is not specified or is unknown in this version.",
"Private inventory source.",
"Auction package."
],
"type": "string"
},
"name": {
"description": "Output only. The resource name of the inventory source.",
"type": "string"
},
"publisherName": {
"description": "The publisher/seller name of the inventory source.",
"type": "string"
},
"rateDetails": {
"$ref": "RateDetails",
"description": "Required. The rate details of the inventory source."
},
"status": {
"$ref": "InventorySourceStatus",
"description": "The status settings of the inventory source."
},
"timeRange": {
"$ref": "TimeRange",
"description": "The time range when this inventory source starts and stops serving."
},
"updateTime": {
"description": "Output only. The timestamp when the inventory source was last updated. Assigned by the\nsystem.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"InventorySourceAssignedTargetingOptionDetails": {
"description": "Targeting details for inventory source. This will be\npopulated in the details field of an AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_INVENTORY_SOURCE`.",
"id": "InventorySourceAssignedTargetingOptionDetails",
"properties": {
"inventorySourceId": {
"description": "Required. ID of the inventory source. Should refer to the\ninventory_source_id field of an\nInventorySource resource.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"InventorySourceDisplayCreativeConfig": {
"description": "The configuration for display creatives.",
"id": "InventorySourceDisplayCreativeConfig",
"properties": {
"creativeSize": {
"$ref": "Dimensions",
"description": "The size requirements for display creatives that can be assigned to the\ninventory source."
}
},
"type": "object"
},
"InventorySourceFilter": {
"description": "A filtering option for filtering on Inventory Source entities.",
"id": "InventorySourceFilter",
"properties": {
"inventorySourceIds": {
"description": "Inventory Sources to download by ID. All IDs must belong to the same\nAdvertiser or\nPartner specified in\nCreateSdfDownloadTaskRequest. Leave empty to download all Inventory\nSources for the selected Advertiser or Partner.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"InventorySourceGroup": {
"description": "A collection of targetable inventory sources.",
"id": "InventorySourceGroup",
"properties": {
"displayName": {
"description": "Required. The display name of the inventory source group.\n\nMust be UTF-8 encoded with a maximum size of 240 bytes.",
"type": "string"
},
"inventorySourceGroupId": {
"description": "Output only. The unique ID of the inventory source group. Assigned by the system.",
"format": "int64",
"type": "string"
},
"name": {
"description": "Output only. The resource name of the inventory source group.",
"type": "string"
}
},
"type": "object"
},
"InventorySourceGroupAssignedTargetingOptionDetails": {
"description": "Targeting details for inventory source group. This will be\npopulated in the details field of an AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.",
"id": "InventorySourceGroupAssignedTargetingOptionDetails",
"properties": {
"inventorySourceGroupId": {
"description": "Required. ID of the inventory source group. Should refer to the\ninventory_source_group_id\nfield of an InventorySourceGroup resource.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"InventorySourceStatus": {
"description": "The status related settings of the inventory source.",
"id": "InventorySourceStatus",
"properties": {
"configStatus": {
"description": "Output only. The configuration status of the inventory source.\n\nOnly applicable for guaranteed inventory sources.\nAcceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and\n`INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`.\n\nAn inventory source must be configured (fill in the required fields, choose\ncreatives, and select a default campaign) before it can serve.",
"enum": [
"INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED",
"INVENTORY_SOURCE_CONFIG_STATUS_PENDING",
"INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED"
],
"enumDescriptions": [
"The approval status is not specified or is unknown in this version.",
"The beginning state of a guaranteed inventory source. The inventory\nsource in this state needs to be configured.",
"The state after the buyer configures a guaranteed inventory source."
],
"type": "string"
},
"entityPauseReason": {
"description": "The user-provided reason for pausing this inventory source.\n\nMust not exceed 100 characters.\n\nOnly applicable when entity_status\nis set to `ENTITY_STATUS_PAUSED`.",
"type": "string"
},
"entityStatus": {
"description": "Whether or not the inventory source is servable.\n\nAcceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and\n`ENTITY_STATUS_PAUSED`.\nDefault value is `ENTITY_STATUS_ACTIVE`.",
"enum": [
"ENTITY_STATUS_UNSPECIFIED",
"ENTITY_STATUS_ACTIVE",
"ENTITY_STATUS_ARCHIVED",
"ENTITY_STATUS_DRAFT",
"ENTITY_STATUS_PAUSED",
"ENTITY_STATUS_SCHEDULED_FOR_DELETION"
],
"enumDescriptions": [
"Default value when status is not specified or is unknown in this version.",
"The entity is enabled to bid and spend budget.",
"The entity is archived. Bidding and budget spending are disabled. An\nentity can be deleted after archived. Deleted entities cannot be retrieved.",
"The entity is under draft. Bidding and budget spending are disabled.",
"Bidding and budget spending are paused for the entity.",
"The entity is scheduled for deletion."
],
"type": "string"
},
"sellerPauseReason": {
"description": "Output only. The seller-provided reason for pausing this inventory source.\n\nOnly applicable for inventory sources synced directly from the\npublishers and when seller_status\nis set to `ENTITY_STATUS_PAUSED`.",
"type": "string"
},
"sellerStatus": {
"description": "Output only. The status set by the seller for the inventory source.\n\nOnly applicable for inventory sources synced directly from the\npublishers.\nAcceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`.",
"enum": [
"ENTITY_STATUS_UNSPECIFIED",
"ENTITY_STATUS_ACTIVE",
"ENTITY_STATUS_ARCHIVED",
"ENTITY_STATUS_DRAFT",
"ENTITY_STATUS_PAUSED",
"ENTITY_STATUS_SCHEDULED_FOR_DELETION"
],
"enumDescriptions": [
"Default value when status is not specified or is unknown in this version.",
"The entity is enabled to bid and spend budget.",
"The entity is archived. Bidding and budget spending are disabled. An\nentity can be deleted after archived. Deleted entities cannot be retrieved.",
"The entity is under draft. Bidding and budget spending are disabled.",
"Bidding and budget spending are paused for the entity.",
"The entity is scheduled for deletion."
],
"type": "string"
}
},
"type": "object"
},
"InventorySourceVideoCreativeConfig": {
"description": "The configuration for video creatives.",
"id": "InventorySourceVideoCreativeConfig",
"properties": {
"duration": {
"description": "The duration requirements for the video creatives that can be assigned to\nthe inventory source.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"KeywordAssignedTargetingOptionDetails": {
"description": "Details for assigned keyword targeting option. This will be populated in the\ndetails field of an AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_KEYWORD`.",
"id": "KeywordAssignedTargetingOptionDetails",
"properties": {
"keyword": {
"description": "Required. The keyword, for example `car insurance`.\n\nPositive keyword cannot be offensive word.\nMust be UTF-8 encoded with a maximum size of 255 bytes. Maximum number\nof characters is 80. Maximum number of words is 10.",
"type": "string"
},
"negative": {
"description": "Indicates if this option is being negatively targeted.",
"type": "boolean"
}
},
"type": "object"
},
"LanguageAssignedTargetingOptionDetails": {
"description": "Details for assigned language targeting option. This will be populated in the\ndetails field of an AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_LANGUAGE`.",
"id": "LanguageAssignedTargetingOptionDetails",
"properties": {
"displayName": {
"description": "Output only. The display name of the language (e.g., \"French\").",
"type": "string"
},
"negative": {
"description": "Indicates if this option is being negatively targeted. All assigned\nlanguage targeting options on the same line item must have the same value\nfor this field.",
"type": "boolean"
},
"targetingOptionId": {
"description": "Required. The targeting_option_id of a\nTargetingOption of type `TARGETING_TYPE_LANGUAGE`.",
"type": "string"
}
},
"type": "object"
},
"LanguageTargetingOptionDetails": {
"description": "Represents a targetable language. This will be populated in the\nlanguage_details field when\ntargeting_type is\n`TARGETING_TYPE_LANGUAGE`.",
"id": "LanguageTargetingOptionDetails",
"properties": {
"displayName": {
"description": "Output only. The display name of the language (e.g., \"French\").",
"type": "string"
}
},
"type": "object"
},
"LineItem": {
"description": "A single line item.",
"id": "LineItem",
"properties": {
"advertiserId": {
"description": "Output only. The unique ID of the advertiser the line item belongs to.",
"format": "int64",
"type": "string"
},
"bidStrategy": {
"$ref": "BiddingStrategy",
"description": "Required. The bidding strategy of the line item."
},
"budget": {
"$ref": "LineItemBudget",
"description": "Required. The budget allocation setting of the line item."
},
"campaignId": {
"description": "Output only. The unique ID of the campaign that the line item belongs to.",
"format": "int64",
"type": "string"
},
"conversionCounting": {
"$ref": "ConversionCountingConfig",
"description": "The conversion tracking setting of the line item."
},
"creativeIds": {
"description": "The IDs of the creatives associated with the line item.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"displayName": {
"description": "Required. The display name of the line item.\n\nMust be UTF-8 encoded with a maximum size of 240 bytes.",
"type": "string"
},
"entityStatus": {
"description": "Required. Controls whether or not the line item can spend its budget and\nbid on inventory.\n\n* For CreateLineItem method, only\n`ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use\nUpdateLineItem method and update the\nstatus to `ENTITY_STATUS_ACTIVE` after creation.\n* A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from\nany other status.\n* If the line item's parent insertion order is not active, the line item\ncan't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.",
"enum": [
"ENTITY_STATUS_UNSPECIFIED",
"ENTITY_STATUS_ACTIVE",
"ENTITY_STATUS_ARCHIVED",
"ENTITY_STATUS_DRAFT",
"ENTITY_STATUS_PAUSED",
"ENTITY_STATUS_SCHEDULED_FOR_DELETION"
],
"enumDescriptions": [
"Default value when status is not specified or is unknown in this version.",
"The entity is enabled to bid and spend budget.",
"The entity is archived. Bidding and budget spending are disabled. An\nentity can be deleted after archived. Deleted entities cannot be retrieved.",
"The entity is under draft. Bidding and budget spending are disabled.",
"Bidding and budget spending are paused for the entity.",
"The entity is scheduled for deletion."
],
"type": "string"
},
"flight": {
"$ref": "LineItemFlight",
"description": "Required. The start and end time of the line item's flight."
},
"frequencyCap": {
"$ref": "FrequencyCap",
"description": "Required. The frequency capping setting of the line item."
},
"insertionOrderId": {
"description": "Required. Immutable. The unique ID of the insertion order that the line item belongs to.",
"format": "int64",
"type": "string"
},
"integrationDetails": {
"$ref": "IntegrationDetails",
"description": "Integration details of the line item."
},
"inventorySourceIds": {
"description": "The IDs of the private inventory sources assigned to the line item.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"lineItemId": {
"description": "Output only. The unique ID of the line item. Assigned by the system.",
"format": "int64",
"type": "string"
},
"lineItemType": {
"description": "Required. Immutable. The type of the line item.",
"enum": [
"LINE_ITEM_TYPE_UNSPECIFIED",
"LINE_ITEM_TYPE_DISPLAY_DEFAULT",
"LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL",
"LINE_ITEM_TYPE_VIDEO_DEFAULT",
"LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL",
"LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY",
"LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INVENTORY"
],
"enumDescriptions": [
"Type value is not specified or is unknown in this version.",
"Image, HTML5, native, or rich media ads.",
"Display ads that drive installs of an app.",
"Video ads sold on a CPM basis for a variety of environments.",
"Video ads that drive installs of an app.",
"Display ads served on mobile app inventory.",
"Video ads served on mobile app inventory."
],
"type": "string"
},
"name": {
"description": "Output only. The resource name of the line item.",
"type": "string"
},
"pacing": {
"$ref": "Pacing",
"description": "Required. The budget spending speed setting of the line item."
},
"partnerCosts": {
"description": "The partner costs associated with the line item.\n\nIf absent or empty in CreateLineItem\nmethod, the newly created line item will inherit partner costs from its\nparent insertion order.",
"items": {
"$ref": "PartnerCost"
},
"type": "array"
},
"partnerRevenueModel": {
"$ref": "PartnerRevenueModel",
"description": "Required. The partner revenue model setting of the line item."
},
"updateTime": {
"description": "Output only. The timestamp when the line item was last updated. Assigned by the system.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"LineItemBudget": {
"description": "Settings that control how budget is allocated.",
"id": "LineItemBudget",
"properties": {
"budgetAllocationType": {
"description": "Required. The type of the budget allocation.\n\n`LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when\nautomatic budget allocation is enabled for the parent insertion order.",
"enum": [
"LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED",
"LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC",
"LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED",
"LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED"
],
"enumDescriptions": [
"Type value is not specified or is unknown in this version.",
"Automatic budget allocation is enabled for the line item.",
"A fixed max budget amount is allocated for the line item.",
"No budget limit is applied to the line item."
],
"type": "string"
},
"budgetUnit": {
"description": "Output only. The budget unit specifies whether the budget is currency based\nor impression based. This value is inherited from the parent insertion\norder.",
"enum": [
"BUDGET_UNIT_UNSPECIFIED",
"BUDGET_UNIT_CURRENCY",
"BUDGET_UNIT_IMPRESSIONS"
],
"enumDescriptions": [
"Type value is not specified or is unknown in this version.",
"Budgeting in currency amounts.",
"Budgeting in impression amounts."
],
"type": "string"
},
"maxAmount": {
"description": "The maximum budget amount the line item will spend. Must be greater than 0.\n\nWhen budget_allocation_type is:\n\n* `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable\nand is set by the system.\n* `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if\nbudget_unit is:\n - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount\n to spend, in micros of the advertiser's currency. For example, 1500000\n represents 1.5 standard units of the currency.\n - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number\n of impressions to serve.\n* `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not\napplicable and will be ignored by the system.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"LineItemFlight": {
"description": "Settings that control the active duration of a line item.",
"id": "LineItemFlight",
"properties": {
"dateRange": {
"$ref": "DateRange",
"description": "The flight start and end dates of the line item. They are resolved\nrelative to the parent advertiser's time zone.\n\n* Required when\nflight_date_type is\n`LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise.\n* When creating a new flight, both `start_date` and `end_date` must be in\nthe future.\n* An existing flight with a `start_date` in the past has a mutable\n`end_date` but an immutable `start_date`.\n* `end_date` must be the `start_date` or later, both before the year 2037."
},
"flightDateType": {
"description": "Required. The type of the line item's flight dates.",
"enum": [
"LINE_ITEM_FLIGHT_DATE_TYPE_UNSPECIFIED",
"LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED",
"LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM"
],
"enumDescriptions": [
"Type value is not specified or is unknown in this version.",
"The line item's flight dates are inherited from its parent insertion order.",
"The line item uses its own custom flight dates."
],
"type": "string"
}
},
"type": "object"
},
"ListAdvertiserAssignedTargetingOptionsResponse": {
"description": "Response message for\nListAdvertiserAssignedTargetingOptions.",
"id": "ListAdvertiserAssignedTargetingOptionsResponse",
"properties": {
"assignedTargetingOptions": {
"description": "The list of assigned targeting options.\n\nThis list will be absent if empty.",
"items": {
"$ref": "AssignedTargetingOption"
},
"type": "array"
},
"nextPageToken": {
"description": "A token identifying the next page of results. This value should be\nspecified as the\npageToken in a\nsubsequent ListAdvertiserAssignedTargetingOptionsRequest to fetch the\nnext page of results. This token will be absent if there are no more\nassigned_targeting_options\nto return.",
"type": "string"
}
},
"type": "object"
},
"ListAdvertisersResponse": {
"id": "ListAdvertisersResponse",
"properties": {
"advertisers": {
"description": "The list of advertisers.\n\nThis list will be absent if empty.",
"items": {
"$ref": "Advertiser"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results.\nPass this value in the\npage_token\nfield in the subsequent call to `ListAdvertisers` method to retrieve the\nnext page of results.",
"type": "string"
}
},
"type": "object"
},
"ListAssignedInventorySourcesResponse": {
"description": "Response message for\nAssignedInventorySourceService.ListAssignedInventorySources.",
"id": "ListAssignedInventorySourcesResponse",
"properties": {
"assignedInventorySources": {
"description": "The list of assigned inventory sources.\n\nThis list will be absent if empty.",
"items": {
"$ref": "AssignedInventorySource"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results.\n\nPass this value in the\npage_token field\nin the subsequent call to `ListAssignedInventorySources` method to\nretrieve the next page of results.",
"type": "string"
}
},
"type": "object"
},
"ListAssignedLocationsResponse": {
"description": "Response message for\nAssignedLocationService.ListAssignedLocations.",
"id": "ListAssignedLocationsResponse",
"properties": {
"assignedLocations": {
"description": "The list of assigned locations.\n\nThis list will be absent if empty.",
"items": {
"$ref": "AssignedLocation"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results.\n\nPass this value in the\npage_token field\nin the subsequent call to `ListAssignedLocations` method to\nretrieve the next page of results.",
"type": "string"
}
},
"type": "object"
},
"ListCampaignsResponse": {
"id": "ListCampaignsResponse",
"properties": {
"campaigns": {
"description": "The list of campaigns.\n\nThis list will be absent if empty.",
"items": {
"$ref": "Campaign"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results.\nPass this value in the page_token field\nin the subsequent call to `ListCampaigns` method to retrieve the next page\nof results.",
"type": "string"
}
},
"type": "object"
},
"ListChannelsResponse": {
"id": "ListChannelsResponse",
"properties": {
"channels": {
"description": "The list of channels.\n\nThis list will be absent if empty.",
"items": {
"$ref": "Channel"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results.\nPass this value in the page_token field\nin the subsequent call to `ListChannels` method to retrieve the next page\nof results.",
"type": "string"
}
},
"type": "object"
},
"ListCombinedAudiencesResponse": {
"id": "ListCombinedAudiencesResponse",
"properties": {
"combinedAudiences": {
"description": "The list of combined audiences.\n\nThis list will be absent if empty.",
"items": {
"$ref": "CombinedAudience"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results.\nPass this value in the\npage_token\nfield in the subsequent call to `ListCombinedAudiences` method to retrieve\nthe next page of results.",
"type": "string"
}
},
"type": "object"
},
"ListCreativesResponse": {
"id": "ListCreativesResponse",
"properties": {
"creatives": {
"description": "The list of creatives.\n\nThis list will be absent if empty.",
"items": {
"$ref": "Creative"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results.\nPass this value in the page_token field\nin the subsequent call to `ListCreativesRequest` method to retrieve the\nnext page of results.\nIf this field is null, it means this is the last page.",
"type": "string"
}
},
"type": "object"
},
"ListCustomListsResponse": {
"id": "ListCustomListsResponse",
"properties": {
"customLists": {
"description": "The list of custom lists.\n\nThis list will be absent if empty.",
"items": {
"$ref": "CustomList"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results.\nPass this value in the\npage_token\nfield in the subsequent call to `ListCustomLists` method to retrieve the\nnext page of results.",
"type": "string"
}
},
"type": "object"
},
"ListFirstAndThirdPartyAudiencesResponse": {
"id": "ListFirstAndThirdPartyAudiencesResponse",
"properties": {
"firstAndThirdPartyAudiences": {
"description": "The list of first and third party audiences. Audience size properties will\nnot be included.\n\nThis list will be absent if empty.",
"items": {
"$ref": "FirstAndThirdPartyAudience"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results.\nPass this value in the\npage_token\nfield in the subsequent call to `ListFirstAndThirdPartyAudiences` method to\nretrieve the next page of results.",
"type": "string"
}
},
"type": "object"
},
"ListGoogleAudiencesResponse": {
"id": "ListGoogleAudiencesResponse",
"properties": {
"googleAudiences": {
"description": "The list of Google audiences.\n\nThis list will be absent if empty.",
"items": {
"$ref": "GoogleAudience"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results.\nPass this value in the\npage_token\nfield in the subsequent call to `ListGoogleAudiences` method to retrieve\nthe next page of results.",
"type": "string"
}
},
"type": "object"
},
"ListInsertionOrdersResponse": {
"id": "ListInsertionOrdersResponse",
"properties": {
"insertionOrders": {
"description": "The list of insertion orders.\n\nThis list will be absent if empty.",
"items": {
"$ref": "InsertionOrder"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results.\nPass this value in the page_token\nfield in the subsequent call to `ListInsertionOrders` method to retrieve\nthe next page of results.",
"type": "string"
}
},
"type": "object"
},
"ListInventorySourceGroupsResponse": {
"description": "Response message for InventorySourceGroupService.ListInventorySourceGroups.",
"id": "ListInventorySourceGroupsResponse",
"properties": {
"inventorySourceGroups": {
"description": "The list of inventory source groups.\n\nThis list will be absent if empty.",
"items": {
"$ref": "InventorySourceGroup"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results.\nPass this value in the\npage_token\nfield in the subsequent call to `ListInventorySourceGroups` method to\nretrieve the next page of results.",
"type": "string"
}
},
"type": "object"
},
"ListInventorySourcesResponse": {
"id": "ListInventorySourcesResponse",
"properties": {
"inventorySources": {
"description": "The list of inventory sources.\n\nThis list will be absent if empty.",
"items": {
"$ref": "InventorySource"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results.\nPass this value in the\npage_token\nfield in the subsequent call to `ListInventorySources` method to retrieve\nthe next page of results.",
"type": "string"
}
},
"type": "object"
},
"ListLineItemAssignedTargetingOptionsResponse": {
"description": "Response message for\nListLineItemAssignedTargetingOptions.",
"id": "ListLineItemAssignedTargetingOptionsResponse",
"properties": {
"assignedTargetingOptions": {
"description": "The list of assigned targeting options.\n\nThis list will be absent if empty.",
"items": {
"$ref": "AssignedTargetingOption"
},
"type": "array"
},
"nextPageToken": {
"description": "A token identifying the next page of results. This value should be\nspecified as the\npageToken in a\nsubsequent ListLineItemAssignedTargetingOptionsRequest to fetch the\nnext page of results. This token will be absent if there are no more\nassigned_targeting_options\nto return.",
"type": "string"
}
},
"type": "object"
},
"ListLineItemsResponse": {
"id": "ListLineItemsResponse",
"properties": {
"lineItems": {
"description": "The list of line items.\n\nThis list will be absent if empty.",
"items": {
"$ref": "LineItem"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results.\nPass this value in the\npage_token\nfield in the subsequent call to `ListLineItems` method to retrieve the\nnext page of results.",
"type": "string"
}
},
"type": "object"
},
"ListLocationListsResponse": {
"id": "ListLocationListsResponse",
"properties": {
"locationLists": {
"description": "The list of location lists.\n\nThis list will be absent if empty.",
"items": {
"$ref": "LocationList"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results.\n\nPass this value in the\npage_token\nfield in the subsequent call to `ListLocationLists` method to retrieve the\nnext page of results.",
"type": "string"
}
},
"type": "object"
},
"ListNegativeKeywordListsResponse": {
"description": "Response message for NegativeKeywordListService.ListNegativeKeywordLists.",
"id": "ListNegativeKeywordListsResponse",
"properties": {
"negativeKeywordLists": {
"description": "The list of negative keyword lists.\n\nThis list will be absent if empty.",
"items": {
"$ref": "NegativeKeywordList"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results.\n\nPass this value in the\npage_token\nfield in the subsequent call to `ListNegativeKeywordLists` method to\nretrieve the next page of results.",
"type": "string"
}
},
"type": "object"
},
"ListNegativeKeywordsResponse": {
"description": "Response message for NegativeKeywordService.ListNegativeKeywords.",
"id": "ListNegativeKeywordsResponse",
"properties": {
"negativeKeywords": {
"description": "The list of negative keywords.\n\nThis list will be absent if empty.",
"items": {
"$ref": "NegativeKeyword"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results.\n\nPass this value in the page_token\nfield in the subsequent call to `ListNegativeKeywords` method to retrieve\nthe next page of results.",
"type": "string"
}
},
"type": "object"
},
"ListSitesResponse": {
"description": "Response message for SiteService.ListSites.",
"id": "ListSitesResponse",
"properties": {
"nextPageToken": {
"description": "A token to retrieve the next page of results.\n\nPass this value in the page_token field\nin the subsequent call to `ListSites` method to retrieve the next page\nof results.",
"type": "string"
},
"sites": {
"description": "The list of sites.\n\nThis list will be absent if empty.",
"items": {
"$ref": "Site"
},
"type": "array"
}
},
"type": "object"
},
"ListTargetingOptionsResponse": {
"description": "Response message for\nListTargetingOptions.",
"id": "ListTargetingOptionsResponse",
"properties": {
"nextPageToken": {
"description": "A token to retrieve the next page of results.\nPass this value in the\npage_token\nfield in the subsequent call to `ListTargetingOptions` method to retrieve\nthe next page of results.",
"type": "string"
},
"targetingOptions": {
"description": "The list of targeting options.\n\nThis list will be absent if empty.",
"items": {
"$ref": "TargetingOption"
},
"type": "array"
}
},
"type": "object"
},
"LocationList": {
"description": "A list of locations used for targeting.",
"id": "LocationList",
"properties": {
"advertiserId": {
"description": "Required. Immutable. The unique ID of the advertiser the location list belongs to.",
"format": "int64",
"type": "string"
},
"displayName": {
"description": "Required. The display name of the location list.\nMust be UTF-8 encoded with a maximum size of 240 bytes.",
"type": "string"
},
"locationListId": {
"description": "Output only. The unique ID of the location list. Assigned by the system.",
"format": "int64",
"type": "string"
},
"locationType": {
"description": "Required. Immutable. The type of location. All locations in the list will share this type.",
"enum": [
"TARGETING_LOCATION_TYPE_UNSPECIFIED",
"TARGETING_LOCATION_TYPE_PROXIMITY",
"TARGETING_LOCATION_TYPE_REGIONAL"
],
"enumDescriptions": [
"Default value when type is not specified or is unknown.",
"The type for proximity geo location.",
"The type for regional geo location."
],
"type": "string"
},
"name": {
"description": "Output only. The resource name of the location list.",
"type": "string"
}
},
"type": "object"
},
"LookbackWindow": {
"description": "Specifies how many days into the past to look when determining whether to\nrecord a conversion.",
"id": "LookbackWindow",
"properties": {
"clickDays": {
"description": "Lookback window, in days, from the last time a given user clicked on one of\nyour ads.",
"format": "int32",
"type": "integer"
},
"impressionDays": {
"description": "Lookback window, in days, from the last time a given user viewed one of\nyour ads.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"MaximizeSpendBidStrategy": {
"description": "A strategy that automatically adjusts the bid to optimize a specified\nperformance goal while spending the full budget.",
"id": "MaximizeSpendBidStrategy",
"properties": {
"maxAverageCpmBidAmountMicros": {
"description": "The maximum average CPM that may be bid, in micros of the advertiser's\ncurrency. Must be greater than or equal to a billable unit of the given\ncurrency.\n\nFor example, 1500000 represents 1.5 standard units of the currency.",
"format": "int64",
"type": "string"
},
"performanceGoalType": {
"description": "Required. The type of the performance goal that the bidding strategy\ntries to minimize while spending the full budget.\n`BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for\nthis strategy.",
"enum": [
"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_UNSPECIFIED",
"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA",
"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC",
"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM",
"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA",
"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN",
"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED"
],
"enumDescriptions": [
"Type value is not specified or is unknown in this version.",
"Cost per action.",
"Cost per click.",
"Viewable CPM.",
"Completed inview and audible views.",
"Inview time over 10 secs views.",
"Viewable impressions."
],
"type": "string"
}
},
"type": "object"
},
"Money": {
"description": "Represents an amount of money with its currency type.",
"id": "Money",
"properties": {
"currencyCode": {
"description": "The 3-letter currency code defined in ISO 4217.",
"type": "string"
},
"nanos": {
"description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
"format": "int32",
"type": "integer"
},
"units": {
"description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"NegativeKeyword": {
"description": "A negatively targeted keyword that belongs to a negative keyword list.",
"id": "NegativeKeyword",
"properties": {
"keywordValue": {
"description": "Required. Immutable. The negatively targeted keyword, for example `car insurance`.\n\nMust be UTF-8 encoded with a maximum size of 255 bytes. Maximum number\nof characters is 80. Maximum number of words is 10.\n\nValid characters are restricted to ASCII characters only. The only\nURL-escaping permitted is for representing whitespace between words.\nLeading or trailing whitespace is ignored.",
"type": "string"
},
"name": {
"description": "Output only. The resource name of the negative keyword.",
"type": "string"
}
},
"type": "object"
},
"NegativeKeywordList": {
"description": "A list of negative keywords used for targeting.",
"id": "NegativeKeywordList",
"properties": {
"advertiserId": {
"description": "Output only. The unique ID of the advertiser the negative keyword list belongs to.",
"format": "int64",
"type": "string"
},
"displayName": {
"description": "Required. The display name of the negative keyword list.\nMust be UTF-8 encoded with a maximum size of 255 bytes.",
"type": "string"
},
"name": {
"description": "Output only. The resource name of the negative keyword list.",
"type": "string"
},
"negativeKeywordListId": {
"description": "Output only. The unique ID of the negative keyword list. Assigned by the system.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"NegativeKeywordListAssignedTargetingOptionDetails": {
"description": "Targeting details for negative keyword list. This will be populated in the\ndetails field of an AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`.",
"id": "NegativeKeywordListAssignedTargetingOptionDetails",
"properties": {
"negativeKeywordListId": {
"description": "Required. ID of the negative keyword list. Should refer to the\nnegative_keyword_list_id\nfield of a NegativeKeywordList resource.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"ObaIcon": {
"description": "OBA Icon for a Creative",
"id": "ObaIcon",
"properties": {
"clickTrackingUrl": {
"description": "Required. The click tracking URL of the OBA icon.\n\nOnly URLs of the following domains are allowed:\n\n* https://info.evidon.com\n* https://l.betrad.com",
"type": "string"
},
"dimensions": {
"$ref": "Dimensions",
"description": "The dimensions of the OBA icon."
},
"landingPageUrl": {
"description": "Required. The landing page URL of the OBA icon.\n\nOnly URLs of the following domains are allowed:\n\n* https://info.evidon.com\n* https://l.betrad.com",
"type": "string"
},
"position": {
"description": "The position of the OBA icon on the creative.",
"enum": [
"OBA_ICON_POSITION_UNSPECIFIED",
"OBA_ICON_POSITION_UPPER_RIGHT",
"OBA_ICON_POSITION_UPPER_LEFT",
"OBA_ICON_POSITION_LOWER_RIGHT",
"OBA_ICON_POSITION_LOWER_LEFT"
],
"enumDescriptions": [
"The OBA icon position is not specified.",
"At the upper right side of the creative.",
"At the upper left side of the creative.",
"At the lower right side of the creative.",
"At the lower left side of the creative."
],
"type": "string"
},
"program": {
"description": "The program of the OBA icon. For example: “AdChoices”.",
"type": "string"
},
"resourceMimeType": {
"description": "The MIME type of the OBA icon resource.",
"type": "string"
},
"resourceUrl": {
"description": "The URL of the OBA icon resource.",
"type": "string"
},
"viewTrackingUrl": {
"description": "Required. The view tracking URL of the OBA icon.\n\nOnly URLs of the following domains are allowed:\n\n* https://info.evidon.com\n* https://l.betrad.com",
"type": "string"
}
},
"type": "object"
},
"OnScreenPositionAssignedTargetingOptionDetails": {
"description": "On screen position targeting option details. This will be\npopulated in the\non_screen_position_details\nfield when\ntargeting_type is\n`TARGETING_TYPE_ON_SCREEN_POSITION`.",
"id": "OnScreenPositionAssignedTargetingOptionDetails",
"properties": {
"onScreenPosition": {
"description": "Output only. The on screen position.",
"enum": [
"ON_SCREEN_POSITION_UNSPECIFIED",
"ON_SCREEN_POSITION_UNKNOWN",
"ON_SCREEN_POSITION_ABOVE_THE_FOLD",
"ON_SCREEN_POSITION_BELOW_THE_FOLD"
],
"enumDescriptions": [
"On screen position is not specified in this version. This enum is a place\nholder for a default value and does not represent a real on screen\nposition.",
"The ad position is unknown on the screen.",
"The ad is located above the fold.",
"The ad is located below the fold."
],
"type": "string"
},
"targetingOptionId": {
"description": "Required. The targeting_option_id field when\ntargeting_type is\n`TARGETING_TYPE_ON_SCREEN_POSITION`.",
"type": "string"
}
},
"type": "object"
},
"OnScreenPositionTargetingOptionDetails": {
"description": "Represents a targetable on screen position, which could be used by display\nand video ads. This will be populated in the\non_screen_position_details\nfield when\ntargeting_type is\n`TARGETING_TYPE_ON_SCREEN_POSITION`.",
"id": "OnScreenPositionTargetingOptionDetails",
"properties": {
"onScreenPosition": {
"description": "Output only. The on screen position.",
"enum": [
"ON_SCREEN_POSITION_UNSPECIFIED",
"ON_SCREEN_POSITION_UNKNOWN",
"ON_SCREEN_POSITION_ABOVE_THE_FOLD",
"ON_SCREEN_POSITION_BELOW_THE_FOLD"
],
"enumDescriptions": [
"On screen position is not specified in this version. This enum is a place\nholder for a default value and does not represent a real on screen\nposition.",
"The ad position is unknown on the screen.",
"The ad is located above the fold.",
"The ad is located below the fold."
],
"type": "string"
}
},
"type": "object"
},
"OperatingSystemAssignedTargetingOptionDetails": {
"description": "Assigned operating system targeting option details. This will be\npopulated in the\noperating_system_details\nfield when\ntargeting_type is\n`TARGETING_TYPE_OPERATING_SYSTEM`.",
"id": "OperatingSystemAssignedTargetingOptionDetails",
"properties": {
"displayName": {
"description": "Output only. The display name of the operating system.",
"type": "string"
},
"negative": {
"description": "Indicates if this option is being negatively targeted.",
"type": "boolean"
},
"targetingOptionId": {
"description": "Required. The targeting option ID populated in\ntargeting_option_id field when\ntargeting_type is\n`TARGETING_TYPE_OPERATING_SYSTEM`.",
"type": "string"
}
},
"type": "object"
},
"OperatingSystemTargetingOptionDetails": {
"description": "Represents a targetable operating system. This will be populated in the\noperating_system_details field\nof a TargetingOption when\ntargeting_type is\n`TARGETING_TYPE_OPERATING_SYSTEM`.",
"id": "OperatingSystemTargetingOptionDetails",
"properties": {
"displayName": {
"description": "Output only. The display name of the operating system.",
"type": "string"
}
},
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"id": "Operation",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
"type": "boolean"
},
"error": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.",
"type": "string"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
"type": "object"
}
},
"type": "object"
},
"Pacing": {
"description": "Settings that control the rate at which a budget is spent.",
"id": "Pacing",
"properties": {
"dailyMaxImpressions": {
"description": "Maximum number of impressions to serve every day.\n\nApplicable when the budget is impression based. Must be greater than 0.",
"format": "int64",
"type": "string"
},
"dailyMaxMicros": {
"description": "Maximum currency amount to spend every day in micros of\nadvertiser's currency.\n\nApplicable when the budget is currency based. Must be greater than 0.\nFor example, for 1.5 standard unit of the currency, set this field to\n1500000.\n\nThe value assigned will be rounded to whole billable units for the\nrelevant currency by the following rules: any positive value less than a\nsingle billable unit will be rounded up to one billable unit and any\nvalue larger than a single billable unit will be rounded down to the\nnearest billable value. For example, if the currency's billable unit is\n0.01, and this field is set to 10257770, it will round down to 10250000,\na value of 10.25. If set to 505, it will round up to 10000, a value of\n0.01.",
"format": "int64",
"type": "string"
},
"pacingPeriod": {
"description": "Required. The time period in which the pacing budget will be spent.\n\nWhen automatic budget allocation is enabled at the insertion order via\nauto_budget_allocation, this\nfield is output only and defaults to `PACING_PERIOD_FLIGHT`.",
"enum": [
"PACING_PERIOD_UNSPECIFIED",
"PACING_PERIOD_DAILY",
"PACING_PERIOD_FLIGHT"
],
"enumDescriptions": [
"Period value is not specified or is unknown in this version.",
"The pacing setting will be applied on daily basis.",
"The pacing setting will be applied to the whole flight duration."
],
"type": "string"
},
"pacingType": {
"description": "Required. The type of pacing that defines how the budget amount will be\nspent across the pacing_period.",
"enum": [
"PACING_TYPE_UNSPECIFIED",
"PACING_TYPE_AHEAD",
"PACING_TYPE_ASAP",
"PACING_TYPE_EVEN"
],
"enumDescriptions": [
"Pacing mode value is not specified or is unknown in this version.",
"Only applicable to `PACING_PERIOD_FLIGHT` pacing period.\nAhead pacing attempts to spend faster than evenly, to make sure the\nentire budget is spent by the end of the flight.",
"Spend all of pacing budget amount as quick as possible.",
"Spend a consistent budget amount every period of time."
],
"type": "string"
}
},
"type": "object"
},
"ParentEntityFilter": {
"description": "A filtering option that filters on selected file types belonging to a chosen\nset of filter entities.",
"id": "ParentEntityFilter",
"properties": {
"fileType": {
"description": "Required. File types that will be returned.",
"enumDescriptions": [
"Default value when type is unspecified or is unknown in this version.",
"Campaign.",
"Media Product.",
"Insertion Order.",
"Line Item.",
"TrueView Ad Group.",
"TrueView Ad."
],
"items": {
"enum": [
"FILE_TYPE_UNSPECIFIED",
"FILE_TYPE_CAMPAIGN",
"FILE_TYPE_MEDIA_PRODUCT",
"FILE_TYPE_INSERTION_ORDER",
"FILE_TYPE_LINE_ITEM",
"FILE_TYPE_AD_GROUP",
"FILE_TYPE_AD"
],
"type": "string"
},
"type": "array"
},
"filterIds": {
"description": "The IDs of the specified filter type. This is used to filter entities to\nfetch. If filter type is not `FILTER_TYPE_NONE`, at least one ID must be\nspecified.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"filterType": {
"description": "Required. Filter type used to filter fetched entities.",
"enum": [
"FILTER_TYPE_UNSPECIFIED",
"FILTER_TYPE_NONE",
"FILTER_TYPE_ADVERTISER_ID",
"FILTER_TYPE_CAMPAIGN_ID",
"FILTER_TYPE_MEDIA_PRODUCT_ID",
"FILTER_TYPE_INSERTION_ORDER_ID",
"FILTER_TYPE_LINE_ITEM_ID"
],
"enumDescriptions": [
"Default value when type is unspecified or is unknown in this version.",
"If selected, no filter will be applied to the download. Can only be used if\nan Advertiser is specified\nin CreateSdfDownloadTaskRequest.",
"Advertiser ID. If selected, all filter IDs must be Advertiser IDs that\nbelong to the Partner specified\nin CreateSdfDownloadTaskRequest.",
"Campaign ID. If selected, all filter IDs must be Campaign IDs that belong\nto the Advertiser or\nPartner specified in\nCreateSdfDownloadTaskRequest.",
"Media Product ID. If selected, all filter IDs must be Media Product IDs\nthat belong to the Advertiser\nor Partner specified in\nCreateSdfDownloadTaskRequest. Can only be used for downloading\n`FILE_TYPE_MEDIA_PRODUCT`.",
"Insertion Order ID. If selected, all filter IDs must be Insertion Order IDs\nthat belong to the Advertiser\nor Partner specified in\nCreateSdfDownloadTaskRequest. Can only be used for downloading\n`FILE_TYPE_INSERTION_ORDER`, `FILE_TYPE_LINE_ITEM`, `FILE_TYPE_AD_GROUP`,\nand `FILE_TYPE_AD`.",
"Line Item ID. If selected, all filter IDs must be Line Item IDs that belong\nto the Advertiser or\nPartner specified in\nCreateSdfDownloadTaskRequest. Can only be used for downloading\n`FILE_TYPE_LINE_ITEM`, `FILE_TYPE_AD_GROUP`, and `FILE_TYPE_AD`."
],
"type": "string"
}
},
"type": "object"
},
"ParentalStatusAssignedTargetingOptionDetails": {
"description": "Details for assigned parental status targeting option. This will be\npopulated in the details field of an AssignedTargetingOption when\ntargeting_type is\n`TARTGETING_TYPE_PARENTAL_STATUS`.",
"id": "ParentalStatusAssignedTargetingOptionDetails",
"properties": {
"parentalStatus": {
"description": "Output only. The parental status of the audience.",
"enum": [
"PARENTAL_STATUS_UNSPECIFIED",
"PARENTAL_STATUS_PARENT",
"PARENTAL_STATUS_NOT_A_PARENT",
"PARENTAL_STATUS_UNKNOWN"
],
"enumDescriptions": [
"Default value when parental status is not specified in this version. This\nenum is a place holder for default value and does not represent a real\nparental status option.",
"The audience is a parent.",
"The audience is not a parent.",
"The parental status of the audience is unknown."
],
"type": "string"
},
"targetingOptionId": {
"description": "Required. The targeting_option_id of a\nTargetingOption of type `TARGETING_TYPE_PARENTAL_STATUS`.",
"type": "string"
}
},
"type": "object"
},
"ParentalStatusTargetingOptionDetails": {
"description": "Represents a targetable parental status. This will be populated in the\nparental_status_details field of a\nTargetingOption when targeting_type is\n`TARGETING_TYPE_PARENTAL_STATUS`.",
"id": "ParentalStatusTargetingOptionDetails",
"properties": {
"parentalStatus": {
"description": "Output only. The parental status of an audience.",
"enum": [
"PARENTAL_STATUS_UNSPECIFIED",
"PARENTAL_STATUS_PARENT",
"PARENTAL_STATUS_NOT_A_PARENT",
"PARENTAL_STATUS_UNKNOWN"
],
"enumDescriptions": [
"Default value when parental status is not specified in this version. This\nenum is a place holder for default value and does not represent a real\nparental status option.",
"The audience is a parent.",
"The audience is not a parent.",
"The parental status of the audience is unknown."
],
"type": "string"
}
},
"type": "object"
},
"PartnerCost": {
"description": "Settings that control a partner cost.\n\nA partner cost is any type of expense involved in running a campaign, other\nthan the costs of purchasing impressions (which is called the media cost)\nand using third-party audience segment data (data fee). Some examples of\npartner costs include the fees for using DV360, a third-party ad server,\nor a third-party ad serving verification service.",
"id": "PartnerCost",
"properties": {
"costType": {
"description": "Required. The type of the partner cost.",
"enum": [
"PARTNER_COST_TYPE_UNSPECIFIED",
"PARTNER_COST_TYPE_ADLOOX",
"PARTNER_COST_TYPE_ADLOOX_PREBID",
"PARTNER_COST_TYPE_ADSAFE",
"PARTNER_COST_TYPE_ADXPOSE",
"PARTNER_COST_TYPE_AGGREGATE_KNOWLEDGE",
"PARTNER_COST_TYPE_AGENCY_TRADING_DESK",
"PARTNER_COST_TYPE_DV360_FEE",
"PARTNER_COST_TYPE_COMSCORE_VCE",
"PARTNER_COST_TYPE_DATA_MANAGEMENT_PLATFORM",
"PARTNER_COST_TYPE_DEFAULT",
"PARTNER_COST_TYPE_DOUBLE_VERIFY",
"PARTNER_COST_TYPE_DOUBLE_VERIFY_PREBID",
"PARTNER_COST_TYPE_EVIDON",
"PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE_VIDEO",
"PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE_PREBID",
"PARTNER_COST_TYPE_MEDIA_COST_DATA",
"PARTNER_COST_TYPE_MOAT_VIDEO",
"PARTNER_COST_TYPE_NIELSEN_DAR",
"PARTNER_COST_TYPE_SHOP_LOCAL",
"PARTNER_COST_TYPE_TERACENT",
"PARTNER_COST_TYPE_THIRD_PARTY_AD_SERVER",
"PARTNER_COST_TYPE_TRUST_METRICS",
"PARTNER_COST_TYPE_VIZU",
"PARTNER_COST_TYPE_ADLINGO_FEE",
"PARTNER_COST_TYPE_CUSTOM_FEE_1",
"PARTNER_COST_TYPE_CUSTOM_FEE_2",
"PARTNER_COST_TYPE_CUSTOM_FEE_3",
"PARTNER_COST_TYPE_CUSTOM_FEE_4",
"PARTNER_COST_TYPE_CUSTOM_FEE_5"
],
"enumDescriptions": [
"Type value is not specified or is unknown in this version.",
"The cost is charged for using Adloox.",
"The cost is charged for using Adloox Pre-Bid.",
"The cost is charged for using AdSafe.",
"The cost is charged for using AdExpose.",
"The cost is charged for using Aggregate Knowledge.",
"The cost is charged for using an Agency Trading Desk.",
"The cost is charged for using DV360.",
"The cost is charged for using comScore vCE.",
"The cost is charged for using a Data Management Platform.",
"The default cost type.",
"The cost is charged for using DoubleVerify.",
"The cost is charged for using DoubleVerify Pre-Bid.",
"The cost is charged for using Evidon.",
"The cost is charged for using Integral Ad Science Video.",
"The cost is charged for using Integral Ad Science Pre-Bid.",
"The cost is charged for using media cost data.",
"The cost is charged for using MOAT Video.",
"The cost is charged for using Nielsen Digital Ad Ratings.",
"The cost is charged for using ShopLocal.",
"The cost is charged for using Teracent.",
"The cost is charged for using a third-party ad server.",
"The cost is charged for using TrustMetrics.",
"The cost is charged for using Vizu.",
"The cost is charged for using AdLingo.",
"The cost is charged as custom fee 1.",
"The cost is charged as custom fee 2.",
"The cost is charged as custom fee 3.",
"The cost is charged as custom fee 4.",
"The cost is charged as custom fee 5."
],
"type": "string"
},
"feeAmount": {
"description": "The CPM fee amount in micros of advertiser's currency.\n\nApplicable when the fee_type is\n`PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0.\n\nFor example, for 1.5 standard unit of the advertiser's currency, set\nthis field to 1500000.",
"format": "int64",
"type": "string"
},
"feePercentageMillis": {
"description": "The media fee percentage in millis (1/1000 of a percent).\n\nApplicable when the fee_type is\n`PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0.\n\nFor example: 100 represents 0.1%.",
"format": "int64",
"type": "string"
},
"feeType": {
"description": "Required. The fee type for this partner cost.",
"enum": [
"PARTNER_COST_FEE_TYPE_UNSPECIFIED",
"PARTNER_COST_FEE_TYPE_CPM_FEE",
"PARTNER_COST_FEE_TYPE_MEDIA_FEE"
],
"enumDescriptions": [
"Value is not specified or is unknown in this version.",
"The partner cost is a fixed CPM fee.\n\nNot applicable when the partner cost cost_type\nis one of:\n\n* `PARTNER_COST_TYPE_MEDIA_COST_DATA`\n* `PARTNER_COST_TYPE_DV360_FEE`.",
"The partner cost is a percentage surcharge based on the media cost.\n\nNot applicable when the partner cost_type is one\nof:\n\n* `PARTNER_COST_TYPE_SHOP_LOCAL`\n* `PARTNER_COST_TYPE_TRUST_METRICS`\n* `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE_VIDEO`\n* `PARTNER_COST_TYPE_MOAT_VIDEO`."
],
"type": "string"
},
"invoiceType": {
"description": "The invoice type for this partner cost.\n\n* Required when cost_type is one of:\n - `PARTNER_COST_TYPE_ADLOOX`\n - `PARTNER_COST_TYPE_DOUBLE_VERIFY`\n - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`.\n* Output only for other types.",
"enum": [
"PARTNER_COST_INVOICE_TYPE_UNSPECIFIED",
"PARTNER_COST_INVOICE_TYPE_DV360",
"PARTNER_COST_INVOICE_TYPE_PARTNER"
],
"enumDescriptions": [
"Type value is not specified or is unknown in this version.",
"Partner cost is billed through DV360.",
"Partner cost is billed by the partner."
],
"type": "string"
}
},
"type": "object"
},
"PartnerRevenueModel": {
"description": "Settings that control how partner revenue is calculated.",
"id": "PartnerRevenueModel",
"properties": {
"markupAmount": {
"description": "Required. The markup amount of the partner revenue model.\nMust be greater than or equal to 0.\n\n* When the markup_type is set to be\n`PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM\nmarkup in micros of advertiser's currency. For example, 1500000\nrepresents 1.5 standard units of the currency.\n* When the markup_type is set to be\n`PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field\nrepresents the media cost percent markup in millis. For example,\n100 represents 0.1% (decimal 0.001).\n* When the markup_type is set to be\n`PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field\nrepresents the total media cost percent markup in millis. For example,\n100 represents 0.1% (decimal 0.001).",
"format": "int64",
"type": "string"
},
"markupType": {
"description": "Required. The markup type of the partner revenue model.",
"enum": [
"PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED",
"PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM",
"PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP",
"PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP"
],
"enumDescriptions": [
"Type value is not specified or is unknown in this version.",
"Calculate the partner revenue based on a fixed CPM.",
"Calculate the partner revenue based on a percentage surcharge of its\nmedia cost.",
"Calculate the partner revenue based on a percentage surcharge of its\ntotal media cost, which includes all partner costs and data costs."
],
"type": "string"
}
},
"type": "object"
},
"PerformanceGoal": {
"description": "Settings that control the performance goal of a campaign or insertion order.",
"id": "PerformanceGoal",
"properties": {
"performanceGoalAmountMicros": {
"description": "The goal amount, in micros of the advertiser's currency.\n\nApplicable when\nperformance_goal_type is one of:\n\n* `PERFORMANCE_GOAL_TYPE_CPM`\n* `PERFORMANCE_GOAL_TYPE_CPC`\n* `PERFORMANCE_GOAL_TYPE_CPA`\n* `PERFORMANCE_GOAL_TYPE_CPIAVC`\n\nFor example 1500000 represents 1.5 standard units of the currency.",
"format": "int64",
"type": "string"
},
"performanceGoalPercentageMicros": {
"description": "The decimal representation of the goal percentage in micros.\n\nApplicable when\nperformance_goal_type is one of:\n\n* `PERFORMANCE_GOAL_TYPE_CTR`\n* `PERFORMANCE_GOAL_TYPE_VIEWABILITY`\n\nFor example, 70000 represents 7% (decimal 0.07).",
"format": "int64",
"type": "string"
},
"performanceGoalString": {
"description": "A key performance indicator (KPI) string, which can be empty.\nMust be UTF-8 encoded with a length of no more than 100 characters.\n\nApplicable when\nperformance_goal_type is set to\n`PERFORMANCE_GOAL_TYPE_OTHER`.",
"type": "string"
},
"performanceGoalType": {
"description": "Required. The type of the performance goal.",
"enum": [
"PERFORMANCE_GOAL_TYPE_UNSPECIFIED",
"PERFORMANCE_GOAL_TYPE_CPM",
"PERFORMANCE_GOAL_TYPE_CPC",
"PERFORMANCE_GOAL_TYPE_CPA",
"PERFORMANCE_GOAL_TYPE_VIEWABILITY",
"PERFORMANCE_GOAL_TYPE_CPIAVC",
"PERFORMANCE_GOAL_TYPE_CPE",
"PERFORMANCE_GOAL_TYPE_OTHER"
],
"enumDescriptions": [
"Performance goal type is not specified or is unknown in this version.",
"The performance goal is set in CPM (cost per mille).",
"The performance goal is set in CPC (cost per click).",
"The performance goal is set in CPA (cost per action).",
"The performance goal is set in Viewability percentage.",
"The performance goal is set as CPIAVC (cost per impression audible and\nvisible at completion).",
"The performance goal is set in CPE (cost per engagement).",
"The performance goal is set to Other."
],
"type": "string"
}
},
"type": "object"
},
"PerformanceGoalBidStrategy": {
"description": "A strategy that automatically adjusts the bid to meet or beat a specified\nperformance goal.",
"id": "PerformanceGoalBidStrategy",
"properties": {
"maxAverageCpmBidAmountMicros": {
"description": "The maximum average CPM that may be bid, in micros of the advertiser's\ncurrency. Must be greater than or equal to a billable unit of the given\ncurrency. Not applicable when\nperformance_goal_type\nis set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.\n\nFor example, 1500000 represents 1.5 standard units of the currency.",
"format": "int64",
"type": "string"
},
"performanceGoalAmountMicros": {
"description": "Required. The performance goal the bidding strategy will attempt to\nmeet or beat, in micros of the advertiser's currency.\nMust be greater than or equal to a billable unit of the given currency and\nsmaller or equal to upper bounds. Each\nperformance_goal_type\nhas its upper bound:\n\n* when\nperformance_goal_type\nis `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`,\nupper bound is 10000.00 USD.\n* when\nperformance_goal_type\nis `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`,\nupper bound is 1000.00 USD.\n* when\nperformance_goal_type\nis `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is\n1000.00 USD.\n\nExample: If set to\n`BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will\nbe based on the probability that each available impression will be\nviewable. For example, if viewable CPM target is $2 and an impression is\n40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2).\n\nFor example, 1500000 represents 1.5 standard units of the currency.",
"format": "int64",
"type": "string"
},
"performanceGoalType": {
"description": "Required. The type of the performance goal that the bidding strategy\nwill try to meet or beat.\n\nFor line item level usage, the value must be one of:\n\n* `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`\n* `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`\n* `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.",
"enum": [
"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_UNSPECIFIED",
"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA",
"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC",
"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM",
"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA",
"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN",
"BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED"
],
"enumDescriptions": [
"Type value is not specified or is unknown in this version.",
"Cost per action.",
"Cost per click.",
"Viewable CPM.",
"Completed inview and audible views.",
"Inview time over 10 secs views.",
"Viewable impressions."
],
"type": "string"
}
},
"type": "object"
},
"ProximityLocationListAssignedTargetingOptionDetails": {
"description": "Targeting details for proximity location list. This will be\npopulated in the details field of an AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.",
"id": "ProximityLocationListAssignedTargetingOptionDetails",
"properties": {
"proximityLocationListId": {
"description": "Required. ID of the proximity location list. Should refer to the\nlocation_list_id field of a\nLocationList resource whose type is\n`TARGETING_LOCATION_TYPE_PROXIMITY`.",
"format": "int64",
"type": "string"
},
"proximityRadiusRange": {
"description": "Required. Radius range for proximity location list.\nThis represents the size of the area around a chosen location that will be\ntargeted.\n\n`All` proximity location targeting under a single line item must have the\nsame radius range value. Set this value to match any existing targeting.\nIf updated, this field will change the radius range for all proximity\ntargeting under the line item.",
"enum": [
"PROXIMITY_RADIUS_RANGE_UNSPECIFIED",
"PROXIMITY_RADIUS_RANGE_SMALL",
"PROXIMITY_RADIUS_RANGE_MEDIUM",
"PROXIMITY_RADIUS_RANGE_LARGE"
],
"enumDescriptions": [
"The targeted radius range is not specified or is unknown.\nDefault value when radius range is not specified in this version.\nThis enum is a placeholder for default value and does not represent a real\nradius range option.",
"The targeted radius range is small.",
"The targeted radius range is medium.",
"The targeted radius range is large."
],
"type": "string"
}
},
"type": "object"
},
"PublisherReviewStatus": {
"description": "Publisher review status for the creative.",
"id": "PublisherReviewStatus",
"properties": {
"publisherName": {
"description": "The publisher reviewing the creative.",
"type": "string"
},
"status": {
"description": "Status of the publisher review.",
"enum": [
"REVIEW_STATUS_UNSPECIFIED",
"REVIEW_STATUS_APPROVED",
"REVIEW_STATUS_REJECTED",
"REVIEW_STATUS_PENDING"
],
"enumDescriptions": [
"Type value is not specified or is unknown in this version.",
"The creative is approved.",
"The creative is rejected.",
"The creative is pending review."
],
"type": "string"
}
},
"type": "object"
},
"RateDetails": {
"description": "The rate related settings of the inventory source.",
"id": "RateDetails",
"properties": {
"inventorySourceRateType": {
"description": "The rate type.\n\nAcceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`,\n`INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and\n`INVENTORY_SOURCE_RATE_TYPE_CPD`.",
"enum": [
"INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED",
"INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED",
"INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR",
"INVENTORY_SOURCE_RATE_TYPE_CPD",
"INVENTORY_SOURCE_RATE_TYPE_FLAT"
],
"enumDescriptions": [
"The rate type is not specified or is unknown in this version.",
"The rate type is CPM (Fixed).",
"The rate type is CPM (Floor).",
"The rate type is Cost per Day.",
"The rate type is Flat."
],
"type": "string"
},
"minimumSpend": {
"$ref": "Money",
"description": "Output only. The amount that the buyer has committed to spending on the inventory source\nup front.\n\nOnly applicable for guaranteed inventory sources."
},
"rate": {
"$ref": "Money",
"description": "The rate for the inventory source."
},
"unitsPurchased": {
"description": "Required for guaranteed inventory sources.\nThe number of impressions guaranteed by the seller.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"RegionalLocationListAssignedTargetingOptionDetails": {
"description": "Targeting details for regional location list. This will be\npopulated in the details field of an AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_REGIONAL_LOCATION_LIST`.",
"id": "RegionalLocationListAssignedTargetingOptionDetails",
"properties": {
"negative": {
"description": "Indicates if this option is being negatively targeted.",
"type": "boolean"
},
"regionalLocationListId": {
"description": "Required. ID of the regional location list. Should refer to the\nlocation_list_id field of a\nLocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"ReviewStatusInfo": {
"description": "Review statuses for the creative.",
"id": "ReviewStatusInfo",
"properties": {
"approvalStatus": {
"description": "Represents the basic approval needed for a creative to begin serving.\nSummary of\ncreative_and_landing_page_review_status\nand\ncontent_and_policy_review_status.",
"enum": [
"APPROVAL_STATUS_UNSPECIFIED",
"APPROVAL_STATUS_PENDING_NOT_SERVABLE",
"APPROVAL_STATUS_PENDING_SERVABLE",
"APPROVAL_STATUS_APPROVED_SERVABLE",
"APPROVAL_STATUS_REJECTED_NOT_SERVABLE"
],
"enumDescriptions": [
"Type value is not specified or is unknown in this version.",
"The creative is still under review and not servable.",
"The creative has passed creative \u0026 landing page\nreview and is servable, but is awaiting additional\ncontent \u0026 policy review.",
"Both creative \u0026 landing page review and\ncontent \u0026 policy review are approved. The creative is servable.",
"There is an issue with the creative that must be fixed before it can serve."
],
"type": "string"
},
"contentAndPolicyReviewStatus": {
"description": "Content and policy review status for the creative.",
"enum": [
"REVIEW_STATUS_UNSPECIFIED",
"REVIEW_STATUS_APPROVED",
"REVIEW_STATUS_REJECTED",
"REVIEW_STATUS_PENDING"
],
"enumDescriptions": [
"Type value is not specified or is unknown in this version.",
"The creative is approved.",
"The creative is rejected.",
"The creative is pending review."
],
"type": "string"
},
"creativeAndLandingPageReviewStatus": {
"description": "Creative and landing page review status for the creative.",
"enum": [
"REVIEW_STATUS_UNSPECIFIED",
"REVIEW_STATUS_APPROVED",
"REVIEW_STATUS_REJECTED",
"REVIEW_STATUS_PENDING"
],
"enumDescriptions": [
"Type value is not specified or is unknown in this version.",
"The creative is approved.",
"The creative is rejected.",
"The creative is pending review."
],
"type": "string"
},
"exchangeReviewStatuses": {
"description": "Exchange review statuses for the creative.",
"items": {
"$ref": "ExchangeReviewStatus"
},
"type": "array"
},
"publisherReviewStatuses": {
"description": "Publisher review statuses for the creative.",
"items": {
"$ref": "PublisherReviewStatus"
},
"type": "array"
}
},
"type": "object"
},
"SdfConfig": {
"description": "Structured Data File (SDF) related settings.",
"id": "SdfConfig",
"properties": {
"adminEmail": {
"description": "An administrator email address to which the SDF processing status reports\nwill be sent.",
"type": "string"
},
"version": {
"description": "Required. The version of SDF being used.",
"enum": [
"SDF_VERSION_UNSPECIFIED",
"SDF_VERSION_3_1",
"SDF_VERSION_4",
"SDF_VERSION_4_1",
"SDF_VERSION_4_2",
"SDF_VERSION_5",
"SDF_VERSION_5_1"
],
"enumDescriptions": [
"SDF version value is not specified or is unknown in this version.",
"SDF version 3.1",
"SDF version 4",
"SDF version 4.1",
"SDF version 4.2",
"SDF version 5.",
"SDF version 5.1"
],
"type": "string"
}
},
"type": "object"
},
"SdfDownloadTask": {
"description": "Type for the response returned\nby [SdfDownloadTaskService.CreateSdfDownloadTask].",
"id": "SdfDownloadTask",
"properties": {
"resourceName": {
"description": "A resource name to be used in\nmedia.download to Download the prepared\nfiles. Resource names have the format\n`download/sdfdownloadtasks/media/{media_id}`. `media_id` will be made\navailable by the long running operation service once the task status is\ndone.",
"type": "string"
}
},
"type": "object"
},
"SdfDownloadTaskMetadata": {
"description": "Type for the metadata returned\nby [SdfDownloadTaskService.CreateSdfDownloadTask].",
"id": "SdfDownloadTaskMetadata",
"properties": {
"createTime": {
"description": "The time when the operation was created.",
"format": "google-datetime",
"type": "string"
},
"endTime": {
"description": "The time when execution was completed.",
"format": "google-datetime",
"type": "string"
},
"version": {
"description": "The SDF version used to execute this download task.",
"enum": [
"SDF_VERSION_UNSPECIFIED",
"SDF_VERSION_3_1",
"SDF_VERSION_4",
"SDF_VERSION_4_1",
"SDF_VERSION_4_2",
"SDF_VERSION_5",
"SDF_VERSION_5_1"
],
"enumDescriptions": [
"SDF version value is not specified or is unknown in this version.",
"SDF version 3.1",
"SDF version 4",
"SDF version 4.1",
"SDF version 4.2",
"SDF version 5.",
"SDF version 5.1"
],
"type": "string"
}
},
"type": "object"
},
"SensitiveCategoryAssignedTargetingOptionDetails": {
"description": "Targeting details for sensitive category. This will be populated in the\ndetails field of an AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.",
"id": "SensitiveCategoryAssignedTargetingOptionDetails",
"properties": {
"excludedTargetingOptionId": {
"description": "Required. ID of the sensitive category to be EXCLUDED.",
"type": "string"
},
"sensitiveCategory": {
"description": "Output only. An enum for the DV360 Sensitive category content classifier.",
"enum": [
"SENSITIVE_CATEGORY_UNSPECIFIED",
"SENSITIVE_CATEGORY_ADULT",
"SENSITIVE_CATEGORY_DEROGATORY",
"SENSITIVE_CATEGORY_DOWNLOADS_SHARING",
"SENSITIVE_CATEGORY_WEAPONS",
"SENSITIVE_CATEGORY_GAMBLING",
"SENSITIVE_CATEGORY_VIOLENCE",
"SENSITIVE_CATEGORY_SUGGESTIVE",
"SENSITIVE_CATEGORY_PROFANITY",
"SENSITIVE_CATEGORY_ALCOHOL",
"SENSITIVE_CATEGORY_DRUGS",
"SENSITIVE_CATEGORY_TOBACCO",
"SENSITIVE_CATEGORY_POLITICS",
"SENSITIVE_CATEGORY_RELIGION",
"SENSITIVE_CATEGORY_TRAGEDY",
"SENSITIVE_CATEGORY_TRANSPORTATION_ACCIDENTS",
"SENSITIVE_CATEGORY_SENSITIVE_SOCIAL_ISSUES",
"SENSITIVE_CATEGORY_SHOCKING"
],
"enumDescriptions": [
"This enum is only a placeholder and doesn't specify a DV360 sensitive\ncategory.",
"Adult or pornographic text, image, or video content.",
"Content that may be construed as biased against individuals, groups, or\norganizations based on criteria such as race, religion, disability, sex,\nage, veteran status, sexual orientation, gender identity, or political\naffiliation. May also indicate discussion of such content, for instance,\nin an academic or journalistic context.",
"Content related to audio, video, or software downloads.",
"Contains content related to personal weapons, including knives, guns,\nsmall firearms, and ammunition. Selecting either \"weapons\" or\n\"sensitive social issues\" will result in selecting both.",
"Contains content related to betting or wagering in a real-world or\nonline setting.",
"Content which may be considered graphically violent, gory, gruesome, or\nshocking, such as street fighting videos, accident photos, descriptions\nof torture, etc.",
"Adult content, as well as suggestive content that's not explicitly\npornographic. This category includes all pages categorized as adult.",
"Prominent use of words considered indecent, such as curse words and\nsexual slang. Pages with only very occasional usage, such as news sites\nthat might include such words in a quotation, are not included.",
"Contains content related to alcoholic beverages, alcohol brands,\nrecipes, etc.",
"Contains content related to the recreational use of legal or illegal\ndrugs, as well as to drug paraphernalia or cultivation.",
"Contains content related to tobacco and tobacco accessories, including\nlighters, humidors, ashtrays, etc.",
"Political news and media, including discussions of social, governmental,\nand public policy.",
"Content related to religious thought or beliefs.",
"Content related to death, disasters, accidents, war, etc.",
"Content related to motor vehicle, aviation or other transportation\naccidents.",
"Issues that evoke strong, opposing views and spark debate. These include\nissues that are controversial in most countries and markets (such as\nabortion), as well as those that are controversial in specific countries\nand markets (such as immigration reform in the United States).",
"Content which may be considered shocking or disturbing, such as violent\nnews stories, stunts, or toilet humor."
],
"type": "string"
}
},
"type": "object"
},
"SensitiveCategoryTargetingOptionDetails": {
"description": "Represents a targetable sensitive category. This will be\npopulated in the\nsensitive_category_details\nfield of the TargetingOption when\ntargeting_type is\n`TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.",
"id": "SensitiveCategoryTargetingOptionDetails",
"properties": {
"sensitiveCategory": {
"description": "Output only. An enum for the DV360 Sensitive category content classifier.",
"enum": [
"SENSITIVE_CATEGORY_UNSPECIFIED",
"SENSITIVE_CATEGORY_ADULT",
"SENSITIVE_CATEGORY_DEROGATORY",
"SENSITIVE_CATEGORY_DOWNLOADS_SHARING",
"SENSITIVE_CATEGORY_WEAPONS",
"SENSITIVE_CATEGORY_GAMBLING",
"SENSITIVE_CATEGORY_VIOLENCE",
"SENSITIVE_CATEGORY_SUGGESTIVE",
"SENSITIVE_CATEGORY_PROFANITY",
"SENSITIVE_CATEGORY_ALCOHOL",
"SENSITIVE_CATEGORY_DRUGS",
"SENSITIVE_CATEGORY_TOBACCO",
"SENSITIVE_CATEGORY_POLITICS",
"SENSITIVE_CATEGORY_RELIGION",
"SENSITIVE_CATEGORY_TRAGEDY",
"SENSITIVE_CATEGORY_TRANSPORTATION_ACCIDENTS",
"SENSITIVE_CATEGORY_SENSITIVE_SOCIAL_ISSUES",
"SENSITIVE_CATEGORY_SHOCKING"
],
"enumDescriptions": [
"This enum is only a placeholder and doesn't specify a DV360 sensitive\ncategory.",
"Adult or pornographic text, image, or video content.",
"Content that may be construed as biased against individuals, groups, or\norganizations based on criteria such as race, religion, disability, sex,\nage, veteran status, sexual orientation, gender identity, or political\naffiliation. May also indicate discussion of such content, for instance,\nin an academic or journalistic context.",
"Content related to audio, video, or software downloads.",
"Contains content related to personal weapons, including knives, guns,\nsmall firearms, and ammunition. Selecting either \"weapons\" or\n\"sensitive social issues\" will result in selecting both.",
"Contains content related to betting or wagering in a real-world or\nonline setting.",
"Content which may be considered graphically violent, gory, gruesome, or\nshocking, such as street fighting videos, accident photos, descriptions\nof torture, etc.",
"Adult content, as well as suggestive content that's not explicitly\npornographic. This category includes all pages categorized as adult.",
"Prominent use of words considered indecent, such as curse words and\nsexual slang. Pages with only very occasional usage, such as news sites\nthat might include such words in a quotation, are not included.",
"Contains content related to alcoholic beverages, alcohol brands,\nrecipes, etc.",
"Contains content related to the recreational use of legal or illegal\ndrugs, as well as to drug paraphernalia or cultivation.",
"Contains content related to tobacco and tobacco accessories, including\nlighters, humidors, ashtrays, etc.",
"Political news and media, including discussions of social, governmental,\nand public policy.",
"Content related to religious thought or beliefs.",
"Content related to death, disasters, accidents, war, etc.",
"Content related to motor vehicle, aviation or other transportation\naccidents.",
"Issues that evoke strong, opposing views and spark debate. These include\nissues that are controversial in most countries and markets (such as\nabortion), as well as those that are controversial in specific countries\nand markets (such as immigration reform in the United States).",
"Content which may be considered shocking or disturbing, such as violent\nnews stories, stunts, or toilet humor."
],
"type": "string"
}
},
"type": "object"
},
"Site": {
"description": "A single site. Sites are apps or websites belonging to a channel.",
"id": "Site",
"properties": {
"name": {
"description": "Output only. The resource name of the site.",
"type": "string"
},
"urlOrAppId": {
"description": "Required. The URL or app ID of the site.\nMust be UTF-8 encoded with a maximum length of 240 bytes.",
"type": "string"
}
},
"type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).",
"id": "Status",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
},
"SubExchangeAssignedTargetingOptionDetails": {
"description": "Details for assigned sub-exchange targeting option. This will be populated in\nthe details field of an AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_SUB_EXCHANGE`.",
"id": "SubExchangeAssignedTargetingOptionDetails",
"properties": {
"targetingOptionId": {
"description": "Required. The targeting_option_id of a\nTargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.",
"type": "string"
}
},
"type": "object"
},
"SubExchangeTargetingOptionDetails": {
"description": "Represents a targetable sub-exchange. This will be populated in the\nsub_exchange_details field\nof a TargetingOption when\ntargeting_type is\n`TARGETING_TYPE_SUB_EXCHANGE`.",
"id": "SubExchangeTargetingOptionDetails",
"properties": {
"displayName": {
"description": "Output only. The display name of the sub-exchange.",
"type": "string"
}
},
"type": "object"
},
"TargetingOption": {
"description": "Represents a single targeting option, which is a targetable concept in\nDV360.",
"id": "TargetingOption",
"properties": {
"ageRangeDetails": {
"$ref": "AgeRangeTargetingOptionDetails",
"description": "Age range details."
},
"appCategoryDetails": {
"$ref": "AppCategoryTargetingOptionDetails",
"description": "App category details."
},
"authorizedSellerStatusDetails": {
"$ref": "AuthorizedSellerStatusTargetingOptionDetails",
"description": "Authorized seller status resource details."
},
"browserDetails": {
"$ref": "BrowserTargetingOptionDetails",
"description": "Browser details."
},
"carrierAndIspDetails": {
"$ref": "CarrierAndIspTargetingOptionDetails",
"description": "Carrier and ISP details."
},
"categoryDetails": {
"$ref": "CategoryTargetingOptionDetails",
"description": "Category resource details."
},
"contentInstreamPositionDetails": {
"$ref": "ContentInstreamPositionTargetingOptionDetails",
"description": "Content instream position details."
},
"contentOutstreamPositionDetails": {
"$ref": "ContentOutstreamPositionTargetingOptionDetails",
"description": "Content outstream position details."
},
"deviceMakeModelDetails": {
"$ref": "DeviceMakeModelTargetingOptionDetails",
"description": "Device make and model resource details."
},
"deviceTypeDetails": {
"$ref": "DeviceTypeTargetingOptionDetails",
"description": "Device type details."
},
"digitalContentLabelDetails": {
"$ref": "DigitalContentLabelTargetingOptionDetails",
"description": "Digital content label details."
},
"environmentDetails": {
"$ref": "EnvironmentTargetingOptionDetails",
"description": "Environment details."
},
"exchangeDetails": {
"$ref": "ExchangeTargetingOptionDetails",
"description": "Exchange details."
},
"genderDetails": {
"$ref": "GenderTargetingOptionDetails",
"description": "Gender details."
},
"geoRegionDetails": {
"$ref": "GeoRegionTargetingOptionDetails",
"description": "Geographic region resource details."
},
"householdIncomeDetails": {
"$ref": "HouseholdIncomeTargetingOptionDetails",
"description": "Household income details."
},
"languageDetails": {
"$ref": "LanguageTargetingOptionDetails",
"description": "Language resource details."
},
"name": {
"description": "Output only. The resource name for this targeting option.",
"type": "string"
},
"onScreenPositionDetails": {
"$ref": "OnScreenPositionTargetingOptionDetails",
"description": "On screen position details."
},
"operatingSystemDetails": {
"$ref": "OperatingSystemTargetingOptionDetails",
"description": "Operating system resources details."
},
"parentalStatusDetails": {
"$ref": "ParentalStatusTargetingOptionDetails",
"description": "Parental status details."
},
"sensitiveCategoryDetails": {
"$ref": "SensitiveCategoryTargetingOptionDetails",
"description": "Sensitive Category details."
},
"subExchangeDetails": {
"$ref": "SubExchangeTargetingOptionDetails",
"description": "Sub-exchange details."
},
"targetingOptionId": {
"description": "Output only. A unique identifier for this targeting option. The tuple\n{`targeting_type`, `targeting_option_id`} will be unique.",
"type": "string"
},
"targetingType": {
"description": "Output only. The type of this targeting option.",
"enum": [
"TARGETING_TYPE_UNSPECIFIED",
"TARGETING_TYPE_CHANNEL",
"TARGETING_TYPE_APP_CATEGORY",
"TARGETING_TYPE_APP",
"TARGETING_TYPE_URL",
"TARGETING_TYPE_DAY_AND_TIME",
"TARGETING_TYPE_AGE_RANGE",
"TARGETING_TYPE_REGIONAL_LOCATION_LIST",
"TARGETING_TYPE_PROXIMITY_LOCATION_LIST",
"TARGETING_TYPE_GENDER",
"TARGETING_TYPE_VIDEO_PLAYER_SIZE",
"TARGETING_TYPE_USER_REWARDED_CONTENT",
"TARGETING_TYPE_PARENTAL_STATUS",
"TARGETING_TYPE_CONTENT_INSTREAM_POSITION",
"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION",
"TARGETING_TYPE_DEVICE_TYPE",
"TARGETING_TYPE_AUDIENCE_GROUP",
"TARGETING_TYPE_BROWSER",
"TARGETING_TYPE_HOUSEHOLD_INCOME",
"TARGETING_TYPE_ON_SCREEN_POSITION",
"TARGETING_TYPE_THIRD_PARTY_VERIFIER",
"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION",
"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION",
"TARGETING_TYPE_ENVIRONMENT",
"TARGETING_TYPE_CARRIER_AND_ISP",
"TARGETING_TYPE_OPERATING_SYSTEM",
"TARGETING_TYPE_DEVICE_MAKE_MODEL",
"TARGETING_TYPE_KEYWORD",
"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST",
"TARGETING_TYPE_VIEWABILITY",
"TARGETING_TYPE_CATEGORY",
"TARGETING_TYPE_INVENTORY_SOURCE",
"TARGETING_TYPE_LANGUAGE",
"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS",
"TARGETING_TYPE_GEO_REGION",
"TARGETING_TYPE_INVENTORY_SOURCE_GROUP",
"TARGETING_TYPE_EXCHANGE",
"TARGETING_TYPE_SUB_EXCHANGE"
],
"enumDescriptions": [
"Default value when type is not specified or is unknown in this version.",
"Target a channel (a custom group of related websites or apps).",
"Target an app category (for example, education or puzzle games).",
"Target a specific app (for example, Angry Birds).",
"Target a specific url (for example, quora.com).",
"Target ads during a chosen time period on a specific day.",
"Target ads to a specific age range (for example, 18-24).",
"Target ads to the specified regions on a regional location list.",
"Target ads to the specified points of interest on a proximity location\nlist.",
"Target ads to a specific gender (for example, female or male).",
"Target a specific video player size for video ads.",
"Target user rewarded content for video ads.",
"Target ads to a specific parental status (for example, parent or not a\nparent).",
"Target video or audio ads in a specific content instream position (for\nexample, pre-roll, mid-roll, or post-roll).",
"Target ads in a specific content outstream position.",
"Target ads to a specific device type (for example, tablet or connected TV).",
"Target ads to an audience or groups of audiences.\nSingleton field, at most one can exist on a single Lineitem at a time.",
"Target ads to specific web browsers (for example, Chrome).",
"Target ads to a specific household income range (for example, top 10%).",
"Target ads in a specific on screen position.",
"Filter web sites through third party verification (for example, IAS or\nDoubleVerify).",
"Filter web sites by specific digital content label ratings (for example,\nDL-MA: suitable only for mature audiences).",
"Filter website content by sensitive categories (for example, adult).",
"Target ads to a specific environment (for example, web or app).",
"Target ads to a specific network carrier or internet service provider\n(ISP) (for example, Comcast or Orange).",
"Target ads to a specific operating system (for example, macOS).",
"Target ads to a specific device make or model (for example, Roku or\nSamsung).",
"Target ads to a specific keyword (for example, dog or retriever).",
"Target ads to a specific negative keyword list.",
"Target ads to a specific viewability (for example, 80% viewable).",
"Target ads to a specific content category (for example, arts \u0026\nentertainment).",
"Purchase impressions from specific deals and auction packages.",
"Target ads to a specific language (for example, English or Japanese).",
"Target ads to ads.txt authorized sellers.",
"Target ads to a specific regional location (for example, a city or state).",
"Purchase impressions from a group of deals and auction packages.",
"Purchase impressions from specific exchanges.",
"Purchase impressions from specific sub-exchanges."
],
"type": "string"
},
"userRewardedContentDetails": {
"$ref": "UserRewardedContentTargetingOptionDetails",
"description": "User rewarded content details."
},
"videoPlayerSizeDetails": {
"$ref": "VideoPlayerSizeTargetingOptionDetails",
"description": "Video player size details."
},
"viewabilityDetails": {
"$ref": "ViewabilityTargetingOptionDetails",
"description": "Viewability resource details."
}
},
"type": "object"
},
"ThirdPartyOnlyConfig": {
"description": "Settings for advertisers that use third-party ad servers only.",
"id": "ThirdPartyOnlyConfig",
"properties": {
"pixelOrderIdReportingEnabled": {
"description": "Whether or not order ID reporting for pixels is enabled.\nThis value cannot be changed once set to `true`.",
"type": "boolean"
}
},
"type": "object"
},
"ThirdPartyUrl": {
"description": "Tracking URLs from third parties to track interactions with an audio or a\nvideo creative.",
"id": "ThirdPartyUrl",
"properties": {
"type": {
"description": "The type of interaction needs to be tracked by the tracking URL",
"enum": [
"THIRD_PARTY_URL_TYPE_UNSPECIFIED",
"THIRD_PARTY_URL_TYPE_IMPRESSION",
"THIRD_PARTY_URL_TYPE_CLICK_TRACKING",
"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_START",
"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FIRST_QUARTILE",
"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MIDPOINT",
"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_THIRD_QUARTILE",
"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_COMPLETE",
"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MUTE",
"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PAUSE",
"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_REWIND",
"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FULLSCREEN",
"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_STOP",
"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_CUSTOM",
"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_SKIP",
"THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PROGRESS"
],
"enumDescriptions": [
"The type of third-party URL is unspecified or is unknown in this version.",
"Used to count impressions of the creative after the audio or video\nbuffering is complete.",
"Used to track user clicks on the audio or video.",
"Used to track the number of times a user starts the audio or video.",
"Used to track the number of times the audio or video plays to 25% of its\nlength.",
"Used to track the number of times the audio or video plays to 50% of its\nlength.",
"Used to track the number of times the audio or video plays to 75% of its\nlength.",
"Used to track the number of times the audio or video plays to the end.",
"Used to track the number of times a user mutes the audio or video.",
"Used to track the number of times a user pauses the audio or video.",
"Used to track the number of times a user replays the audio or video.",
"Used to track the number of times a user expands the player to\nfull-screen size.",
"Used to track the number of times a user stops the audio or video.",
"Used to track the number of times a user performs a custom click,\nsuch as clicking on a video hot spot.",
"Used to track the number of times the audio or video was skipped.",
"Used to track the number of times the audio or video plays to an offset\ndetermined by the progress_offset."
],
"type": "string"
},
"url": {
"description": "Tracking URL used to track the interaction.\n\nProvide a URL with optional path or query string, beginning with `https:`.\nFor example, https://www.example.com/path",
"type": "string"
}
},
"type": "object"
},
"ThirdPartyVerifierAssignedTargetingOptionDetails": {
"description": "Assigned third party verifier targeting option details. This will be\npopulated in the details field of an AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_THIRD_PARTY_VERIFIER`.",
"id": "ThirdPartyVerifierAssignedTargetingOptionDetails",
"properties": {
"adloox": {
"$ref": "Adloox",
"description": "Third party brand verifier -- Adloox."
},
"doubleVerify": {
"$ref": "DoubleVerify",
"description": "Third party brand verifier -- DoubleVerify."
},
"integralAdScience": {
"$ref": "IntegralAdScience",
"description": "Third party brand verifier -- Integral Ad Science."
}
},
"type": "object"
},
"TimeRange": {
"description": "A time range.",
"id": "TimeRange",
"properties": {
"endTime": {
"description": "Required. The upper bound of a time range, inclusive.",
"format": "google-datetime",
"type": "string"
},
"startTime": {
"description": "Required. The lower bound of a time range, inclusive.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"TimerEvent": {
"description": "Timer event of the creative.",
"id": "TimerEvent",
"properties": {
"name": {
"description": "Required. The name of the timer event.",
"type": "string"
},
"reportingName": {
"description": "Required. The name used to identify this timer event in reports.",
"type": "string"
}
},
"type": "object"
},
"TrackingFloodlightActivityConfig": {
"description": "Settings that control the behavior of a single Floodlight activity config.",
"id": "TrackingFloodlightActivityConfig",
"properties": {
"floodlightActivityId": {
"description": "Required. The ID of the Floodlight activity.",
"format": "int64",
"type": "string"
},
"postClickLookbackWindowDays": {
"description": "Required. The number of days after an ad has been clicked in which a\nconversion may be counted.\nMust be between 0 and 90 inclusive.",
"format": "int32",
"type": "integer"
},
"postViewLookbackWindowDays": {
"description": "Required. The number of days after an ad has been viewed in which a\nconversion may be counted.\nMust be between 0 and 90 inclusive.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"Transcode": {
"description": "Represents information about the transcoded audio or video file.",
"id": "Transcode",
"properties": {
"audioBitRateKbps": {
"description": "The bit rate for the audio stream of the transcoded video, or the bit rate\nfor the transcoded audio, in kilobits per second.",
"format": "int64",
"type": "string"
},
"audioSampleRateHz": {
"description": "The sample rate for the audio stream of the transcoded video, or the sample\nrate for the transcoded audio, in hertz.",
"format": "int64",
"type": "string"
},
"bitRateKbps": {
"description": "The transcoding bit rate of the transcoded video, in kilobits per second.",
"format": "int64",
"type": "string"
},
"dimensions": {
"$ref": "Dimensions",
"description": "The dimensions of the transcoded video."
},
"fileSizeBytes": {
"description": "The size of the transcoded file, in bytes.",
"format": "int64",
"type": "string"
},
"frameRate": {
"description": "The frame rate of the transcoded video, in frames per second.",
"format": "float",
"type": "number"
},
"mimeType": {
"description": "The MIME type of the transcoded file.",
"type": "string"
},
"name": {
"description": "The name of the transcoded file.",
"type": "string"
},
"transcoded": {
"description": "Indicates if the transcoding was successful.",
"type": "boolean"
}
},
"type": "object"
},
"UniversalAdId": {
"description": "A creative identifier provided by a registry that is unique across all\nplatforms. This is part of the VAST 4.0 standard.",
"id": "UniversalAdId",
"properties": {
"id": {
"description": "The unique creative identifier.",
"type": "string"
},
"registry": {
"description": "The registry provides unique creative identifiers.",
"enum": [
"UNIVERSAL_AD_REGISTRY_UNSPECIFIED",
"UNIVERSAL_AD_REGISTRY_OTHER",
"UNIVERSAL_AD_REGISTRY_AD_ID",
"UNIVERSAL_AD_REGISTRY_CLEARCAST",
"UNIVERSAL_AD_REGISTRY_DV360",
"UNIVERSAL_AD_REGISTRY_CM"
],
"enumDescriptions": [
"The Universal Ad registry is unspecified or is unknown in this version.",
"Use a custom provider to provide the Universal Ad ID.",
"Use Ad-ID to provide the Universal Ad ID.",
"Use clearcast.co.uk to provide the Universal Ad ID.",
"Use Display \u0026 Video 360 to provide the Universal Ad ID.",
"Use Campaign Manager to provide the Universal Ad ID."
],
"type": "string"
}
},
"type": "object"
},
"UrlAssignedTargetingOptionDetails": {
"description": "Details for assigned URL targeting option. This will be populated in the\ndetails field of an AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_URL`.",
"id": "UrlAssignedTargetingOptionDetails",
"properties": {
"negative": {
"description": "Indicates if this option is being negatively targeted.",
"type": "boolean"
},
"url": {
"description": "Required. The URL, for example `example.com`.\n\nDV360 supports two levels of subdirectory targeting, for example\n`www.example.com/one-subdirectory-level/second-level`, and five levels of\nsubdomain targeting, for example `five.four.three.two.one.example.com`.",
"type": "string"
}
},
"type": "object"
},
"UserRewardedContentAssignedTargetingOptionDetails": {
"description": "User rewarded content targeting option details. This will be populated in\nthe\nuser_rewarded_content_details\nfield when\ntargeting_type is\n`TARGETING_TYPE_USER_REWARDED_CONTENT`.",
"id": "UserRewardedContentAssignedTargetingOptionDetails",
"properties": {
"targetingOptionId": {
"description": "Required. The targeting_option_id field when\ntargeting_type is\n`TARGETING_TYPE_USER_REWARDED_CONTENT`.",
"type": "string"
},
"userRewardedContent": {
"description": "Output only. User rewarded content status for video ads.",
"enum": [
"USER_REWARDED_CONTENT_UNSPECIFIED",
"USER_REWARDED_CONTENT_USER_REWARDED",
"USER_REWARDED_CONTENT_NOT_USER_REWARDED"
],
"enumDescriptions": [
"User rewarded content is not specified or is unknown in this version.",
"Represents ads where the user will see a reward after viewing.",
"Represents all other ads besides user-rewarded."
],
"type": "string"
}
},
"type": "object"
},
"UserRewardedContentTargetingOptionDetails": {
"description": "Represents a targetable user rewarded content status for video ads only. This\nwill be populated in the\nuser_rewarded_content_details\nfield when\ntargeting_type is\n`TARGETING_TYPE_USER_REWARDED_CONTENT`.",
"id": "UserRewardedContentTargetingOptionDetails",
"properties": {
"userRewardedContent": {
"description": "Output only. User rewarded content status for video ads.",
"enum": [
"USER_REWARDED_CONTENT_UNSPECIFIED",
"USER_REWARDED_CONTENT_USER_REWARDED",
"USER_REWARDED_CONTENT_NOT_USER_REWARDED"
],
"enumDescriptions": [
"User rewarded content is not specified or is unknown in this version.",
"Represents ads where the user will see a reward after viewing.",
"Represents all other ads besides user-rewarded."
],
"type": "string"
}
},
"type": "object"
},
"VideoPlayerSizeAssignedTargetingOptionDetails": {
"description": "Video player size targeting option details. This will be populated in the\nvideo_player_size_details\nfield when targeting_type is\n`TARGETING_TYPE_VIDEO_PLAYER_SIZE`.\nExplicitly targeting all options is not supported. Remove all video player\nsize targeting options to achieve this effect.",
"id": "VideoPlayerSizeAssignedTargetingOptionDetails",
"properties": {
"targetingOptionId": {
"description": "Required. The targeting_option_id field when\ntargeting_type is\n`TARGETING_TYPE_VIDEO_PLAYER_SIZE`.",
"type": "string"
},
"videoPlayerSize": {
"description": "Output only. The video player size.",
"enum": [
"VIDEO_PLAYER_SIZE_UNSPECIFIED",
"VIDEO_PLAYER_SIZE_SMALL",
"VIDEO_PLAYER_SIZE_LARGE",
"VIDEO_PLAYER_SIZE_HD",
"VIDEO_PLAYER_SIZE_UNKNOWN"
],
"enumDescriptions": [
"Video player size is not specified in this version. This enum is a place\nholder for a default value and does not represent a real video player size.",
"The dimensions of the video player are less than 400×300 (desktop), or up\nto 20% of screen covered (mobile).",
"The dimensions of the video player are between 400x300 and 1280x720 pixels\n(desktop), or 20% to 90% of the screen covered (mobile).",
"The dimensions of the video player are 1280×720 or greater (desktop), or\nover 90% of the screen covered (mobile).",
"The dimensions of the video player are unknown."
],
"type": "string"
}
},
"type": "object"
},
"VideoPlayerSizeTargetingOptionDetails": {
"description": "Represents a targetable video player size. This will be populated in the\nvideo_player_size_details\nfield when targeting_type is\n`TARGETING_TYPE_VIDEO_PLAYER_SIZE`.",
"id": "VideoPlayerSizeTargetingOptionDetails",
"properties": {
"videoPlayerSize": {
"description": "Output only. The video player size.",
"enum": [
"VIDEO_PLAYER_SIZE_UNSPECIFIED",
"VIDEO_PLAYER_SIZE_SMALL",
"VIDEO_PLAYER_SIZE_LARGE",
"VIDEO_PLAYER_SIZE_HD",
"VIDEO_PLAYER_SIZE_UNKNOWN"
],
"enumDescriptions": [
"Video player size is not specified in this version. This enum is a place\nholder for a default value and does not represent a real video player size.",
"The dimensions of the video player are less than 400×300 (desktop), or up\nto 20% of screen covered (mobile).",
"The dimensions of the video player are between 400x300 and 1280x720 pixels\n(desktop), or 20% to 90% of the screen covered (mobile).",
"The dimensions of the video player are 1280×720 or greater (desktop), or\nover 90% of the screen covered (mobile).",
"The dimensions of the video player are unknown."
],
"type": "string"
}
},
"type": "object"
},
"ViewabilityAssignedTargetingOptionDetails": {
"description": "Assigned viewability targeting option details. This will be populated in the\nviewability_details field of\nan AssignedTargetingOption when\ntargeting_type is\n`TARGETING_TYPE_VIEWABILITY`.",
"id": "ViewabilityAssignedTargetingOptionDetails",
"properties": {
"targetingOptionId": {
"description": "Required. The targeting_option_id of a\nTargetingOption of type `TARGETING_TYPE_VIEWABILITY` (e.g., \"509010\"\nfor targeting the `VIEWABILITY_10_PERCENT_OR_MORE` option).",
"type": "string"
},
"viewability": {
"description": "Output only. The predicted viewability percentage.",
"enum": [
"VIEWABILITY_UNSPECIFIED",
"VIEWABILITY_10_PERCENT_OR_MORE",
"VIEWABILITY_20_PERCENT_OR_MORE",
"VIEWABILITY_30_PERCENT_OR_MORE",
"VIEWABILITY_40_PERCENT_OR_MORE",
"VIEWABILITY_50_PERCENT_OR_MORE",
"VIEWABILITY_60_PERCENT_OR_MORE",
"VIEWABILITY_70_PERCENT_OR_MORE",
"VIEWABILITY_80_PERCENT_OR_MORE",
"VIEWABILITY_90_PERCENT_OR_MORE"
],
"enumDescriptions": [
"Default value when viewability is not specified in this version. This enum\nis a placeholder for default value and does not represent a real\nviewability option.",
"Bid only on impressions that are at least 10% likely to be viewable.",
"Bid only on impressions that are at least 20% likely to be viewable.",
"Bid only on impressions that are at least 30% likely to be viewable.",
"Bid only on impressions that are at least 40% likely to be viewable.",
"Bid only on impressions that are at least 50% likely to be viewable.",
"Bid only on impressions that are at least 60% likely to be viewable.",
"Bid only on impressions that are at least 70% likely to be viewable.",
"Bid only on impressions that are at least 80% likely to be viewable.",
"Bid only on impressions that are at least 90% likely to be viewable."
],
"type": "string"
}
},
"type": "object"
},
"ViewabilityTargetingOptionDetails": {
"description": "Represents a targetable viewability. This will be populated in the\nviewability_details field of a\nTargetingOption when targeting_type is\n`TARGETING_TYPE_VIEWABILITY`.",
"id": "ViewabilityTargetingOptionDetails",
"properties": {
"viewability": {
"description": "Output only. The predicted viewability percentage.",
"enum": [
"VIEWABILITY_UNSPECIFIED",
"VIEWABILITY_10_PERCENT_OR_MORE",
"VIEWABILITY_20_PERCENT_OR_MORE",
"VIEWABILITY_30_PERCENT_OR_MORE",
"VIEWABILITY_40_PERCENT_OR_MORE",
"VIEWABILITY_50_PERCENT_OR_MORE",
"VIEWABILITY_60_PERCENT_OR_MORE",
"VIEWABILITY_70_PERCENT_OR_MORE",
"VIEWABILITY_80_PERCENT_OR_MORE",
"VIEWABILITY_90_PERCENT_OR_MORE"
],
"enumDescriptions": [
"Default value when viewability is not specified in this version. This enum\nis a placeholder for default value and does not represent a real\nviewability option.",
"Bid only on impressions that are at least 10% likely to be viewable.",
"Bid only on impressions that are at least 20% likely to be viewable.",
"Bid only on impressions that are at least 30% likely to be viewable.",
"Bid only on impressions that are at least 40% likely to be viewable.",
"Bid only on impressions that are at least 50% likely to be viewable.",
"Bid only on impressions that are at least 60% likely to be viewable.",
"Bid only on impressions that are at least 70% likely to be viewable.",
"Bid only on impressions that are at least 80% likely to be viewable.",
"Bid only on impressions that are at least 90% likely to be viewable."
],
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Display \u0026 Video 360 API",
"version": "v1",
"version_module": true
}