openapi: 3.1.0 info: title: Google Display & Video 360 API description: Display & Video 360 API allows users to automate complex Display & Video 360 workflows, such as creating insertion orders and setting targeting options for individual line items. Derived mechanically from the first-party Google API Discovery Document at https://displayvideo.googleapis.com/$discovery/rest?version=v4 (revision 20260813). version: v4 contact: name: Google url: https://developers.google.com/display-video/ license: name: Google APIs Terms of Service url: https://developers.google.com/terms termsOfService: https://developers.google.com/terms x-google-discovery-revision: '20260813' x-google-discovery-document: https://displayvideo.googleapis.com/$discovery/rest?version=v4 servers: - url: https://displayvideo.googleapis.com description: Display & Video 360 API server security: - oauth2: - https://www.googleapis.com/auth/display-video tags: - name: Users - name: Guaranteed Orders - name: Media - name: Custom Lists - name: First Party and Partner Audiences - name: Floodlight Groups - name: Targeting Types - name: SDF Download Tasks - name: Inventory Source Groups - name: Advertisers - name: Google Audiences - name: Partners - name: Inventory Sources - name: SDF Upload Tasks - name: Combined Audiences - name: Custom Bidding Algorithms paths: /v4/users: get: operationId: usersList summary: Lists users that are accessible to the current user. description: Lists users that are accessible to the current user. If two users have user roles on the same partner or advertiser, they can access each other. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method. tags: - Users parameters: - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.' - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListUsers` method. If not specified, the first page of results will be returned. - name: filter in: query schema: type: string description: 'Allows filtering by user fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `displayName` and `email` fields must use the `HAS (:)` operator. * The `lastLoginTime` field must use either the `LESS THAN OR EQUAL TO (<=)` or `GREATER THAN OR EQUAL TO (>=)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `assignedUserRole.advertiserId` * `assignedUserRole.entityType`: This is synthetic field of `AssignedUserRole` used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are `Partner` and `Advertiser`. * `assignedUserRole.parentPartnerId`: This is a synthetic field of `AssignedUserRole` used for filtering. Identifies the parent partner of the entity to which the user role is assigned. * `assignedUserRole.partnerId` * `assignedUserRole.userRole` * `displayName` * `email` * `lastLoginTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * The user with `displayName` containing "foo": `displayName:"foo"` * The user with `email` containing "bar": `email:"bar"` * All users with standard user roles: `assignedUserRole.userRole="STANDARD"` * All users with user roles for partner 123: `assignedUserRole.partnerId="123"` * All users with user roles for advertiser 123: `assignedUserRole.advertiserId="123"` * All users with partner level user roles: `entityType="PARTNER"` * All users with user roles for partner 123 and advertisers under partner 123: `parentPartnerId="123"` * All users that last logged in on or after 2023-01-01T00:00:00Z (format of ISO 8601): `lastLoginTime>="2023-01-01T00:00:00Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListUsersResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video-user-management x-google-method-id: displayvideo.users.list post: operationId: usersCreate summary: Creates a new user. description: Creates a new user. Returns the newly created user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method. tags: - Users requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/User' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/User' security: - oauth2: - https://www.googleapis.com/auth/display-video-user-management x-google-method-id: displayvideo.users.create /v4/users/{usersId}:bulkEditAssignedUserRoles: post: operationId: usersBulkEditAssignedUserRoles summary: Bulk edits user roles for a user. description: Bulk edits user roles for a user. The operation will delete the assigned user roles provided in BulkEditAssignedUserRolesRequest.deletedAssignedUserRoles and then assign the user roles provided in BulkEditAssignedUserRolesRequest.createdAssignedUserRoles. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method. tags: - Users parameters: - name: userId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the user to which the assigned user roles belong. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BulkEditAssignedUserRolesRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BulkEditAssignedUserRolesResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video-user-management x-google-method-id: displayvideo.users.bulkEditAssignedUserRoles /v4/users/{usersId}: patch: operationId: usersPatch summary: Updates an existing user. description: Updates an existing user. Returns the updated user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method. tags: - Users parameters: - name: userId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Output only. The unique ID of the user. Assigned by the system. required: true - name: updateMask in: query schema: type: string format: google-fieldmask description: Required. The mask to control which fields to update. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/User' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/User' security: - oauth2: - https://www.googleapis.com/auth/display-video-user-management x-google-method-id: displayvideo.users.patch get: operationId: usersGet summary: Gets a user. description: Gets a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method. tags: - Users parameters: - name: userId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the user to fetch. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/User' security: - oauth2: - https://www.googleapis.com/auth/display-video-user-management x-google-method-id: displayvideo.users.get delete: operationId: usersDelete summary: Deletes a user. description: Deletes a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method. tags: - Users parameters: - name: userId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the user to delete. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Empty' security: - oauth2: - https://www.googleapis.com/auth/display-video-user-management x-google-method-id: displayvideo.users.delete /v4/guaranteedOrders: post: operationId: guaranteedOrdersCreate summary: Creates a new guaranteed order. description: Creates a new guaranteed order. Returns the newly created guaranteed order if successful. tags: - Guaranteed Orders parameters: - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that the request is being made within. - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that the request is being made within. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GuaranteedOrder' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GuaranteedOrder' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.guaranteedOrders.create get: operationId: guaranteedOrdersList summary: Lists guaranteed orders that are accessible to the current user. description: Lists guaranteed orders that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, guaranteed orders with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results. tags: - Guaranteed Orders parameters: - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListGuaranteedOrders` method. If not specified, the first page of results will be returned. - name: filter in: query schema: type: string description: 'Allows filtering by guaranteed order fields. * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `guaranteed_order_id` * `exchange` * `display_name` * `status.entityStatus` Examples: * All active guaranteed orders: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Guaranteed orders belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that has access to the guaranteed order. - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that has access to the guaranteed order. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListGuaranteedOrdersResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.guaranteedOrders.list /v4/guaranteedOrders/{guaranteedOrdersId}:editGuaranteedOrderReadAccessors: post: operationId: guaranteedOrdersEditGuaranteedOrderReadAccessors summary: Edits read advertisers of a guaranteed order. description: Edits read advertisers of a guaranteed order. tags: - Guaranteed Orders parameters: - name: guaranteedOrderId in: path schema: type: string pattern: ^[^/]+$ description: Required. The ID of the guaranteed order to edit. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}` required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EditGuaranteedOrderReadAccessorsRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/EditGuaranteedOrderReadAccessorsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.guaranteedOrders.editGuaranteedOrderReadAccessors /v4/guaranteedOrders/{guaranteedOrdersId}: get: operationId: guaranteedOrdersGet summary: Gets a guaranteed order. description: Gets a guaranteed order. tags: - Guaranteed Orders parameters: - name: guaranteedOrderId in: path schema: type: string pattern: ^[^/]+$ description: Required. The ID of the guaranteed order to fetch. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}` required: true - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that has access to the guaranteed order. - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that has access to the guaranteed order. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GuaranteedOrder' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.guaranteedOrders.get patch: operationId: guaranteedOrdersPatch summary: Updates an existing guaranteed order. description: Updates an existing guaranteed order. Returns the updated guaranteed order if successful. tags: - Guaranteed Orders parameters: - name: guaranteedOrderId in: path schema: type: string pattern: ^[^/]+$ description: Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`. required: true - name: updateMask in: query schema: type: string format: google-fieldmask description: Required. The mask to control which fields to update. - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that the request is being made within. - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that the request is being made within. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GuaranteedOrder' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GuaranteedOrder' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.guaranteedOrders.patch /media/{mediaId}: post: operationId: mediaUpload summary: Uploads media. description: 'Uploads media. Upload is supported on the URI `/upload/media/{resource_name=**}?upload_type=media.` **Note**: Upload requests will not be successful without including `upload_type=media` query string.' tags: - Media parameters: - name: resourceName in: path schema: type: string pattern: ^.*$ description: Name of the media that is being downloaded. See ReadRequest.resource_name. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleBytestreamMedia' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleBytestreamMedia' security: - oauth2: - https://www.googleapis.com/auth/display-video - https://www.googleapis.com/auth/doubleclickbidmanager x-google-supports-media-upload: true x-google-method-id: displayvideo.media.upload /download/{downloadId}: get: operationId: mediaDownload summary: Downloads media. description: 'Downloads media. Download is supported on the URI `/download/{resource_name=**}?alt=media.` **Note**: Download requests will not be successful without including `alt=media` query string.' tags: - Media parameters: - name: resourceName in: path schema: type: string pattern: ^.*$ description: Name of the media that is being downloaded. See ReadRequest.resource_name. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleBytestreamMedia' security: - oauth2: - https://www.googleapis.com/auth/display-video - https://www.googleapis.com/auth/doubleclickbidmanager x-google-supports-media-download: true x-google-method-id: displayvideo.media.download /v4/customLists/{customListsId}: get: operationId: customListsGet summary: Gets a custom list. description: Gets a custom list. tags: - Custom Lists parameters: - name: customListId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the custom list to fetch. required: true - name: advertiserId in: query schema: type: string format: int64 description: The ID of the DV360 advertiser that has access to the fetched custom lists. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/CustomList' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.customLists.get /v4/customLists: get: operationId: customListsList summary: Lists custom lists. description: Lists custom lists. The order is defined by the order_by parameter. tags: - Custom Lists parameters: - name: filter in: query schema: type: string description: 'Allows filtering by custom list fields. Supported syntax: * Filter expressions for custom lists can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All custom lists for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomLists` method. If not specified, the first page of results will be returned. - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: advertiserId in: query schema: type: string format: int64 description: The ID of the DV360 advertiser that has access to the fetched custom lists. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `customListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListCustomListsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.customLists.list /v4/firstPartyAndPartnerAudiences/{firstPartyAndPartnerAudiencesId}:editCustomerMatchMembers: post: operationId: firstPartyAndPartnerAudiencesEditCustomerMatchMembers summary: Updates the member list of a Customer Match audience. description: 'Updates the member list of a Customer Match audience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`' tags: - First Party and Partner Audiences parameters: - name: firstPartyAndPartnerAudienceId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the Customer Match FirstPartyAndPartnerAudience whose members will be edited. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EditCustomerMatchMembersRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/EditCustomerMatchMembersResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.firstPartyAndPartnerAudiences.editCustomerMatchMembers /v4/firstPartyAndPartnerAudiences: get: operationId: firstPartyAndPartnerAudiencesList summary: Lists first party and partner audiences. description: Lists first party and partner audiences. The order is defined by the order_by parameter. tags: - First Party and Partner Audiences parameters: - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that has access to the fetched first party and partner audiences. - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that has access to the fetched first party and partner audiences. - name: orderBy in: query schema: type: string description: 'Optional. Field by which to sort the list. Acceptable values are: * `FirstPartyAndPartnerAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.' - name: pageSize in: query schema: type: integer format: int32 description: Optional. Requested page size. Must be between `1` and `5000`. If unspecified, this value defaults to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: pageToken in: query schema: type: string description: Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFirstPartyAndPartnerAudiences` method. If not specified, the first page of results will be returned. - name: filter in: query schema: type: string description: 'Optional. Allows filtering by first party and partner audience fields. Supported syntax: * Filter expressions for first party and partner audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All first party and partner audiences for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListFirstPartyAndPartnerAudiencesResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.firstPartyAndPartnerAudiences.list post: operationId: firstPartyAndPartnerAudiencesCreate summary: Creates a FirstPartyAndPartnerAudience. description: 'Creates a FirstPartyAndPartnerAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`' tags: - First Party and Partner Audiences parameters: - name: advertiserId in: query schema: type: string format: int64 description: Required. The ID of the advertiser under whom the FirstPartyAndPartnerAudience will be created. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/FirstPartyAndPartnerAudience' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/FirstPartyAndPartnerAudience' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.firstPartyAndPartnerAudiences.create /v4/firstPartyAndPartnerAudiences/{firstPartyAndPartnerAudiencesId}: patch: operationId: firstPartyAndPartnerAudiencesPatch summary: Updates an existing FirstPartyAndPartnerAudience. description: 'Updates an existing FirstPartyAndPartnerAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`' tags: - First Party and Partner Audiences parameters: - name: firstPartyAndPartnerAudienceId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Identifier. The unique ID of the first party and partner audience. Assigned by the system. required: true - name: updateMask in: query schema: type: string format: google-fieldmask description: 'Required. The mask to control which fields to update. Updates are only supported for the following fields: * `displayName` * `description` * `membershipDurationDays`' - name: advertiserId in: query schema: type: string format: int64 description: Required. The ID of the owner advertiser of the updated FirstPartyAndPartnerAudience. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/FirstPartyAndPartnerAudience' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/FirstPartyAndPartnerAudience' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.firstPartyAndPartnerAudiences.patch get: operationId: firstPartyAndPartnerAudiencesGet summary: Gets a first party or partner audience. description: Gets a first party or partner audience. tags: - First Party and Partner Audiences parameters: - name: firstPartyAndPartnerAudienceId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the first party and partner audience to fetch. required: true - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that has access to the fetched first party and partner audience. - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that has access to the fetched first party and partner audience. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/FirstPartyAndPartnerAudience' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.firstPartyAndPartnerAudiences.get /v4/floodlightGroups/{floodlightGroupId}: patch: operationId: floodlightGroupsPatch summary: Updates an existing Floodlight group. description: Updates an existing Floodlight group. Returns the updated Floodlight group if successful. tags: - Floodlight Groups parameters: - name: floodlightGroupId in: path schema: type: string format: int64 description: Output only. The unique ID of the Floodlight group. Assigned by the system. required: true - name: updateMask in: query schema: type: string format: google-fieldmask description: Required. The mask to control which fields to update. - name: partnerId in: query schema: type: string format: int64 description: Required. The partner context by which the Floodlight group is being accessed. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/FloodlightGroup' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/FloodlightGroup' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.floodlightGroups.patch /v4/floodlightGroups/{floodlightGroupsId}: get: operationId: floodlightGroupsGet summary: Gets a Floodlight group. description: Gets a Floodlight group. tags: - Floodlight Groups parameters: - name: floodlightGroupId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the Floodlight group to fetch. required: true - name: partnerId in: query schema: type: string format: int64 description: Required. The partner context by which the Floodlight group is being accessed. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/FloodlightGroup' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.floodlightGroups.get /v4/floodlightGroups/{floodlightGroupsId}/floodlightActivities/{floodlightActivitiesId}: get: operationId: floodlightGroupsFloodlightActivitiesGet summary: Gets a Floodlight activity. description: Gets a Floodlight activity. tags: - Floodlight Groups parameters: - name: floodlightGroupId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the parent Floodlight group to which the requested Floodlight activity belongs. required: true - name: floodlightActivityId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the Floodlight activity to fetch. required: true - name: partnerId in: query schema: type: string format: int64 description: Required. The ID of the partner through which the Floodlight activity is being accessed. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/FloodlightActivity' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.floodlightGroups.floodlightActivities.get /v4/floodlightGroups/{floodlightGroupsId}/floodlightActivities: get: operationId: floodlightGroupsFloodlightActivitiesList summary: Lists Floodlight activities in a Floodlight group. description: Lists Floodlight activities in a Floodlight group. tags: - Floodlight Groups parameters: - name: floodlightGroupId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the parent Floodlight group to which the requested Floodlight activities belong. required: true - name: pageToken in: query schema: type: string description: Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFloodlightActivities` method. If not specified, the first page of results will be returned. - name: pageSize in: query schema: type: integer format: int32 description: Optional. Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: orderBy in: query schema: type: string description: 'Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `floodlightActivityId` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.' - name: partnerId in: query schema: type: string format: int64 description: Required. The ID of the partner through which the Floodlight activities are being accessed. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListFloodlightActivitiesResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.floodlightGroups.floodlightActivities.list /v4/targetingTypes/{targetingTypesId}/targetingOptions:search: post: operationId: targetingTypesTargetingOptionsSearch summary: Searches for targeting options of a given type based on the given search terms. description: Searches for targeting options of a given type based on the given search terms. tags: - Targeting Types parameters: - name: targetingType in: path schema: type: string 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 - TARGETING_TYPE_POI - TARGETING_TYPE_BUSINESS_CHAIN - TARGETING_TYPE_CONTENT_DURATION - TARGETING_TYPE_CONTENT_STREAM_TYPE - TARGETING_TYPE_NATIVE_CONTENT_POSITION - TARGETING_TYPE_OMID - TARGETING_TYPE_AUDIO_CONTENT_TYPE - TARGETING_TYPE_CONTENT_GENRE - TARGETING_TYPE_YOUTUBE_VIDEO - TARGETING_TYPE_YOUTUBE_CHANNEL - TARGETING_TYPE_SESSION_POSITION - TARGETING_TYPE_CONTENT_THEME_EXCLUSION - TARGETING_TYPE_YOUTUBE_CHANNEL_PACK pattern: ^[^/]+$ description: 'Required. The type of targeting options to retrieve. Accepted values are: * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_BUSINESS_CHAIN` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack.' required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchTargetingOptionsRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/SearchTargetingOptionsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.targetingTypes.targetingOptions.search /v4/targetingTypes/{targetingTypesId}/targetingOptions/{targetingOptionsId}: get: operationId: targetingTypesTargetingOptionsGet summary: Gets a single targeting option. description: Gets a single targeting option. tags: - Targeting Types parameters: - name: targetingType in: path schema: type: string 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 - TARGETING_TYPE_POI - TARGETING_TYPE_BUSINESS_CHAIN - TARGETING_TYPE_CONTENT_DURATION - TARGETING_TYPE_CONTENT_STREAM_TYPE - TARGETING_TYPE_NATIVE_CONTENT_POSITION - TARGETING_TYPE_OMID - TARGETING_TYPE_AUDIO_CONTENT_TYPE - TARGETING_TYPE_CONTENT_GENRE - TARGETING_TYPE_YOUTUBE_VIDEO - TARGETING_TYPE_YOUTUBE_CHANNEL - TARGETING_TYPE_SESSION_POSITION - TARGETING_TYPE_CONTENT_THEME_EXCLUSION - TARGETING_TYPE_YOUTUBE_CHANNEL_PACK pattern: ^[^/]+$ description: 'Required. The type of targeting option to retrieve. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `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_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack.' required: true - name: targetingOptionId in: path schema: type: string pattern: ^[^/]+$ description: Required. The ID of the of targeting option to retrieve. required: true - name: advertiserId in: query schema: type: string format: int64 description: Required. The Advertiser this request is being made in the context of. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/TargetingOption' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.targetingTypes.targetingOptions.get /v4/targetingTypes/{targetingTypesId}/targetingOptions: get: operationId: targetingTypesTargetingOptionsList summary: Lists targeting options of a given type. description: Lists targeting options of a given type. tags: - Targeting Types parameters: - name: targetingType in: path schema: type: string 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 - TARGETING_TYPE_POI - TARGETING_TYPE_BUSINESS_CHAIN - TARGETING_TYPE_CONTENT_DURATION - TARGETING_TYPE_CONTENT_STREAM_TYPE - TARGETING_TYPE_NATIVE_CONTENT_POSITION - TARGETING_TYPE_OMID - TARGETING_TYPE_AUDIO_CONTENT_TYPE - TARGETING_TYPE_CONTENT_GENRE - TARGETING_TYPE_YOUTUBE_VIDEO - TARGETING_TYPE_YOUTUBE_CHANNEL - TARGETING_TYPE_SESSION_POSITION - TARGETING_TYPE_CONTENT_THEME_EXCLUSION - TARGETING_TYPE_YOUTUBE_CHANNEL_PACK pattern: ^[^/]+$ description: 'Required. The type of targeting option to be listed. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `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_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack.' required: true - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: filter in: query schema: type: string description: 'Allows filtering by targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `carrierAndIspDetails.type` * `geoRegionDetails.geoRegionType` * `targetingOptionId` Examples: * All `GEO REGION` targeting options that belong to sub type `GEO_REGION_TYPE_COUNTRY` or `GEO_REGION_TYPE_STATE`: `geoRegionDetails.geoRegionType="GEO_REGION_TYPE_COUNTRY" OR geoRegionDetails.geoRegionType="GEO_REGION_TYPE_STATE"` * All `CARRIER AND ISP` targeting options that belong to sub type `CARRIER_AND_ISP_TYPE_CARRIER`: `carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListTargetingOptions` method. If not specified, the first page of results will be returned. - name: advertiserId in: query schema: type: string format: int64 description: Required. The Advertiser this request is being made in the context of. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `targetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingOptionId desc`.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListTargetingOptionsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.targetingTypes.targetingOptions.list /v4/sdfdownloadtasks: post: operationId: sdfdownloadtasksCreate summary: Creates an SDF Download Task. description: Creates an SDF Download Task. Returns an Operation. An SDF Download Task is a long-running, asynchronous operation. The metadata type of this operation is SdfDownloadTaskMetadata. If the request is successful, the response type of the operation is SdfDownloadTask. The response will not include the download files, which must be retrieved with media.download. The state of operation can be retrieved with `sdfdownloadtasks.operations.get`. Any errors can be found in the error.message. Note that error.details is expected to be empty. tags: - SDF Download Tasks requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateSdfDownloadTaskRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Operation' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.sdfdownloadtasks.create /v4/sdfdownloadtasks/operations/{operationsId}: get: operationId: sdfdownloadtasksOperationsGet summary: Gets the latest state of an asynchronous SDF download task operation. description: Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds. tags: - SDF Download Tasks parameters: - name: name in: path schema: type: string pattern: ^sdfdownloadtasks/operations/[^/]+$ description: The name of the operation resource. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Operation' security: - oauth2: - https://www.googleapis.com/auth/display-video - https://www.googleapis.com/auth/doubleclickbidmanager x-google-method-id: displayvideo.sdfdownloadtasks.operations.get /v4/inventorySourceGroups/{inventorySourceGroupId}: patch: operationId: inventorySourceGroupsPatch summary: Updates an inventory source group. description: Updates an inventory source group. Returns the updated inventory source group if successful. tags: - Inventory Source Groups parameters: - name: inventorySourceGroupId in: path schema: type: string format: int64 description: Output only. The unique ID of the inventory source group. Assigned by the system. required: true - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that owns the inventory source group. Only this partner has write access to this group. - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group. - name: updateMask in: query schema: type: string format: google-fieldmask description: Required. The mask to control which fields to update. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/InventorySourceGroup' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/InventorySourceGroup' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.inventorySourceGroups.patch /v4/inventorySourceGroups: get: operationId: inventorySourceGroupsList summary: Lists inventory source groups that are accessible to the current user. description: Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter. tags: - Inventory Source Groups parameters: - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned. - name: filter in: query schema: type: string description: 'Allows filtering by inventory source group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `inventorySourceGroupId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups. - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `displayName` (default) * `inventorySourceGroupId` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListInventorySourceGroupsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.inventorySourceGroups.list post: operationId: inventorySourceGroupsCreate summary: Creates a new inventory source group. description: Creates a new inventory source group. Returns the newly created inventory source group if successful. tags: - Inventory Source Groups parameters: - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that owns the inventory source group. The parent partner will not have access to this group. - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that owns the inventory source group. Only this partner will have write access to this group. Only advertisers to which this group is explicitly shared will have read access to this group. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/InventorySourceGroup' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/InventorySourceGroup' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.inventorySourceGroups.create /v4/inventorySourceGroups/{inventorySourceGroupsId}: get: operationId: inventorySourceGroupsGet summary: Gets an inventory source group. description: Gets an inventory source group. tags: - Inventory Source Groups parameters: - name: inventorySourceGroupId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the inventory source group to fetch. required: true - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group. - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/InventorySourceGroup' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.inventorySourceGroups.get delete: operationId: inventorySourceGroupsDelete summary: Deletes an inventory source group. description: Deletes an inventory source group. tags: - Inventory Source Groups parameters: - name: inventorySourceGroupId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the inventory source group to delete. required: true - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group. - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that owns the inventory source group. Only this partner has write access to this group. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Empty' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.inventorySourceGroups.delete /v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources: post: operationId: inventorySourceGroupsAssignedInventorySourcesCreate summary: Creates an assignment between an inventory source and an inventory source group. description: Creates an assignment between an inventory source and an inventory source group. tags: - Inventory Source Groups parameters: - name: inventorySourceGroupId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the inventory source group to which the assignment will be assigned. required: true - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that owns the parent inventory source group. The parent partner will not have access to this assigned inventory source. - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that owns the parent inventory source group. Only this partner will have write access to this assigned inventory source. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AssignedInventorySource' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/AssignedInventorySource' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.inventorySourceGroups.assignedInventorySources.create get: operationId: inventorySourceGroupsAssignedInventorySourcesList summary: Lists inventory sources assigned to an inventory source group. description: Lists inventory sources assigned to an inventory source group. tags: - Inventory Source Groups parameters: - name: inventorySourceGroupId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the inventory source group to which these assignments are assigned. required: true - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that has access to the assignment. If the parent inventory source group is partner-owned, only advertisers to which the parent group is explicitly shared can access the assigned inventory source. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `assignedInventorySourceId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `assignedInventorySourceId desc`.' - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that has access to the assignment. If the parent inventory source group is advertiser-owned, the assignment cannot be accessed via a partner. - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: filter in: query schema: type: string description: 'Allows filtering by assigned inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedInventorySourceId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAssignedInventorySources` method. If not specified, the first page of results will be returned. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListAssignedInventorySourcesResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.inventorySourceGroups.assignedInventorySources.list /v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources/{assignedInventorySourcesId}: delete: operationId: inventorySourceGroupsAssignedInventorySourcesDelete summary: Deletes the assignment between an inventory source and an inventory source group. description: Deletes the assignment between an inventory source and an inventory source group. tags: - Inventory Source Groups parameters: - name: inventorySourceGroupId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the inventory source group to which this assignment is assigned. required: true - name: assignedInventorySourceId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the assigned inventory source to delete. required: true - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that owns the parent inventory source group. Only this partner has write access to this assigned inventory source. - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to this assigned inventory source. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Empty' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.inventorySourceGroups.assignedInventorySources.delete /v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources:bulkEdit: post: operationId: inventorySourceGroupsAssignedInventorySourcesBulkEdit summary: Bulk edits multiple assignments between inventory sources and a single inventory source group. description: Bulk edits multiple assignments between inventory sources and a single inventory source group. The operation will delete the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.deleted_assigned_inventory_sources and then create the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.created_assigned_inventory_sources. tags: - Inventory Source Groups parameters: - name: inventorySourceGroupId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the inventory source group to which the assignments are assigned. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BulkEditAssignedInventorySourcesRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BulkEditAssignedInventorySourcesResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.inventorySourceGroups.assignedInventorySources.bulkEdit /v4/advertisers/{advertisersId}: get: operationId: advertisersGet summary: Gets an advertiser. description: Gets an advertiser. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser to fetch. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Advertiser' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.get delete: operationId: advertisersDelete summary: Deletes an advertiser. description: Deletes an advertiser. Deleting an advertiser will delete all of its child resources, for example, campaigns, insertion orders and line items. A deleted advertiser cannot be recovered. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of the advertiser we need to delete. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Empty' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.delete patch: operationId: advertisersPatch summary: Updates an existing advertiser. description: Updates an existing advertiser. Returns the updated advertiser if successful. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Output only. The unique ID of the advertiser. Assigned by the system. required: true - name: updateMask in: query schema: type: string format: google-fieldmask description: Required. The mask to control which fields to update. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Advertiser' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Advertiser' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.patch /v4/advertisers/{advertisersId}:audit: get: operationId: advertisersAudit summary: Audits an advertiser. description: Audits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their respective resource limit. See https://support.google.com/displayvideo/answer/6071450. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser to audit. required: true - name: readMask in: query schema: type: string format: google-fieldmask description: 'Optional. The specific fields to return. If no mask is specified, all fields in the response proto will be filled. Valid values are: * usedLineItemsCount * usedInsertionOrdersCount * usedCampaignsCount * channelsCount * negativelyTargetedChannelsCount * negativeKeywordListsCount * adGroupCriteriaCount * campaignCriteriaCount' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/AuditAdvertiserResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.audit /v4/advertisers: post: operationId: advertisersCreate summary: Creates a new advertiser. description: Creates a new advertiser. Returns the newly created advertiser if successful. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors. tags: - Advertisers requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Advertiser' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Advertiser' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.create get: operationId: advertisersList summary: Lists advertisers that are accessible to the current user. description: Lists advertisers that are accessible to the current user. The order is defined by the order_by parameter. A single partner_id is required. Cross-partner listing is not supported. tags: - Advertisers parameters: - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertisers` method. If not specified, the first page of results will be returned. - name: filter in: query schema: type: string description: 'Allows filtering by advertiser fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `advertiserId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All active advertisers under a partner: `entityStatus="ENTITY_STATUS_ACTIVE"` * All advertisers with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All advertisers with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. - name: partnerId in: query schema: type: string format: int64 description: Required. The ID of the partner that the fetched advertisers should all belong to. The system only supports listing advertisers for one partner at a time. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `advertiserId` (default) * `displayName` * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListAdvertisersResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.list /v4/advertisers/{advertisersId}:editAssignedTargetingOptions: post: operationId: advertisersEditAssignedTargetingOptions summary: Edits targeting options under a single advertiser. description: Edits targeting options under a single advertiser. The operation will delete the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.create_requests . tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BulkEditAdvertiserAssignedTargetingOptionsRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BulkEditAdvertiserAssignedTargetingOptionsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.editAssignedTargetingOptions /v4/advertisers/{advertisersId}:listAssignedTargetingOptions: get: operationId: advertisersListAssignedTargetingOptions summary: Lists assigned targeting options of an advertiser across targeting types. description: Lists assigned targeting options of an advertiser across targeting types. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser the line item belongs to. required: true - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: filter in: query schema: type: string description: 'Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=) operator`. Supported fields: * `targetingType` Examples: * targetingType with value TARGETING_TYPE_CHANNEL `targetingType="TARGETING_TYPE_CHANNEL"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: pageToken in: query schema: type: string description: A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BulkListAdvertiserAssignedTargetingOptionsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.listAssignedTargetingOptions /v4/advertisers/{advertisersId}/assets: post: operationId: advertisersAssetsUpload summary: Uploads an asset. description: Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the [multipart media upload process](/display-video/api/guides/how-tos/upload#multipart). Examples using provided client libraries can be found in our [Creating Creatives guide](/display-video/api/guides/creating-creatives/overview#upload_an_asset). tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser this asset belongs to. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAssetRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/CreateAssetResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-supports-media-upload: true x-google-method-id: displayvideo.advertisers.assets.upload /v4/advertisers/{advertisersId}/adGroups: post: operationId: advertisersAdGroupsCreate summary: Creates a new ad group. description: Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Output only. The unique ID of the advertiser the ad group belongs to. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AdGroup' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/AdGroup' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.adGroups.create get: operationId: advertisersAdGroupsList summary: Lists ad groups. description: Lists ad groups. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser the ad groups belongs to. required: true - name: orderBy in: query schema: type: string description: 'Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.' - name: pageSize in: query schema: type: integer format: int32 description: Optional. Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: pageToken in: query schema: type: string description: Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroups` method. If not specified, the first page of results will be returned. - name: filter in: query schema: type: string description: 'Optional. Allows filtering by custom ad group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported properties: * `adGroupId` * `displayName` * `entityStatus` * `lineItemId` * `adGroupFormat` Examples: * All ad groups under an line item: `lineItemId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` `AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListAdGroupsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.adGroups.list /v4/advertisers/{advertisersId}/adGroups:bulkEditAssignedTargetingOptions: post: operationId: advertisersAdGroupsBulkEditAssignedTargetingOptions summary: Bulk edits targeting options for multiple ad groups. description: Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. This method is only supported for Demand Gen ad groups. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser the ad groups belong to. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BulkEditAdGroupAssignedTargetingOptionsRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BulkEditAdGroupAssignedTargetingOptionsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.adGroups.bulkEditAssignedTargetingOptions /v4/advertisers/{advertisersId}/adGroups/{adGroupsId}: get: operationId: advertisersAdGroupsGet summary: Gets an ad group. description: Gets an ad group. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser this ad group belongs to. required: true - name: adGroupId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the ad group to fetch. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/AdGroup' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.adGroups.get delete: operationId: advertisersAdGroupsDelete summary: Deletes a AdGroup. description: Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist. This method is only supported for Demand Gen ad groups. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser this ad group belongs to. required: true - name: adGroupId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the ad group to delete. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Empty' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.adGroups.delete patch: operationId: advertisersAdGroupsPatch summary: Updates an existing ad group. description: Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Output only. The unique ID of the advertiser the ad group belongs to. required: true - name: adGroupId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Output only. The unique ID of the ad group. Assigned by the system. required: true - name: updateMask in: query schema: type: string format: google-fieldmask description: Required. The mask to control which fields to update. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AdGroup' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/AdGroup' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.adGroups.patch /v4/advertisers/{advertisersId}/adGroups:bulkListAssignedTargetingOptions: get: operationId: advertisersAdGroupsBulkListAssignedTargetingOptions summary: Lists assigned targeting options for multiple ad groups across targeting types. description: Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser the line items belongs to. required: true - name: orderBy in: query schema: type: string description: 'Optional. Field by which to sort the list. Acceptable values are: * `adGroupId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`.' - name: adGroupIds in: query schema: type: array items: type: string format: int64 description: Required. The IDs of the ad groups to list assigned targeting options for. - name: pageSize in: query schema: type: integer format: int32 description: Optional. Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: pageToken in: query schema: type: string description: Optional. A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned. - name: filter in: query schema: type: string description: 'Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_YOUTUBE_VIDEO` or `TARGETING_TYPE_YOUTUBE_CHANNEL`: `targetingType="TARGETING_TYPE_YOUTUBE_VIDEO" OR targetingType="TARGETING_TYPE_YOUTUBE_CHANNEL"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BulkListAdGroupAssignedTargetingOptionsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.adGroups.bulkListAssignedTargetingOptions /v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions: post: operationId: advertisersAdGroupsTargetingTypesAssignedTargetingOptionsCreate summary: Assigns a targeting option to an ad group. description: Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. This method is only supported for Demand Gen ad groups. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser the ad group belongs to. required: true - name: adGroupId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the ad group the assigned targeting option will belong to. required: true - name: targetingType in: path schema: type: string 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 - TARGETING_TYPE_POI - TARGETING_TYPE_BUSINESS_CHAIN - TARGETING_TYPE_CONTENT_DURATION - TARGETING_TYPE_CONTENT_STREAM_TYPE - TARGETING_TYPE_NATIVE_CONTENT_POSITION - TARGETING_TYPE_OMID - TARGETING_TYPE_AUDIO_CONTENT_TYPE - TARGETING_TYPE_CONTENT_GENRE - TARGETING_TYPE_YOUTUBE_VIDEO - TARGETING_TYPE_YOUTUBE_CHANNEL - TARGETING_TYPE_SESSION_POSITION - TARGETING_TYPE_CONTENT_THEME_EXCLUSION - TARGETING_TYPE_YOUTUBE_CHANNEL_PACK pattern: ^[^/]+$ description: 'Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack.' required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AssignedTargetingOption' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/AssignedTargetingOption' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.create get: operationId: advertisersAdGroupsTargetingTypesAssignedTargetingOptionsList summary: Lists the targeting options assigned to an ad group. description: Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser the ad group belongs to. required: true - name: adGroupId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the ad group to list assigned targeting options for. required: true - name: targetingType in: path schema: type: string 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 - TARGETING_TYPE_POI - TARGETING_TYPE_BUSINESS_CHAIN - TARGETING_TYPE_CONTENT_DURATION - TARGETING_TYPE_CONTENT_STREAM_TYPE - TARGETING_TYPE_NATIVE_CONTENT_POSITION - TARGETING_TYPE_OMID - TARGETING_TYPE_AUDIO_CONTENT_TYPE - TARGETING_TYPE_CONTENT_GENRE - TARGETING_TYPE_YOUTUBE_VIDEO - TARGETING_TYPE_YOUTUBE_CHANNEL - TARGETING_TYPE_SESSION_POSITION - TARGETING_TYPE_CONTENT_THEME_EXCLUSION - TARGETING_TYPE_YOUTUBE_CHANNEL_PACK pattern: ^[^/]+$ description: 'Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack.' required: true - name: filter in: query schema: type: string description: 'Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: pageToken in: query schema: type: string description: Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned. - name: pageSize in: query schema: type: integer format: int32 description: Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: orderBy in: query schema: type: string description: 'Optional. Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListAdGroupAssignedTargetingOptionsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.list ? /v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId} : get: operationId: advertisersAdGroupsTargetingTypesAssignedTargetingOptionsGet summary: Gets a single targeting option assigned to an ad group. description: Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser the ad group belongs to. required: true - name: adGroupId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the ad group the assigned targeting option belongs to. required: true - name: targetingType in: path schema: type: string 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 - TARGETING_TYPE_POI - TARGETING_TYPE_BUSINESS_CHAIN - TARGETING_TYPE_CONTENT_DURATION - TARGETING_TYPE_CONTENT_STREAM_TYPE - TARGETING_TYPE_NATIVE_CONTENT_POSITION - TARGETING_TYPE_OMID - TARGETING_TYPE_AUDIO_CONTENT_TYPE - TARGETING_TYPE_CONTENT_GENRE - TARGETING_TYPE_YOUTUBE_VIDEO - TARGETING_TYPE_YOUTUBE_CHANNEL - TARGETING_TYPE_SESSION_POSITION - TARGETING_TYPE_CONTENT_THEME_EXCLUSION - TARGETING_TYPE_YOUTUBE_CHANNEL_PACK pattern: ^[^/]+$ description: 'Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack.' required: true - name: assignedTargetingOptionId in: path schema: type: string pattern: ^[^/]+$ description: Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/AssignedTargetingOption' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.get delete: operationId: advertisersAdGroupsTargetingTypesAssignedTargetingOptionsDelete summary: Deletes an assigned targeting option from an ad group. description: Deletes an assigned targeting option from an ad group. This method is only supported for Demand Gen ad groups with the AdGroupFormat `AD_GROUP_FORMAT_DEMAND_GEN`. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser the ad group belongs to. required: true - name: adGroupId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the ad group the assigned targeting option belongs to. required: true - name: targetingType in: path schema: type: string 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 - TARGETING_TYPE_POI - TARGETING_TYPE_BUSINESS_CHAIN - TARGETING_TYPE_CONTENT_DURATION - TARGETING_TYPE_CONTENT_STREAM_TYPE - TARGETING_TYPE_NATIVE_CONTENT_POSITION - TARGETING_TYPE_OMID - TARGETING_TYPE_AUDIO_CONTENT_TYPE - TARGETING_TYPE_CONTENT_GENRE - TARGETING_TYPE_YOUTUBE_VIDEO - TARGETING_TYPE_YOUTUBE_CHANNEL - TARGETING_TYPE_SESSION_POSITION - TARGETING_TYPE_CONTENT_THEME_EXCLUSION - TARGETING_TYPE_YOUTUBE_CHANNEL_PACK pattern: ^[^/]+$ description: 'Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack.' required: true - name: assignedTargetingOptionId in: path schema: type: string pattern: ^[^/]+$ description: Required. The ID of the assigned targeting option to delete. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Empty' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.delete /v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations: get: operationId: advertisersAdGroupsYoutubeAssetTypesYoutubeAssetAssociationsList summary: Lists the YouTube asset associations linked to the given resource. description: Lists the YouTube asset associations linked to the given resource. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser that the linked entity belongs to. required: true - name: adGroupId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of an ad group. required: true - name: youtubeAssetType in: path schema: type: string enum: - YOUTUBE_ASSET_TYPE_UNSPECIFIED - YOUTUBE_ASSET_TYPE_LOCATION - YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION - YOUTUBE_ASSET_TYPE_SITELINK pattern: ^[^/]+$ description: 'Required. The type of YouTube asset being associated with the resource. Allowed values — `YOUTUBE_ASSET_TYPE_UNSPECIFIED`: YouTube asset type is not specified or is unknown in this version.; `YOUTUBE_ASSET_TYPE_LOCATION`: Location asset.; `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`: Affiliate location asset.; `YOUTUBE_ASSET_TYPE_SITELINK`: Sitelink asset.' required: true - name: orderBy in: query schema: type: string description: 'Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`.' - name: linkedEntity.lineItemId in: query schema: type: string format: int64 description: The ID of a line item. - name: pageToken in: query schema: type: string description: Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListYoutubeAssetAssociations` method. If not specified, the first page of results will be returned. - name: pageSize in: query schema: type: integer format: int32 description: Optional. Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListYoutubeAssetAssociationsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.list post: operationId: advertisersAdGroupsYoutubeAssetTypesYoutubeAssetAssociationsCreate summary: Creates a new association between the identified resource and a YouTube asset. description: Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser that the linked entity belongs to. required: true - name: adGroupId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of an ad group. required: true - name: youtubeAssetType in: path schema: type: string enum: - YOUTUBE_ASSET_TYPE_UNSPECIFIED - YOUTUBE_ASSET_TYPE_LOCATION - YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION - YOUTUBE_ASSET_TYPE_SITELINK pattern: ^[^/]+$ description: 'Required. The type of YouTube asset associated with the resource. Allowed values — `YOUTUBE_ASSET_TYPE_UNSPECIFIED`: YouTube asset type is not specified or is unknown in this version.; `YOUTUBE_ASSET_TYPE_LOCATION`: Location asset.; `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`: Affiliate location asset.; `YOUTUBE_ASSET_TYPE_SITELINK`: Sitelink asset.' required: true - name: linkedEntity.lineItemId in: query schema: type: string format: int64 description: The ID of a line item. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/YoutubeAssetAssociation' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/YoutubeAssetAssociation' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.create ? /v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations/{youtubeAssetAssociationsId} : delete: operationId: advertisersAdGroupsYoutubeAssetTypesYoutubeAssetAssociationsDelete summary: Deletes an existing association between the identified resource and a YouTube asset. description: Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser that the linked entity belongs to. required: true - name: adGroupId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of an ad group. required: true - name: youtubeAssetType in: path schema: type: string enum: - YOUTUBE_ASSET_TYPE_UNSPECIFIED - YOUTUBE_ASSET_TYPE_LOCATION - YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION - YOUTUBE_ASSET_TYPE_SITELINK pattern: ^[^/]+$ description: 'Required. The type of YouTube asset associated with the resource. Allowed values — `YOUTUBE_ASSET_TYPE_UNSPECIFIED`: YouTube asset type is not specified or is unknown in this version.; `YOUTUBE_ASSET_TYPE_LOCATION`: Location asset.; `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`: Affiliate location asset.; `YOUTUBE_ASSET_TYPE_SITELINK`: Sitelink asset.' required: true - name: youtubeAssetAssociationId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: 'Required. The ID of the YouTube asset in the association. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: This should be the ID of the asset set linked, or 0 if the location_asset_filter or affiliate_location_asset_filter is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: This should be the ID of the sitelink asset linked.' required: true - name: linkedEntity.lineItemId in: query schema: type: string format: int64 description: The ID of a line item. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Empty' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.delete /v4/advertisers/{advertisersId}/lineItems: post: operationId: advertisersLineItemsCreate summary: Creates a new line item. description: Creates a new line item. Returns the newly created line item if successful. YouTube & Partners line items cannot be created or updated using the API. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Output only. The unique ID of the advertiser the line item belongs to. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LineItem' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/LineItem' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.lineItems.create get: operationId: advertisersLineItemsList summary: Lists line items in an advertiser. description: Lists line items in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, line items with `ENTITY_STATUS_ARCHIVED` will not be included in the results. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser to list line items for. required: true - name: filter in: query schema: type: string description: 'Allows filtering by line item fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `insertionOrderId` * `lineItemId` * `lineItemType` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All line items under an insertion order: `insertionOrderId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItems` method. If not specified, the first page of results will be returned. - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListLineItemsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.lineItems.list /v4/advertisers/{advertisersId}/lineItems:bulkListAssignedTargetingOptions: get: operationId: advertisersLineItemsBulkListAssignedTargetingOptions summary: Lists assigned targeting options for multiple line items across targeting types. description: Lists assigned targeting options for multiple line items across targeting types. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser the line items belongs to. required: true - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: filter in: query schema: type: string description: 'Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR` on the same field. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: pageToken in: query schema: type: string description: A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAssignedTargetingOptions` method. If not specified, the first page of results will be returned. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `lineItemId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`.' - name: lineItemIds in: query schema: type: array items: type: string format: int64 description: Required. The IDs of the line items to list assigned targeting options for. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BulkListAssignedTargetingOptionsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.lineItems.bulkListAssignedTargetingOptions /v4/advertisers/{advertisersId}/lineItems/{lineItemsId}: patch: operationId: advertisersLineItemsPatch summary: Updates an existing line item. description: 'Updates an existing line item. Returns the updated line item if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * BulkUpdateLineItems * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.' tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Output only. The unique ID of the advertiser the line item belongs to. required: true - name: lineItemId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Output only. The unique ID of the line item. Assigned by the system. required: true - name: updateMask in: query schema: type: string format: google-fieldmask description: Required. The mask to control which fields to update. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LineItem' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/LineItem' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.lineItems.patch get: operationId: advertisersLineItemsGet summary: Gets a line item. description: Gets a line item. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser this line item belongs to. required: true - name: lineItemId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the line item to fetch. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/LineItem' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.lineItems.get delete: operationId: advertisersLineItemsDelete summary: Deletes a line item. description: Deletes a line item. Returns error code `NOT_FOUND` if the line item does not exist. The line item should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. YouTube & Partners line items cannot be created or updated using the API. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of the advertiser this line item belongs to. required: true - name: lineItemId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of the line item to delete. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Empty' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.lineItems.delete /v4/advertisers/{advertisersId}/lineItems/{lineItemsId}:duplicate: post: operationId: advertisersLineItemsDuplicate summary: Duplicates a line item. description: Duplicates a line item. Returns the ID of the created line item if successful. YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser this line item belongs to. required: true - name: lineItemId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the line item to duplicate. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DuplicateLineItemRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/DuplicateLineItemResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.lineItems.duplicate /v4/advertisers/{advertisersId}/lineItems:bulkUpdate: post: operationId: advertisersLineItemsBulkUpdate summary: Updates multiple line items. description: 'Updates multiple line items. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * UpdateLineItem * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API.' tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser this line item belongs to. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BulkUpdateLineItemsRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BulkUpdateLineItemsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.lineItems.bulkUpdate /v4/advertisers/{advertisersId}/lineItems:bulkEditAssignedTargetingOptions: post: operationId: advertisersLineItemsBulkEditAssignedTargetingOptions summary: Bulk edits targeting options under multiple line items. description: 'Bulk edits targeting options under multiple line items. The operation will delete the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.create_requests. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkUpdate * lineItems.patch * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API.' tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser the line items belong to. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BulkEditAssignedTargetingOptionsRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BulkEditAssignedTargetingOptionsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.lineItems.bulkEditAssignedTargetingOptions /v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions: post: operationId: advertisersLineItemsTargetingTypesAssignedTargetingOptionsCreate summary: Assigns a targeting option to a line item. description: 'Assigns a targeting option to a line item. Returns the assigned targeting option if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * DeleteLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API.' tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser the line item belongs to. required: true - name: lineItemId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the line item the assigned targeting option will belong to. required: true - name: targetingType in: path schema: type: string 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 - TARGETING_TYPE_POI - TARGETING_TYPE_BUSINESS_CHAIN - TARGETING_TYPE_CONTENT_DURATION - TARGETING_TYPE_CONTENT_STREAM_TYPE - TARGETING_TYPE_NATIVE_CONTENT_POSITION - TARGETING_TYPE_OMID - TARGETING_TYPE_AUDIO_CONTENT_TYPE - TARGETING_TYPE_CONTENT_GENRE - TARGETING_TYPE_YOUTUBE_VIDEO - TARGETING_TYPE_YOUTUBE_CHANNEL - TARGETING_TYPE_SESSION_POSITION - TARGETING_TYPE_CONTENT_THEME_EXCLUSION - TARGETING_TYPE_YOUTUBE_CHANNEL_PACK pattern: ^[^/]+$ description: 'Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack.' required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AssignedTargetingOption' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/AssignedTargetingOption' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create get: operationId: advertisersLineItemsTargetingTypesAssignedTargetingOptionsList summary: Lists the targeting options assigned to a line item. description: Lists the targeting options assigned to a line item. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser the line item belongs to. required: true - name: lineItemId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the line item to list assigned targeting options for. required: true - name: targetingType in: path schema: type: string 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 - TARGETING_TYPE_POI - TARGETING_TYPE_BUSINESS_CHAIN - TARGETING_TYPE_CONTENT_DURATION - TARGETING_TYPE_CONTENT_STREAM_TYPE - TARGETING_TYPE_NATIVE_CONTENT_POSITION - TARGETING_TYPE_OMID - TARGETING_TYPE_AUDIO_CONTENT_TYPE - TARGETING_TYPE_CONTENT_GENRE - TARGETING_TYPE_YOUTUBE_VIDEO - TARGETING_TYPE_YOUTUBE_CHANNEL - TARGETING_TYPE_SESSION_POSITION - TARGETING_TYPE_CONTENT_THEME_EXCLUSION - TARGETING_TYPE_YOUTUBE_CHANNEL_PACK pattern: ^[^/]+$ description: 'Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack.' required: true - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned. - name: filter in: query schema: type: string description: 'Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListLineItemAssignedTargetingOptionsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list ? /v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId} : get: operationId: advertisersLineItemsTargetingTypesAssignedTargetingOptionsGet summary: Gets a single targeting option assigned to a line item. description: Gets a single targeting option assigned to a line item. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser the line item belongs to. required: true - name: lineItemId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the line item the assigned targeting option belongs to. required: true - name: targetingType in: path schema: type: string 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 - TARGETING_TYPE_POI - TARGETING_TYPE_BUSINESS_CHAIN - TARGETING_TYPE_CONTENT_DURATION - TARGETING_TYPE_CONTENT_STREAM_TYPE - TARGETING_TYPE_NATIVE_CONTENT_POSITION - TARGETING_TYPE_OMID - TARGETING_TYPE_AUDIO_CONTENT_TYPE - TARGETING_TYPE_CONTENT_GENRE - TARGETING_TYPE_YOUTUBE_VIDEO - TARGETING_TYPE_YOUTUBE_CHANNEL - TARGETING_TYPE_SESSION_POSITION - TARGETING_TYPE_CONTENT_THEME_EXCLUSION - TARGETING_TYPE_YOUTUBE_CHANNEL_PACK pattern: ^[^/]+$ description: 'Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack.' required: true - name: assignedTargetingOptionId in: path schema: type: string pattern: ^[^/]+$ description: Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/AssignedTargetingOption' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get delete: operationId: advertisersLineItemsTargetingTypesAssignedTargetingOptionsDelete summary: Deletes an assigned targeting option from a line item. description: 'Deletes an assigned targeting option from a line item. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * CreateLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API.' tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser the line item belongs to. required: true - name: lineItemId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the line item the assigned targeting option belongs to. required: true - name: targetingType in: path schema: type: string 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 - TARGETING_TYPE_POI - TARGETING_TYPE_BUSINESS_CHAIN - TARGETING_TYPE_CONTENT_DURATION - TARGETING_TYPE_CONTENT_STREAM_TYPE - TARGETING_TYPE_NATIVE_CONTENT_POSITION - TARGETING_TYPE_OMID - TARGETING_TYPE_AUDIO_CONTENT_TYPE - TARGETING_TYPE_CONTENT_GENRE - TARGETING_TYPE_YOUTUBE_VIDEO - TARGETING_TYPE_YOUTUBE_CHANNEL - TARGETING_TYPE_SESSION_POSITION - TARGETING_TYPE_CONTENT_THEME_EXCLUSION - TARGETING_TYPE_YOUTUBE_CHANNEL_PACK pattern: ^[^/]+$ description: 'Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack.' required: true - name: assignedTargetingOptionId in: path schema: type: string pattern: ^[^/]+$ description: Required. The ID of the assigned targeting option to delete. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Empty' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete /v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations: post: operationId: advertisersLineItemsYoutubeAssetTypesYoutubeAssetAssociationsCreate summary: Creates a new association between the identified resource and a YouTube asset. description: Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser that the linked entity belongs to. required: true - name: lineItemId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of a line item. required: true - name: youtubeAssetType in: path schema: type: string enum: - YOUTUBE_ASSET_TYPE_UNSPECIFIED - YOUTUBE_ASSET_TYPE_LOCATION - YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION - YOUTUBE_ASSET_TYPE_SITELINK pattern: ^[^/]+$ description: 'Required. The type of YouTube asset associated with the resource. Allowed values — `YOUTUBE_ASSET_TYPE_UNSPECIFIED`: YouTube asset type is not specified or is unknown in this version.; `YOUTUBE_ASSET_TYPE_LOCATION`: Location asset.; `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`: Affiliate location asset.; `YOUTUBE_ASSET_TYPE_SITELINK`: Sitelink asset.' required: true - name: linkedEntity.adGroupId in: query schema: type: string format: int64 description: The ID of an ad group. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/YoutubeAssetAssociation' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/YoutubeAssetAssociation' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.create get: operationId: advertisersLineItemsYoutubeAssetTypesYoutubeAssetAssociationsList summary: Lists the YouTube asset associations linked to the given resource. description: Lists the YouTube asset associations linked to the given resource. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser that the linked entity belongs to. required: true - name: lineItemId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of a line item. required: true - name: youtubeAssetType in: path schema: type: string enum: - YOUTUBE_ASSET_TYPE_UNSPECIFIED - YOUTUBE_ASSET_TYPE_LOCATION - YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION - YOUTUBE_ASSET_TYPE_SITELINK pattern: ^[^/]+$ description: 'Required. The type of YouTube asset being associated with the resource. Allowed values — `YOUTUBE_ASSET_TYPE_UNSPECIFIED`: YouTube asset type is not specified or is unknown in this version.; `YOUTUBE_ASSET_TYPE_LOCATION`: Location asset.; `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`: Affiliate location asset.; `YOUTUBE_ASSET_TYPE_SITELINK`: Sitelink asset.' required: true - name: pageSize in: query schema: type: integer format: int32 description: Optional. Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: pageToken in: query schema: type: string description: Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListYoutubeAssetAssociations` method. If not specified, the first page of results will be returned. - name: orderBy in: query schema: type: string description: 'Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`.' - name: linkedEntity.adGroupId in: query schema: type: string format: int64 description: The ID of an ad group. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListYoutubeAssetAssociationsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.list ? /v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations/{youtubeAssetAssociationsId} : delete: operationId: advertisersLineItemsYoutubeAssetTypesYoutubeAssetAssociationsDelete summary: Deletes an existing association between the identified resource and a YouTube asset. description: Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser that the linked entity belongs to. required: true - name: lineItemId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of a line item. required: true - name: youtubeAssetType in: path schema: type: string enum: - YOUTUBE_ASSET_TYPE_UNSPECIFIED - YOUTUBE_ASSET_TYPE_LOCATION - YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION - YOUTUBE_ASSET_TYPE_SITELINK pattern: ^[^/]+$ description: 'Required. The type of YouTube asset associated with the resource. Allowed values — `YOUTUBE_ASSET_TYPE_UNSPECIFIED`: YouTube asset type is not specified or is unknown in this version.; `YOUTUBE_ASSET_TYPE_LOCATION`: Location asset.; `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`: Affiliate location asset.; `YOUTUBE_ASSET_TYPE_SITELINK`: Sitelink asset.' required: true - name: youtubeAssetAssociationId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: 'Required. The ID of the YouTube asset in the association. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: This should be the ID of the asset set linked, or 0 if the location_asset_filter or affiliate_location_asset_filter is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: This should be the ID of the sitelink asset linked.' required: true - name: linkedEntity.adGroupId in: query schema: type: string format: int64 description: The ID of an ad group. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Empty' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.delete /v4/advertisers/{advertisersId}/channels/{channelId}: patch: operationId: advertisersChannelsPatch summary: Updates a channel. description: Updates a channel. Returns the updated channel if successful. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of the advertiser that owns the created channel. required: true - name: channelId in: path schema: type: string format: int64 description: Output only. The unique ID of the channel. Assigned by the system. required: true - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that owns the created channel. - name: updateMask in: query schema: type: string format: google-fieldmask description: Required. The mask to control which fields to update. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Channel' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Channel' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.channels.patch /v4/advertisers/{advertisersId}/channels/{channelsId}: get: operationId: advertisersChannelsGet summary: Gets a channel for a partner or advertiser. description: Gets a channel for a partner or advertiser. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of the advertiser that owns the fetched channel. required: true - name: channelId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the channel to fetch. required: true - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that owns the fetched channel. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Channel' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.channels.get /v4/advertisers/{advertisersId}/channels: get: operationId: advertisersChannelsList summary: Lists channels for a partner or advertiser. description: Lists channels for a partner or advertiser. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of the advertiser that owns the channels. required: true - name: filter in: query schema: type: string description: 'Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned. - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`.' - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that owns the channels. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListChannelsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.channels.list post: operationId: advertisersChannelsCreate summary: Creates a new channel. description: Creates a new channel. Returns the newly created channel if successful. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of the advertiser that owns the created channel. required: true - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that owns the created channel. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Channel' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Channel' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.channels.create /v4/advertisers/{advertisersId}/channels/{channelsId}/sites: get: operationId: advertisersChannelsSitesList summary: Lists sites in a channel. description: Lists sites in a channel. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of the advertiser that owns the parent channel. required: true - name: channelId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the parent channel to which the requested sites belong. required: true - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: filter in: query schema: type: string description: 'Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`.' - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that owns the parent channel. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListSitesResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.channels.sites.list /v4/advertisers/{advertiserId}/channels/{channelsId}/sites: post: operationId: advertisersChannelsSitesCreate summary: Creates a site in a channel. description: Creates a site in a channel. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 description: The ID of the advertiser that owns the parent channel. required: true - name: channelId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the parent channel in which the site will be created. required: true - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that owns the parent channel. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Site' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Site' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.channels.sites.create /v4/advertisers/{advertiserId}/channels/{channelsId}/sites:replace: post: operationId: advertisersChannelsSitesReplace summary: Replaces all of the sites under a single channel. description: Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 description: The ID of the advertiser that owns the parent channel. required: true - name: channelId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the parent channel whose sites will be replaced. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReplaceSitesRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ReplaceSitesResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.channels.sites.replace /v4/advertisers/{advertiserId}/channels/{channelsId}/sites/{sitesId}: delete: operationId: advertisersChannelsSitesDelete summary: Deletes a site from a channel. description: Deletes a site from a channel. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 description: The ID of the advertiser that owns the parent channel. required: true - name: channelId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the parent channel to which the site belongs. required: true - name: urlOrAppId in: path schema: type: string pattern: ^[^/]+$ description: Required. The URL or app ID of the site to delete. required: true - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that owns the parent channel. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Empty' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.channels.sites.delete /v4/advertisers/{advertiserId}/channels/{channelsId}/sites:bulkEdit: post: operationId: advertisersChannelsSitesBulkEdit summary: Bulk edits sites under a single channel. description: Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 description: The ID of the advertiser that owns the parent channel. required: true - name: channelId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the parent channel to which the sites belong. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BulkEditSitesRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BulkEditSitesResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.channels.sites.bulkEdit /v4/advertisers/{advertisersId}/creatives: post: operationId: advertisersCreativesCreate summary: Creates a new creative. description: Creates a new creative. Returns the newly created creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Output only. The unique ID of the advertiser the creative belongs to. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Creative' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Creative' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.creatives.create get: operationId: advertisersCreativesList summary: Lists creatives in an advertiser. description: Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with `ENTITY_STATUS_ARCHIVED` will not be included in the results. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser to list creatives for. required: true - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: filter in: query schema: type: string description: 'Allows filtering by creative fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `lineItemIds` field must use the `HAS (:)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. * For `entityStatus`, `minDuration`, `maxDuration`, `updateTime`, and `dynamic` fields, there may be at most one restriction. Supported Fields: * `approvalStatus` * `creativeId` * `creativeType` * `dimensions` (input in the form of `{width}x{height}`) * `dynamic` * `entityStatus` * `exchangeReviewStatus` (input in the form of `{exchange}-{reviewStatus}`) * `lineItemIds` * `maxDuration` (input in the form of `{duration}s`. Only seconds are supported) * `minDuration` (input in the form of `{duration}s`. Only seconds are supported) * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Notes: * For `updateTime`, a creative resource''s field value reflects the last time that a creative has been updated, which includes updates made by the system (e.g. creative review updates). Examples: * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms: `dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` * All video creatives that are associated with line item ID 1 or 2: `creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)` * Find creatives by multiple creative IDs: `creativeId=1 OR creativeId=2` * All creatives with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCreatives` method. If not specified, the first page of results will be returned. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `creativeId` (default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `createTime desc`.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListCreativesResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.creatives.list /v4/advertisers/{advertisersId}/creatives/{creativesId}: get: operationId: advertisersCreativesGet summary: Gets a creative. description: Gets a creative. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser this creative belongs to. required: true - name: creativeId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the creative to fetch. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Creative' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.creatives.get delete: operationId: advertisersCreativesDelete summary: Deletes a creative. description: Deletes a creative. Returns error code `NOT_FOUND` if the creative does not exist. The creative should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, before it can be deleted. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of the advertiser this creative belongs to. required: true - name: creativeId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of the creative to be deleted. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Empty' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.creatives.delete patch: operationId: advertisersCreativesPatch summary: Updates an existing creative. description: Updates an existing creative. Returns the updated creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Output only. The unique ID of the advertiser the creative belongs to. required: true - name: creativeId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Output only. The unique ID of the creative. Assigned by the system. required: true - name: updateMask in: query schema: type: string format: google-fieldmask description: Required. The mask to control which fields to update. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Creative' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Creative' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.creatives.patch /v4/advertisers/{advertisersId}/adGroupAds: post: operationId: advertisersAdGroupAdsCreate summary: Creates an ad group ad. description: Creates an ad group ad. This method is only supported for Demand Gen ads. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Output only. The unique ID of the advertiser the ad belongs to. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AdGroupAd' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/AdGroupAd' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.adGroupAds.create get: operationId: advertisersAdGroupAdsList summary: Lists ad group ads. description: Lists ad group ads. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser the ads belong to. required: true - name: pageToken in: query schema: type: string description: Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAds` method. If not specified, the first page of results will be returned. - name: filter in: query schema: type: string description: 'Optional. Allows filtering by ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId="1234"` * All ad group ads under an ad group with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: pageSize in: query schema: type: integer format: int32 description: Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: orderBy in: query schema: type: string description: 'Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListAdGroupAdsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.adGroupAds.list /v4/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}: get: operationId: advertisersAdGroupAdsGet summary: Gets an ad group ad. description: Gets an ad group ad. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser this ad group ad belongs to. required: true - name: adGroupAdId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the ad to fetch. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/AdGroupAd' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.adGroupAds.get delete: operationId: advertisersAdGroupAdsDelete summary: Deletes an ad group ad. description: Deletes an ad group ad. This method is only supported for Demand Gen ads. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser the ad belongs to. required: true - name: adGroupAdId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the ad to delete. Only Demand Gen ads are supported. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Empty' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.adGroupAds.delete patch: operationId: advertisersAdGroupAdsPatch summary: Updates an ad group ad. description: Updates an ad group ad. This method is only supported for Demand Gen ads. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Output only. The unique ID of the advertiser the ad belongs to. required: true - name: adGroupAdId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Output only. The unique ID of the ad. Assigned by the system. required: true - name: updateMask in: query schema: type: string format: google-fieldmask description: Required. The mask to control which fields to update. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AdGroupAd' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/AdGroupAd' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.adGroupAds.patch /v4/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}: patch: operationId: advertisersInsertionOrdersPatch summary: Updates an existing insertion order. description: Updates an existing insertion order. Returns the updated insertion order if successful. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Output only. The unique ID of the advertiser the insertion order belongs to. required: true - name: insertionOrderId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Output only. The unique ID of the insertion order. Assigned by the system. required: true - name: updateMask in: query schema: type: string format: google-fieldmask description: Required. The mask to control which fields to update. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/InsertionOrder' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/InsertionOrder' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.insertionOrders.patch get: operationId: advertisersInsertionOrdersGet summary: Gets an insertion order. description: Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser this insertion order belongs to. required: true - name: insertionOrderId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the insertion order to fetch. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/InsertionOrder' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.insertionOrders.get delete: operationId: advertisersInsertionOrdersDelete summary: Deletes an insertion order. description: Deletes an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. The insertion order should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of the advertiser this insertion order belongs to. required: true - name: insertionOrderId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of the insertion order to delete. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Empty' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.insertionOrders.delete /v4/advertisers/{advertisersId}/insertionOrders: get: operationId: advertisersInsertionOrdersList summary: Lists insertion orders in an advertiser. description: Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser to list insertion orders for. required: true - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" * "updateTime" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.' - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: filter in: query schema: type: string description: 'Allows filtering by insertion order fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrders` method. If not specified, the first page of results will be returned. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListInsertionOrdersResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.insertionOrders.list post: operationId: advertisersInsertionOrdersCreate summary: Creates a new insertion order. description: Creates a new insertion order. Returns the newly created insertion order if successful. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Output only. The unique ID of the advertiser the insertion order belongs to. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/InsertionOrder' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/InsertionOrder' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.insertionOrders.create /v4/advertisers/{advertisersId}/reachForecast:retrievePlannableUserLists: get: operationId: advertisersReachForecastRetrievePlannableUserLists summary: Retrieves first and third party user lists available for forecasting. description: Retrieves first and third party user lists available for forecasting. API support for generating reach forecasts and retrieving related metadata is in beta. This method is only available to allowlisted users. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser to retrieve plannable user lists for. required: true - name: filter in: query schema: type: string description: 'Optional. Allows filtering by plannable user list properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * The `displayName` field must use the `HAS (:)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `plannableStatus` * `displayName` * `userListType` * `name` Examples: * All plannable user lists: `plannableStatus="PLANNABLE"` * Plannable user lists with display name containing "Shopping": `plannableStatus="PLANNABLE" AND displayName:"Shopping"` * First party user lists: `userListType="FIRST_PARTY"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: pageToken in: query schema: type: string description: Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `RetrievePlannableUserLists` method. If not specified, the first page of results will be returned. - name: pageSize in: query schema: type: integer format: int32 description: Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `5000`. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/RetrievePlannableUserListsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.reachForecast.retrievePlannableUserLists /v4/advertisers/{advertisersId}/reachForecast:generateReachForecast: post: operationId: advertisersReachForecastGenerateReachForecast summary: Generates a reach forecast for a given advertiser and targeting configuration. description: Generates a reach forecast for a given advertiser and targeting configuration. API support for generating reach forecasts and retrieving related metadata is in beta. This method is only available to allowlisted users. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser that will run the planned campaign. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GenerateReachForecastRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GenerateReachForecastResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.reachForecast.generateReachForecast /v4/advertisers/{advertisersId}/reachForecast:retrievePlannableLocations: get: operationId: advertisersReachForecastRetrievePlannableLocations summary: Retrieves the list of countries where reach forecasting is supported. description: Retrieves the list of countries where reach forecasting is supported. API support for generating reach forecasts and retrieving related metadata is in beta. This method is only available to allowlisted users. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser to list plannable locations for. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/RetrievePlannableLocationsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.reachForecast.retrievePlannableLocations /v4/advertisers/{advertisersId}/reachForecast:retrievePlannableProducts: get: operationId: advertisersReachForecastRetrievePlannableProducts summary: Retrieves the list of products that can be planned for a location. description: Retrieves the list of products that can be planned for a location. API support for generating reach forecasts and retrieving related metadata is in beta. This method is only available to allowlisted users. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser to list plannable products for. required: true - name: plannableLocationId in: query schema: type: string description: Required. The ID of the plannable location. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/RetrievePlannableProductsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.reachForecast.retrievePlannableProducts /v4/advertisers/{advertisersId}/reachForecast:retrievePlannableUserInterests: get: operationId: advertisersReachForecastRetrievePlannableUserInterests summary: Retrieves Google Audiences (User Interests) available for forecasting. description: Retrieves Google Audiences (User Interests) available for forecasting. API support for generating reach forecasts and retrieving related metadata is in beta. This method is only available to allowlisted users. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser to list plannable user interests for. required: true - name: productCategory in: query schema: type: string enum: - PLANNABLE_PRODUCT_CATEGORY_UNSPECIFIED - YOUTUBE - OPEN_AUCTION description: 'Required. The product category to retrieve plannable user interests for. Allowed values — `PLANNABLE_PRODUCT_CATEGORY_UNSPECIFIED`: Not specified.; `YOUTUBE`: YouTube.; `OPEN_AUCTION`: Open Auction.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/RetrievePlannableUserInterestsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.reachForecast.retrievePlannableUserInterests /v4/advertisers/{advertisersId}/campaigns: post: operationId: advertisersCampaignsCreate summary: Creates a new campaign. description: Creates a new campaign. Returns the newly created campaign if successful. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Output only. The unique ID of the advertiser the campaign belongs to. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Campaign' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Campaign' security: - oauth2: - https://www.googleapis.com/auth/display-video - https://www.googleapis.com/auth/display-video-mediaplanning x-google-method-id: displayvideo.advertisers.campaigns.create get: operationId: advertisersCampaignsList summary: Lists campaigns in an advertiser. description: Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with `ENTITY_STATUS_ARCHIVED` will not be included in the results. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of the advertiser to list campaigns for. required: true - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.' - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaigns` method. If not specified, the first page of results will be returned. - name: filter in: query schema: type: string description: 'Allows filtering by campaign fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All campaigns with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListCampaignsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video - https://www.googleapis.com/auth/display-video-mediaplanning x-google-method-id: displayvideo.advertisers.campaigns.list /v4/advertisers/{advertisersId}/campaigns/{campaignsId}: get: operationId: advertisersCampaignsGet summary: Gets a campaign. description: Gets a campaign. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser this campaign belongs to. required: true - name: campaignId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the campaign to fetch. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Campaign' security: - oauth2: - https://www.googleapis.com/auth/display-video - https://www.googleapis.com/auth/display-video-mediaplanning x-google-method-id: displayvideo.advertisers.campaigns.get delete: operationId: advertisersCampaignsDelete summary: Permanently deletes a campaign. description: Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of the advertiser this campaign belongs to. required: true - name: campaignId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of the campaign we need to delete. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Empty' security: - oauth2: - https://www.googleapis.com/auth/display-video - https://www.googleapis.com/auth/display-video-mediaplanning x-google-method-id: displayvideo.advertisers.campaigns.delete patch: operationId: advertisersCampaignsPatch summary: Updates an existing campaign. description: Updates an existing campaign. Returns the updated campaign if successful. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Output only. The unique ID of the advertiser the campaign belongs to. required: true - name: campaignId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Output only. The unique ID of the campaign. Assigned by the system. required: true - name: updateMask in: query schema: type: string format: google-fieldmask description: Required. The mask to control which fields to update. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Campaign' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Campaign' security: - oauth2: - https://www.googleapis.com/auth/display-video - https://www.googleapis.com/auth/display-video-mediaplanning x-google-method-id: displayvideo.advertisers.campaigns.patch /v4/advertisers/{advertisersId}/locationLists/{locationListsId}: get: operationId: advertisersLocationListsGet summary: Gets a location list. description: Gets a location list. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the DV360 advertiser to which the fetched location list belongs. required: true - name: locationListId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the location list to fetch. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/LocationList' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.locationLists.get /v4/advertisers/{advertisersId}/locationLists: get: operationId: advertisersLocationListsList summary: Lists location lists based on a given advertiser id. description: Lists location lists based on a given advertiser id. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the DV360 advertiser to which the fetched location lists belong. required: true - name: filter in: query schema: type: string description: 'Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `locationType` Examples: * All regional location list: `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLocationLists` method. If not specified, the first page of results will be returned. - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `locationListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListLocationListsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.locationLists.list post: operationId: advertisersLocationListsCreate summary: Creates a new location list. description: Creates a new location list. Returns the newly created location list if successful. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the DV360 advertiser to which the location list belongs. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LocationList' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/LocationList' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.locationLists.create /v4/advertisers/{advertisersId}/locationLists/{locationListId}: patch: operationId: advertisersLocationListsPatch summary: Updates a location list. description: Updates a location list. Returns the updated location list if successful. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the DV360 advertiser to which the location lists belongs. required: true - name: locationListId in: path schema: type: string format: int64 description: Output only. The unique ID of the location list. Assigned by the system. required: true - name: updateMask in: query schema: type: string format: google-fieldmask description: Required. The mask to control which fields to update. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LocationList' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/LocationList' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.locationLists.patch /v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations: post: operationId: advertisersLocationListsAssignedLocationsCreate summary: Creates an assignment between a location and a location list. description: Creates an assignment between a location and a location list. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 description: Required. The ID of the DV360 advertiser to which the location list belongs. required: true - name: locationListId in: path schema: type: string format: int64 description: Required. The ID of the location list for which the assignment will be created. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AssignedLocation' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/AssignedLocation' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.locationLists.assignedLocations.create get: operationId: advertisersLocationListsAssignedLocationsList summary: Lists locations assigned to a location list. description: Lists locations assigned to a location list. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 description: Required. The ID of the DV360 advertiser to which the location list belongs. required: true - name: locationListId in: path schema: type: string format: int64 description: Required. The ID of the location list to which these assignments are assigned. required: true - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `assignedLocationId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `assignedLocationId desc`.' - name: filter in: query schema: type: string description: 'Allows filtering by location list assignment fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedLocationId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAssignedLocations` method. If not specified, the first page of results will be returned. - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListAssignedLocationsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.locationLists.assignedLocations.list /v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{assignedLocationsId}: delete: operationId: advertisersLocationListsAssignedLocationsDelete summary: Deletes the assignment between a location and a location list. description: Deletes the assignment between a location and a location list. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 description: Required. The ID of the DV360 advertiser to which the location list belongs. required: true - name: locationListId in: path schema: type: string format: int64 description: Required. The ID of the location list to which this assignment is assigned. required: true - name: assignedLocationId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the assigned location to delete. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Empty' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.locationLists.assignedLocations.delete /v4/advertisers/{advertiserId}/locationLists/{locationListsId}/assignedLocations:bulkEdit: post: operationId: advertisersLocationListsAssignedLocationsBulkEdit summary: Bulk edits multiple assignments between locations and a single location list. description: Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in deletedAssignedLocations and then create the assigned locations provided in createdAssignedLocations. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 description: Required. The ID of the DV360 advertiser to which the location list belongs. required: true - name: locationListId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the location list to which these assignments are assigned. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BulkEditAssignedLocationsRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BulkEditAssignedLocationsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.locationLists.assignedLocations.bulkEdit /v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}: get: operationId: advertisersTargetingTypesAssignedTargetingOptionsGet summary: Gets a single targeting option assigned to an advertiser. description: Gets a single targeting option assigned to an advertiser. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser. required: true - name: targetingType in: path schema: type: string 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 - TARGETING_TYPE_POI - TARGETING_TYPE_BUSINESS_CHAIN - TARGETING_TYPE_CONTENT_DURATION - TARGETING_TYPE_CONTENT_STREAM_TYPE - TARGETING_TYPE_NATIVE_CONTENT_POSITION - TARGETING_TYPE_OMID - TARGETING_TYPE_AUDIO_CONTENT_TYPE - TARGETING_TYPE_CONTENT_GENRE - TARGETING_TYPE_YOUTUBE_VIDEO - TARGETING_TYPE_YOUTUBE_CHANNEL - TARGETING_TYPE_SESSION_POSITION - TARGETING_TYPE_CONTENT_THEME_EXCLUSION - TARGETING_TYPE_YOUTUBE_CHANNEL_PACK pattern: ^[^/]+$ description: 'Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_YOUTUBE_VIDEO` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_CONTENT_THEME_EXCLUSION` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack.' required: true - name: assignedTargetingOptionId in: path schema: type: string pattern: ^[^/]+$ description: Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/AssignedTargetingOption' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.targetingTypes.assignedTargetingOptions.get delete: operationId: advertisersTargetingTypesAssignedTargetingOptionsDelete summary: Deletes an assigned targeting option from an advertiser. description: Deletes an assigned targeting option from an advertiser. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser. required: true - name: targetingType in: path schema: type: string 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 - TARGETING_TYPE_POI - TARGETING_TYPE_BUSINESS_CHAIN - TARGETING_TYPE_CONTENT_DURATION - TARGETING_TYPE_CONTENT_STREAM_TYPE - TARGETING_TYPE_NATIVE_CONTENT_POSITION - TARGETING_TYPE_OMID - TARGETING_TYPE_AUDIO_CONTENT_TYPE - TARGETING_TYPE_CONTENT_GENRE - TARGETING_TYPE_YOUTUBE_VIDEO - TARGETING_TYPE_YOUTUBE_CHANNEL - TARGETING_TYPE_SESSION_POSITION - TARGETING_TYPE_CONTENT_THEME_EXCLUSION - TARGETING_TYPE_YOUTUBE_CHANNEL_PACK pattern: ^[^/]+$ description: 'Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack.' required: true - name: assignedTargetingOptionId in: path schema: type: string pattern: ^[^/]+$ description: Required. The ID of the assigned targeting option to delete. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Empty' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.targetingTypes.assignedTargetingOptions.delete /v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions: get: operationId: advertisersTargetingTypesAssignedTargetingOptionsList summary: Lists the targeting options assigned to an advertiser. description: Lists the targeting options assigned to an advertiser. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser. required: true - name: targetingType in: path schema: type: string 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 - TARGETING_TYPE_POI - TARGETING_TYPE_BUSINESS_CHAIN - TARGETING_TYPE_CONTENT_DURATION - TARGETING_TYPE_CONTENT_STREAM_TYPE - TARGETING_TYPE_NATIVE_CONTENT_POSITION - TARGETING_TYPE_OMID - TARGETING_TYPE_AUDIO_CONTENT_TYPE - TARGETING_TYPE_CONTENT_GENRE - TARGETING_TYPE_YOUTUBE_VIDEO - TARGETING_TYPE_YOUTUBE_CHANNEL - TARGETING_TYPE_SESSION_POSITION - TARGETING_TYPE_CONTENT_THEME_EXCLUSION - TARGETING_TYPE_YOUTUBE_CHANNEL_PACK pattern: ^[^/]+$ description: 'Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_YOUTUBE_VIDEO` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_CONTENT_THEME_EXCLUSION` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack.' required: true - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`.' - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned. - name: filter in: query schema: type: string description: 'Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` with ID 123456: `assignedTargetingOptionId="123456"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListAdvertiserAssignedTargetingOptionsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.targetingTypes.assignedTargetingOptions.list post: operationId: advertisersTargetingTypesAssignedTargetingOptionsCreate summary: Assigns a targeting option to an advertiser. description: Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser. required: true - name: targetingType in: path schema: type: string 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 - TARGETING_TYPE_POI - TARGETING_TYPE_BUSINESS_CHAIN - TARGETING_TYPE_CONTENT_DURATION - TARGETING_TYPE_CONTENT_STREAM_TYPE - TARGETING_TYPE_NATIVE_CONTENT_POSITION - TARGETING_TYPE_OMID - TARGETING_TYPE_AUDIO_CONTENT_TYPE - TARGETING_TYPE_CONTENT_GENRE - TARGETING_TYPE_YOUTUBE_VIDEO - TARGETING_TYPE_YOUTUBE_CHANNEL - TARGETING_TYPE_SESSION_POSITION - TARGETING_TYPE_CONTENT_THEME_EXCLUSION - TARGETING_TYPE_YOUTUBE_CHANNEL_PACK pattern: ^[^/]+$ description: 'Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack.' required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AssignedTargetingOption' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/AssignedTargetingOption' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.targetingTypes.assignedTargetingOptions.create /v4/advertisers/{advertisersId}/adAssets: post: operationId: advertisersAdAssetsCreate summary: Creates an ad asset. description: Creates an ad asset. Returns the newly-created ad asset if successful. Only supports the creation of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser this ad asset belongs to. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAdAssetRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/AdAsset' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.adAssets.create get: operationId: advertisersAdAssetsList summary: Lists ad assets under an advertiser ID. description: Lists ad assets under an advertiser ID. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser the ad assets belong to. required: true - name: orderBy in: query schema: type: string description: 'Optional. Field by which to sort the list. Acceptable values are: * `entityStatus` * `youtubeVideoAsset.youtubeVideoId` * `adAssetId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `adAssetId desc`.' - name: filter in: query schema: type: string description: 'Optional. Allows filtering of the results by ad asset fields. Supported syntax: * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `youtubeVideoAsset.youtubeVideoId` * `entityStatus` Examples: * All active YouTube video ad assets under an advertiser: `entityStatus=ENTITY_STATUS_ACTIVE`' - name: pageToken in: query schema: type: string description: Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdAssets` method. If not specified, the first page of results will be returned. - name: pageSize in: query schema: type: integer format: int32 description: Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListAdAssetsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.adAssets.list /v4/advertisers/{advertisersId}/adAssets/{adAssetsId}: get: operationId: advertisersAdAssetsGet summary: Gets an ad asset. description: Gets an ad asset. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser this ad asset belongs to. required: true - name: adAssetId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the ad asset to fetch. Only supports assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO` required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/AdAsset' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.adAssets.get patch: operationId: advertisersAdAssetsPatch summary: Updates an ad asset. description: Updates an ad asset. Returns the updated ad asset if successful. Supports updating assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO` and `AD_ASSET_TYPE_IMAGE`. Only the AdAsset.synthetic_content_attestation_status field is mutable. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser this ad asset belongs to. required: true - name: adAssetId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad. required: true - name: updateMask in: query schema: type: string format: google-fieldmask description: Required. The list of fields to update. Only AdAsset.synthetic_content_attestation_status is mutable. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AdAsset' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/AdAsset' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.adAssets.patch /v4/advertisers/{advertisersId}/adAssets:uploadAdAsset: post: operationId: advertisersAdAssetsUpload summary: Uploads and creates an ad asset. description: Uploads and creates an ad asset. Returns the ID of the newly-created ad asset if successful. Only supports the uploading of assets with the AdAssetType `AD_ASSET_TYPE_IMAGE`. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser this ad asset belongs to. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UploadAdAssetRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/UploadAdAssetResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-supports-media-upload: true x-google-method-id: displayvideo.advertisers.adAssets.upload /v4/advertisers/{advertisersId}/adAssets:bulkCreate: post: operationId: advertisersAdAssetsBulkCreate summary: Creates multiple ad assets in a single request. description: Creates multiple ad assets in a single request. Returns the newly-created ad assets if successful. Only supports the creation of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser these ad assets belong to. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BulkCreateAdAssetsRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BulkCreateAdAssetsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.adAssets.bulkCreate /v4/advertisers/{advertisersId}/invoices: get: operationId: advertisersInvoicesList summary: Lists invoices posted for an advertiser in a given month. description: Lists invoices posted for an advertiser in a given month. Invoices generated by billing profiles with a "Partner" invoice level are not retrievable through this method. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser to list invoices for. required: true - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInvoices` method. If not specified, the first page of results will be returned. - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: loiSapinInvoiceType in: query schema: type: string enum: - LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED - LOI_SAPIN_INVOICE_TYPE_MEDIA - LOI_SAPIN_INVOICE_TYPE_PLATFORM description: 'Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise. Allowed values — `LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED`: Value is not specified.; `LOI_SAPIN_INVOICE_TYPE_MEDIA`: Invoices with Media cost.; `LOI_SAPIN_INVOICE_TYPE_PLATFORM`: Invoices with Platform fee.' - name: issueMonth in: query schema: type: string description: The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListInvoicesResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video - https://www.googleapis.com/auth/display-video-mediaplanning x-google-method-id: displayvideo.advertisers.invoices.list /v4/advertisers/{advertisersId}/invoices:lookupInvoiceCurrency: get: operationId: advertisersInvoicesLookupInvoiceCurrency summary: Retrieves the invoice currency used by an advertiser in a given month. description: Retrieves the invoice currency used by an advertiser in a given month. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the advertiser to lookup currency for. required: true - name: invoiceMonth in: query schema: type: string description: Month for which the currency is needed. If not set, the request will return existing currency settings for the advertiser. Must be in the format YYYYMM. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/LookupInvoiceCurrencyResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video - https://www.googleapis.com/auth/display-video-mediaplanning x-google-method-id: displayvideo.advertisers.invoices.lookupInvoiceCurrency /v4/advertisers/{advertisersId}/negativeKeywordLists: get: operationId: advertisersNegativeKeywordListsList summary: Lists negative keyword lists based on a given advertiser id. description: Lists negative keyword lists based on a given advertiser id. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong. required: true - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListNegativeKeywordLists` method. If not specified, the first page of results will be returned. - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListNegativeKeywordListsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.negativeKeywordLists.list post: operationId: advertisersNegativeKeywordListsCreate summary: Creates a new negative keyword list. description: Creates a new negative keyword list. Returns the newly created negative keyword list if successful. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the DV360 advertiser to which the negative keyword list will belong. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/NegativeKeywordList' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/NegativeKeywordList' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.negativeKeywordLists.create /v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListId}: patch: operationId: advertisersNegativeKeywordListsPatch summary: Updates a negative keyword list. description: Updates a negative keyword list. Returns the updated negative keyword list if successful. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the DV360 advertiser to which the negative keyword list belongs. required: true - name: negativeKeywordListId in: path schema: type: string format: int64 description: Output only. The unique ID of the negative keyword list. Assigned by the system. required: true - name: updateMask in: query schema: type: string format: google-fieldmask description: Required. The mask to control which fields to update. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/NegativeKeywordList' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/NegativeKeywordList' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.negativeKeywordLists.patch /v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}: get: operationId: advertisersNegativeKeywordListsGet summary: Gets a negative keyword list given an advertiser ID and a negative keyword list ID. description: Gets a negative keyword list given an advertiser ID and a negative keyword list ID. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs. required: true - name: negativeKeywordListId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the negative keyword list to fetch. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/NegativeKeywordList' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.negativeKeywordLists.get delete: operationId: advertisersNegativeKeywordListsDelete summary: Deletes a negative keyword list given an advertiser ID and a negative keyword list ID. description: Deletes a negative keyword list given an advertiser ID and a negative keyword list ID. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the DV360 advertiser to which the negative keyword list belongs. required: true - name: negativeKeywordListId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the negative keyword list to delete. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Empty' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.negativeKeywordLists.delete /v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords: post: operationId: advertisersNegativeKeywordListsNegativeKeywordsCreate summary: Creates a negative keyword in a negative keyword list. description: Creates a negative keyword in a negative keyword list. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 description: Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. required: true - name: negativeKeywordListId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the parent negative keyword list in which the negative keyword will be created. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/NegativeKeyword' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/NegativeKeyword' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.negativeKeywordLists.negativeKeywords.create /v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:replace: post: operationId: advertisersNegativeKeywordListsNegativeKeywordsReplace summary: Replaces all negative keywords in a single negative keyword list. description: Replaces all negative keywords in a single negative keyword list. The operation will replace the keywords in a negative keyword list with keywords provided in ReplaceNegativeKeywordsRequest.new_negative_keywords. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 description: Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. required: true - name: negativeKeywordListId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the parent negative keyword list to which the negative keywords belong. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReplaceNegativeKeywordsRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ReplaceNegativeKeywordsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.negativeKeywordLists.negativeKeywords.replace /v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords/{negativeKeywordsId}: delete: operationId: advertisersNegativeKeywordListsNegativeKeywordsDelete summary: Deletes a negative keyword from a negative keyword list. description: Deletes a negative keyword from a negative keyword list. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 description: Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. required: true - name: negativeKeywordListId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the parent negative keyword list to which the negative keyword belongs. required: true - name: keywordValue in: path schema: type: string pattern: ^[^/]+$ description: Required. The keyword value of the negative keyword to delete. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Empty' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.negativeKeywordLists.negativeKeywords.delete /v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:bulkEdit: post: operationId: advertisersNegativeKeywordListsNegativeKeywordsBulkEdit summary: Bulk edits negative keywords in a single negative keyword list. description: Bulk edits negative keywords in a single negative keyword list. The operation will delete the negative keywords provided in BulkEditNegativeKeywordsRequest.deleted_negative_keywords and then create the negative keywords provided in BulkEditNegativeKeywordsRequest.created_negative_keywords. This operation is guaranteed to be atomic and will never result in a partial success or partial failure. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 description: Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. required: true - name: negativeKeywordListId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the parent negative keyword list to which the negative keywords belong. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BulkEditNegativeKeywordsRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BulkEditNegativeKeywordsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.negativeKeywordLists.negativeKeywords.bulkEdit /v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords: get: operationId: advertisersNegativeKeywordListsNegativeKeywordsList summary: Lists negative keywords in a negative keyword list. description: Lists negative keywords in a negative keyword list. tags: - Advertisers parameters: - name: advertiserId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. required: true - name: negativeKeywordListId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the parent negative keyword list to which the requested negative keywords belong. required: true - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `keywordValue` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `keywordValue desc`.' - name: filter in: query schema: type: string description: 'Allows filtering by negative keyword fields. Supported syntax: * Filter expressions for negative keywords can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `keywordValue` Examples: * All negative keywords for which the keyword value contains "google": `keywordValue : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListNegativeKeywords` method. If not specified, the first page of results will be returned. - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `1000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListNegativeKeywordsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.advertisers.negativeKeywordLists.negativeKeywords.list /v4/googleAudiences/{googleAudiencesId}: get: operationId: googleAudiencesGet summary: Gets a Google audience. description: Gets a Google audience. tags: - Google Audiences parameters: - name: googleAudienceId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the Google audience to fetch. required: true - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that has access to the fetched Google audience. - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that has access to the fetched Google audience. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAudience' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.googleAudiences.get /v4/googleAudiences: get: operationId: googleAudiencesList summary: Lists Google audiences. description: Lists Google audiences. The order is defined by the order_by parameter. tags: - Google Audiences parameters: - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that has access to the fetched Google audiences. - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that has access to the fetched Google audiences. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `googleAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.' - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListGoogleAudiences` method. If not specified, the first page of results will be returned. - name: filter in: query schema: type: string description: 'Allows filtering by Google audience fields. Supported syntax: * Filter expressions for Google audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All Google audiences for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListGoogleAudiencesResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.googleAudiences.list /v4/partners/{partnersId}: get: operationId: partnersGet summary: Gets a partner. description: Gets a partner. tags: - Partners parameters: - name: partnerId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the partner to fetch. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Partner' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.partners.get /v4/partners: get: operationId: partnersList summary: Lists partners that are accessible to the current user. description: Lists partners that are accessible to the current user. The order is defined by the order_by parameter. tags: - Partners parameters: - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.' - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListPartners` method. If not specified, the first page of results will be returned. - name: filter in: query schema: type: string description: 'Allows filtering by partner fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `entityStatus` Examples: * All active partners: `entityStatus="ENTITY_STATUS_ACTIVE"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListPartnersResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.partners.list /v4/partners/{partnersId}:editAssignedTargetingOptions: post: operationId: partnersEditAssignedTargetingOptions summary: Edits targeting options under a single partner. description: Edits targeting options under a single partner. The operation will delete the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.deleteRequests and then create the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.createRequests . tags: - Partners parameters: - name: partnerId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the partner. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BulkEditPartnerAssignedTargetingOptionsRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BulkEditPartnerAssignedTargetingOptionsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.partners.editAssignedTargetingOptions /v4/partners/{partnersId}/channels: post: operationId: partnersChannelsCreate summary: Creates a new channel. description: Creates a new channel. Returns the newly created channel if successful. tags: - Partners parameters: - name: partnerId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of the partner that owns the created channel. required: true - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that owns the created channel. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Channel' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Channel' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.partners.channels.create get: operationId: partnersChannelsList summary: Lists channels for a partner or advertiser. description: Lists channels for a partner or advertiser. tags: - Partners parameters: - name: partnerId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of the partner that owns the channels. required: true - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: filter in: query schema: type: string description: 'Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned. - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that owns the channels. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListChannelsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.partners.channels.list /v4/partners/{partnersId}/channels/{channelId}: patch: operationId: partnersChannelsPatch summary: Updates a channel. description: Updates a channel. Returns the updated channel if successful. tags: - Partners parameters: - name: partnerId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of the partner that owns the created channel. required: true - name: channelId in: path schema: type: string format: int64 description: Output only. The unique ID of the channel. Assigned by the system. required: true - name: updateMask in: query schema: type: string format: google-fieldmask description: Required. The mask to control which fields to update. - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that owns the created channel. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Channel' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Channel' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.partners.channels.patch /v4/partners/{partnersId}/channels/{channelsId}: get: operationId: partnersChannelsGet summary: Gets a channel for a partner or advertiser. description: Gets a channel for a partner or advertiser. tags: - Partners parameters: - name: partnerId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of the partner that owns the fetched channel. required: true - name: channelId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the channel to fetch. required: true - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that owns the fetched channel. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Channel' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.partners.channels.get /v4/partners/{partnerId}/channels/{channelsId}/sites: post: operationId: partnersChannelsSitesCreate summary: Creates a site in a channel. description: Creates a site in a channel. tags: - Partners parameters: - name: partnerId in: path schema: type: string format: int64 description: The ID of the partner that owns the parent channel. required: true - name: channelId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the parent channel in which the site will be created. required: true - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that owns the parent channel. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Site' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Site' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.partners.channels.sites.create /v4/partners/{partnerId}/channels/{channelsId}/sites:replace: post: operationId: partnersChannelsSitesReplace summary: Replaces all of the sites under a single channel. description: Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors. tags: - Partners parameters: - name: partnerId in: path schema: type: string format: int64 description: The ID of the partner that owns the parent channel. required: true - name: channelId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the parent channel whose sites will be replaced. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReplaceSitesRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ReplaceSitesResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.partners.channels.sites.replace /v4/partners/{partnerId}/channels/{channelsId}/sites/{sitesId}: delete: operationId: partnersChannelsSitesDelete summary: Deletes a site from a channel. description: Deletes a site from a channel. tags: - Partners parameters: - name: partnerId in: path schema: type: string format: int64 description: The ID of the partner that owns the parent channel. required: true - name: channelId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the parent channel to which the site belongs. required: true - name: urlOrAppId in: path schema: type: string pattern: ^[^/]+$ description: Required. The URL or app ID of the site to delete. required: true - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that owns the parent channel. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Empty' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.partners.channels.sites.delete /v4/partners/{partnerId}/channels/{channelsId}/sites:bulkEdit: post: operationId: partnersChannelsSitesBulkEdit summary: Bulk edits sites under a single channel. description: Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites. tags: - Partners parameters: - name: partnerId in: path schema: type: string format: int64 description: The ID of the partner that owns the parent channel. required: true - name: channelId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the parent channel to which the sites belong. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BulkEditSitesRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BulkEditSitesResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.partners.channels.sites.bulkEdit /v4/partners/{partnersId}/channels/{channelsId}/sites: get: operationId: partnersChannelsSitesList summary: Lists sites in a channel. description: Lists sites in a channel. tags: - Partners parameters: - name: partnerId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: The ID of the partner that owns the parent channel. required: true - name: channelId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the parent channel to which the requested sites belong. required: true - name: filter in: query schema: type: string description: 'Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned. - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that owns the parent channel. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListSitesResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.partners.channels.sites.list /v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions: post: operationId: partnersTargetingTypesAssignedTargetingOptionsCreate summary: Assigns a targeting option to a partner. description: Assigns a targeting option to a partner. Returns the assigned targeting option if successful. tags: - Partners parameters: - name: partnerId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the partner. required: true - name: targetingType in: path schema: type: string 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 - TARGETING_TYPE_POI - TARGETING_TYPE_BUSINESS_CHAIN - TARGETING_TYPE_CONTENT_DURATION - TARGETING_TYPE_CONTENT_STREAM_TYPE - TARGETING_TYPE_NATIVE_CONTENT_POSITION - TARGETING_TYPE_OMID - TARGETING_TYPE_AUDIO_CONTENT_TYPE - TARGETING_TYPE_CONTENT_GENRE - TARGETING_TYPE_YOUTUBE_VIDEO - TARGETING_TYPE_YOUTUBE_CHANNEL - TARGETING_TYPE_SESSION_POSITION - TARGETING_TYPE_CONTENT_THEME_EXCLUSION - TARGETING_TYPE_YOUTUBE_CHANNEL_PACK pattern: ^[^/]+$ description: 'Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack.' required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AssignedTargetingOption' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/AssignedTargetingOption' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.partners.targetingTypes.assignedTargetingOptions.create get: operationId: partnersTargetingTypesAssignedTargetingOptionsList summary: Lists the targeting options assigned to a partner. description: Lists the targeting options assigned to a partner. tags: - Partners parameters: - name: partnerId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the partner. required: true - name: targetingType in: path schema: type: string 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 - TARGETING_TYPE_POI - TARGETING_TYPE_BUSINESS_CHAIN - TARGETING_TYPE_CONTENT_DURATION - TARGETING_TYPE_CONTENT_STREAM_TYPE - TARGETING_TYPE_NATIVE_CONTENT_POSITION - TARGETING_TYPE_OMID - TARGETING_TYPE_AUDIO_CONTENT_TYPE - TARGETING_TYPE_CONTENT_GENRE - TARGETING_TYPE_YOUTUBE_VIDEO - TARGETING_TYPE_YOUTUBE_CHANNEL - TARGETING_TYPE_SESSION_POSITION - TARGETING_TYPE_CONTENT_THEME_EXCLUSION - TARGETING_TYPE_YOUTUBE_CHANNEL_PACK pattern: ^[^/]+$ description: 'Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack.' required: true - name: filter in: query schema: type: string description: 'Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resource with ID 123456: `assignedTargetingOptionId="123456"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListPartnerAssignedTargetingOptions` method. If not specified, the first page of results will be returned. - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListPartnerAssignedTargetingOptionsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.partners.targetingTypes.assignedTargetingOptions.list /v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}: get: operationId: partnersTargetingTypesAssignedTargetingOptionsGet summary: Gets a single targeting option assigned to a partner. description: Gets a single targeting option assigned to a partner. tags: - Partners parameters: - name: partnerId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the partner. required: true - name: targetingType in: path schema: type: string 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 - TARGETING_TYPE_POI - TARGETING_TYPE_BUSINESS_CHAIN - TARGETING_TYPE_CONTENT_DURATION - TARGETING_TYPE_CONTENT_STREAM_TYPE - TARGETING_TYPE_NATIVE_CONTENT_POSITION - TARGETING_TYPE_OMID - TARGETING_TYPE_AUDIO_CONTENT_TYPE - TARGETING_TYPE_CONTENT_GENRE - TARGETING_TYPE_YOUTUBE_VIDEO - TARGETING_TYPE_YOUTUBE_CHANNEL - TARGETING_TYPE_SESSION_POSITION - TARGETING_TYPE_CONTENT_THEME_EXCLUSION - TARGETING_TYPE_YOUTUBE_CHANNEL_PACK pattern: ^[^/]+$ description: 'Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack.' required: true - name: assignedTargetingOptionId in: path schema: type: string pattern: ^[^/]+$ description: Required. An identifier unique to the targeting type in this partner that identifies the assigned targeting option being requested. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/AssignedTargetingOption' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.partners.targetingTypes.assignedTargetingOptions.get delete: operationId: partnersTargetingTypesAssignedTargetingOptionsDelete summary: Deletes an assigned targeting option from a partner. description: Deletes an assigned targeting option from a partner. tags: - Partners parameters: - name: partnerId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the partner. required: true - name: targetingType in: path schema: type: string 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 - TARGETING_TYPE_POI - TARGETING_TYPE_BUSINESS_CHAIN - TARGETING_TYPE_CONTENT_DURATION - TARGETING_TYPE_CONTENT_STREAM_TYPE - TARGETING_TYPE_NATIVE_CONTENT_POSITION - TARGETING_TYPE_OMID - TARGETING_TYPE_AUDIO_CONTENT_TYPE - TARGETING_TYPE_CONTENT_GENRE - TARGETING_TYPE_YOUTUBE_VIDEO - TARGETING_TYPE_YOUTUBE_CHANNEL - TARGETING_TYPE_SESSION_POSITION - TARGETING_TYPE_CONTENT_THEME_EXCLUSION - TARGETING_TYPE_YOUTUBE_CHANNEL_PACK pattern: ^[^/]+$ description: 'Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack.' required: true - name: assignedTargetingOptionId in: path schema: type: string pattern: ^[^/]+$ description: Required. The ID of the assigned targeting option to delete. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Empty' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.partners.targetingTypes.assignedTargetingOptions.delete /v4/inventorySources/{inventorySourcesId}:editInventorySourceReadWriteAccessors: post: operationId: inventorySourcesEditInventorySourceReadWriteAccessors summary: Edits read/write accessors of an inventory source. description: Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source. tags: - Inventory Sources parameters: - name: inventorySourceId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of inventory source to update. required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EditInventorySourceReadWriteAccessorsRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/InventorySourceAccessors' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.inventorySources.editInventorySourceReadWriteAccessors /v4/inventorySources: get: operationId: inventorySourcesList summary: Lists inventory sources that are accessible to the current user. description: Lists inventory sources that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results. tags: - Inventory Sources parameters: - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that has access to the inventory source. - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that has access to the inventory source. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.' - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned. - name: filter in: query schema: type: string description: 'Allows filtering by inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `status.entityStatus` * `commitment` * `deliveryMethod` * `rateDetails.rateType` * `exchange` Examples: * All active inventory sources: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListInventorySourcesResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.inventorySources.list post: operationId: inventorySourcesCreate summary: Creates a new inventory source. description: Creates a new inventory source. Returns the newly created inventory source if successful. tags: - Inventory Sources parameters: - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that the request is being made within. - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that the request is being made within. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/InventorySource' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/InventorySource' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.inventorySources.create /v4/inventorySources/{inventorySourcesId}: patch: operationId: inventorySourcesPatch summary: Updates an existing inventory source. description: Updates an existing inventory source. Returns the updated inventory source if successful. tags: - Inventory Sources parameters: - name: inventorySourceId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Output only. The unique ID of the inventory source. Assigned by the system. required: true - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that the request is being made within. - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that the request is being made within. - name: updateMask in: query schema: type: string format: google-fieldmask description: Required. The mask to control which fields to update. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/InventorySource' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/InventorySource' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.inventorySources.patch get: operationId: inventorySourcesGet summary: Gets an inventory source. description: Gets an inventory source. tags: - Inventory Sources parameters: - name: inventorySourceId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the inventory source to fetch. required: true - name: advertiserId in: query schema: type: string format: int64 description: Optional. The ID of the DV360 advertiser to which the fetched inventory source is permissioned. If the user only has access to the advertiser and not the parent partner, use this field to specify the relevant advertiser. - name: partnerId in: query schema: type: string format: int64 description: Required. The ID of the DV360 partner to which the fetched inventory source is permissioned. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/InventorySource' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.inventorySources.get /v4/sdfuploadtasks/operations/{operationsId}: get: operationId: sdfuploadtasksOperationsGet summary: Gets the latest state of an asynchronous SDF download task operation. description: Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds. tags: - SDF Upload Tasks parameters: - name: name in: path schema: type: string pattern: ^sdfuploadtasks/operations/[^/]+$ description: The name of the operation resource. required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Operation' security: - oauth2: - https://www.googleapis.com/auth/display-video - https://www.googleapis.com/auth/doubleclickbidmanager x-google-method-id: displayvideo.sdfuploadtasks.operations.get /v4/combinedAudiences/{combinedAudiencesId}: get: operationId: combinedAudiencesGet summary: Gets a combined audience. description: Gets a combined audience. tags: - Combined Audiences parameters: - name: combinedAudienceId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the combined audience to fetch. required: true - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that has access to the fetched combined audience. - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that has access to the fetched combined audience. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/CombinedAudience' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.combinedAudiences.get /v4/combinedAudiences: get: operationId: combinedAudiencesList summary: Lists combined audiences. description: Lists combined audiences. The order is defined by the order_by parameter. tags: - Combined Audiences parameters: - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that has access to the fetched combined audiences. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `combinedAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.' - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that has access to the fetched combined audiences. - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: filter in: query schema: type: string description: 'Allows filtering by combined audience fields. Supported syntax: * Filter expressions for combined audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All combined audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCombinedAudiences` method. If not specified, the first page of results will be returned. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListCombinedAudiencesResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.combinedAudiences.list /v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}:uploadRules: get: operationId: customBiddingAlgorithmsUploadRules summary: Creates a rules reference object for an AlgorithmRules file. description: Creates a rules reference object for an AlgorithmRules file. The resulting reference object provides a resource path where the AlgorithmRules file should be uploaded. This reference object should be included when creating a new CustomBiddingAlgorithmRules resource. tags: - Custom Bidding Algorithms parameters: - name: customBiddingAlgorithmId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the custom bidding algorithm that owns the rules resource. required: true - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that owns the parent custom bidding algorithm. - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that owns the parent custom bidding algorithm. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/CustomBiddingAlgorithmRulesRef' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.customBiddingAlgorithms.uploadRules /v4/customBiddingAlgorithms: post: operationId: customBiddingAlgorithmsCreate summary: Creates a new custom bidding algorithm. description: Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful. tags: - Custom Bidding Algorithms requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomBiddingAlgorithm' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/CustomBiddingAlgorithm' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.customBiddingAlgorithms.create get: operationId: customBiddingAlgorithmsList summary: Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. description: Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. The order is defined by the order_by parameter. tags: - Custom Bidding Algorithms parameters: - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingAlgorithms` method. If not specified, the first page of results will be returned. - name: filter in: query schema: type: string description: 'Allows filtering by custom bidding algorithm fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `customBiddingAlgorithmType` field must use the `EQUALS (=)` operator. * The `displayName` field must use the `HAS (:)` operator. Supported fields: * `customBiddingAlgorithmType` * `displayName` Examples: * All custom bidding algorithms for which the display name contains "politics": `displayName:"politics"`. * All custom bidding algorithms for which the type is "SCRIPT_BASED": `customBiddingAlgorithmType=SCRIPT_BASED` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.' - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: partnerId in: query schema: type: string format: int64 description: The ID of the DV360 partner that has access to the custom bidding algorithm. - name: advertiserId in: query schema: type: string format: int64 description: The ID of the DV360 advertiser that has access to the custom bidding algorithm. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListCustomBiddingAlgorithmsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.customBiddingAlgorithms.list /v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}:uploadScript: get: operationId: customBiddingAlgorithmsUploadScript summary: Creates a custom bidding script reference object for a script file. description: Creates a custom bidding script reference object for a script file. The resulting reference object provides a resource path to which the script file should be uploaded. This reference object should be included in when creating a new custom bidding script object. tags: - Custom Bidding Algorithms parameters: - name: customBiddingAlgorithmId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the custom bidding algorithm owns the script. required: true - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script. - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that owns the parent custom bidding algorithm. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/CustomBiddingScriptRef' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.customBiddingAlgorithms.uploadScript /v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}: get: operationId: customBiddingAlgorithmsGet summary: Gets a custom bidding algorithm. description: Gets a custom bidding algorithm. tags: - Custom Bidding Algorithms parameters: - name: customBiddingAlgorithmId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the custom bidding algorithm to fetch. required: true - name: partnerId in: query schema: type: string format: int64 description: The ID of the DV360 partner that has access to the custom bidding algorithm. - name: advertiserId in: query schema: type: string format: int64 description: The ID of the DV360 partner that has access to the custom bidding algorithm. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/CustomBiddingAlgorithm' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.customBiddingAlgorithms.get patch: operationId: customBiddingAlgorithmsPatch summary: Updates an existing custom bidding algorithm. description: Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. Requests updating a custom bidding algorithm assigned to a line item will return an error. tags: - Custom Bidding Algorithms parameters: - name: customBiddingAlgorithmId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Output only. The unique ID of the custom bidding algorithm. Assigned by the system. required: true - name: updateMask in: query schema: type: string format: google-fieldmask description: Required. The mask to control which fields to update. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomBiddingAlgorithm' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/CustomBiddingAlgorithm' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.customBiddingAlgorithms.patch /v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules: post: operationId: customBiddingAlgorithmsRulesCreate summary: Creates a new rules resource. description: Creates a new rules resource. Returns the newly created rules resource if successful. Requests creating a custom bidding rules resource under an algorithm assigned to a line item will return an error. tags: - Custom Bidding Algorithms parameters: - name: customBiddingAlgorithmId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the custom bidding algorithm that owns the rules resource. required: true - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this rules resource. - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that owns the parent custom bidding algorithm. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomBiddingAlgorithmRules' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/CustomBiddingAlgorithmRules' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.customBiddingAlgorithms.rules.create get: operationId: customBiddingAlgorithmsRulesList summary: Lists rules resources that belong to the given algorithm. description: Lists rules resources that belong to the given algorithm. The order is defined by the order_by parameter. tags: - Custom Bidding Algorithms parameters: - name: customBiddingAlgorithmId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the custom bidding algorithm that owns the rules resource. required: true - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingAlgorithmRules` method. If not specified, the first page of results will be returned. - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that owns the parent custom bidding algorithm. - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that owns the parent custom bidding algorithm. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `createTime desc` (default) The default sorting order is descending. To specify ascending order for a field, the suffix "desc" should be removed. Example: `createTime`.' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListCustomBiddingAlgorithmRulesResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.customBiddingAlgorithms.rules.list /v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules/{rulesId}: get: operationId: customBiddingAlgorithmsRulesGet summary: Retrieves a rules resource. description: Retrieves a rules resource. tags: - Custom Bidding Algorithms parameters: - name: customBiddingAlgorithmId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the custom bidding algorithm that owns the rules resource. required: true - name: customBiddingAlgorithmRulesId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the rules resource to fetch. required: true - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that owns the parent custom bidding algorithm. - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that owns the parent custom bidding algorithm. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/CustomBiddingAlgorithmRules' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.customBiddingAlgorithms.rules.get /v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts: post: operationId: customBiddingAlgorithmsScriptsCreate summary: Creates a new custom bidding script. description: Creates a new custom bidding script. Returns the newly created script if successful. Requests creating a custom bidding script under an algorithm assigned to a line item will return an error. tags: - Custom Bidding Algorithms parameters: - name: customBiddingAlgorithmId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the custom bidding algorithm that owns the script. required: true - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script. - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that owns the parent custom bidding algorithm. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomBiddingScript' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/CustomBiddingScript' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.customBiddingAlgorithms.scripts.create get: operationId: customBiddingAlgorithmsScriptsList summary: Lists custom bidding scripts that belong to the given algorithm. description: Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter. tags: - Custom Bidding Algorithms parameters: - name: customBiddingAlgorithmId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the custom bidding algorithm owns the script. required: true - name: pageSize in: query schema: type: integer format: int32 description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - name: pageToken in: query schema: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingScripts` method. If not specified, the first page of results will be returned. - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that owns the parent custom bidding algorithm. - name: orderBy in: query schema: type: string description: 'Field by which to sort the list. Acceptable values are: * `createTime desc` (default) The default sorting order is descending. To specify ascending order for a field, the suffix "desc" should be removed. Example: `createTime`.' - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListCustomBiddingScriptsResponse' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.customBiddingAlgorithms.scripts.list /v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts/{scriptsId}: get: operationId: customBiddingAlgorithmsScriptsGet summary: Gets a custom bidding script. description: Gets a custom bidding script. tags: - Custom Bidding Algorithms parameters: - name: customBiddingAlgorithmId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the custom bidding algorithm owns the script. required: true - name: customBiddingScriptId in: path schema: type: string format: int64 pattern: ^[^/]+$ description: Required. The ID of the custom bidding script to fetch. required: true - name: advertiserId in: query schema: type: string format: int64 description: The ID of the advertiser that owns the parent custom bidding algorithm. - name: partnerId in: query schema: type: string format: int64 description: The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/CustomBiddingScript' security: - oauth2: - https://www.googleapis.com/auth/display-video x-google-method-id: displayvideo.customBiddingAlgorithms.scripts.get components: schemas: ActiveViewVideoViewabilityMetricConfig: type: object description: Configuration for custom Active View video viewability metrics. properties: minimumVolume: type: string description: 'Required. The minimum percentage of the video ad''s volume required in order for an impression to be recorded. Allowed values — `VIDEO_VOLUME_PERCENT_UNSPECIFIED`: Value is not specified or is unknown in this version.; `VIDEO_VOLUME_PERCENT_0`: 0% volume.; `VIDEO_VOLUME_PERCENT_10`: 10% volume.' enum: - VIDEO_VOLUME_PERCENT_UNSPECIFIED - VIDEO_VOLUME_PERCENT_0 - VIDEO_VOLUME_PERCENT_10 minimumQuartile: type: string description: 'The minimum visible video duration required, based on the video quartiles, in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first). Allowed values — `VIDEO_DURATION_QUARTILE_UNSPECIFIED`: Value is not specified or is unknown in this version.; `VIDEO_DURATION_QUARTILE_NONE`: No quartile value.; `VIDEO_DURATION_QUARTILE_FIRST`: First quartile.; `VIDEO_DURATION_QUARTILE_SECOND`: Second quartile (midpoint).; `VIDEO_DURATION_QUARTILE_THIRD`: Third quartile.; `VIDEO_DURATION_QUARTILE_FOURTH`: Fourth quartile (completion).' 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 minimumDuration: type: string description: 'The minimum visible video duration required (in seconds) in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first). Allowed values — `VIDEO_DURATION_UNSPECIFIED`: Value is not specified or is unknown in this version.; `VIDEO_DURATION_SECONDS_NONE`: No duration value.; `VIDEO_DURATION_SECONDS_0`: 0 seconds.; `VIDEO_DURATION_SECONDS_1`: 1 second.; `VIDEO_DURATION_SECONDS_2`: 2 seconds.; `VIDEO_DURATION_SECONDS_3`: 3 seconds.; `VIDEO_DURATION_SECONDS_4`: 4 seconds.; `VIDEO_DURATION_SECONDS_5`: 5 seconds.; `VIDEO_DURATION_SECONDS_6`: 6 seconds.; `VIDEO_DURATION_SECONDS_7`: 7 seconds.; `VIDEO_DURATION_SECONDS_8`: 8 seconds.; `VIDEO_DURATION_SECONDS_9`: 9 seconds.; `VIDEO_DURATION_SECONDS_10`: 10 seconds.; `VIDEO_DURATION_SECONDS_11`: 11 seconds.; `VIDEO_DURATION_SECONDS_12`: 12 seconds.; `VIDEO_DURATION_SECONDS_13`: 13 seconds.; `VIDEO_DURATION_SECONDS_14`: 14 seconds.; `VIDEO_DURATION_SECONDS_15`: 15 seconds.; `VIDEO_DURATION_SECONDS_30`: 30 seconds.; `VIDEO_DURATION_SECONDS_45`: 45 seconds.; `VIDEO_DURATION_SECONDS_60`: 60 seconds.' 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 displayName: type: string description: Required. The display name of the custom metric. minimumViewability: type: string description: 'Required. The minimum percentage of the video ad''s pixels visible on the screen in order for an impression to be recorded. Allowed values — `VIEWABILITY_PERCENT_UNSPECIFIED`: Value is not specified or is unknown in this version.; `VIEWABILITY_PERCENT_0`: 0% viewable.; `VIEWABILITY_PERCENT_25`: 25% viewable.; `VIEWABILITY_PERCENT_50`: 50% viewable.; `VIEWABILITY_PERCENT_75`: 75% viewable.; `VIEWABILITY_PERCENT_100`: 100% viewable.' enum: - VIEWABILITY_PERCENT_UNSPECIFIED - VIEWABILITY_PERCENT_0 - VIEWABILITY_PERCENT_25 - VIEWABILITY_PERCENT_50 - VIEWABILITY_PERCENT_75 - VIEWABILITY_PERCENT_100 AdAsset: type: object description: A single ad asset. properties: adAssetType: type: string description: 'Required. The type of the ad asset. Allowed values — `AD_ASSET_TYPE_UNSPECIFIED`: The ad asset type is unspecified.; `AD_ASSET_TYPE_IMAGE`: The ad asset is a YouTube/DemandGen image.; `AD_ASSET_TYPE_YOUTUBE_VIDEO`: The ad asset is a YouTube video.' enum: - AD_ASSET_TYPE_UNSPECIFIED - AD_ASSET_TYPE_IMAGE - AD_ASSET_TYPE_YOUTUBE_VIDEO youtubeVideoAsset: $ref: '#/components/schemas/YoutubeVideoAsset' adAssetId: type: string format: int64 description: Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad. readOnly: true name: type: string description: Identifier. The resource name of the ad asset. syntheticContentAttestationStatus: type: string description: 'Optional. Whether to add a label to the asset as created or edited using AI when served in regions with local AI labeling regulations. Allowed values — `SYNTHETIC_CONTENT_ATTESTATION_STATUS_UNSPECIFIED`: No attestation has been provided.; `NOT_SYNTHETIC`: Attested as not created or edited using AI.; `IS_SYNTHETIC`: Attested as created or edited using AI.' enum: - SYNTHETIC_CONTENT_ATTESTATION_STATUS_UNSPECIFIED - NOT_SYNTHETIC - IS_SYNTHETIC entityStatus: type: string description: 'Output only. The entity status of the ad asset. Allowed values — `ENTITY_STATUS_UNSPECIFIED`: Default value when status is not specified or is unknown in this version.; `ENTITY_STATUS_ACTIVE`: The entity is enabled to bid and spend budget.; `ENTITY_STATUS_ARCHIVED`: The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.; `ENTITY_STATUS_DRAFT`: The entity is under draft. Bidding and budget spending are disabled.; `ENTITY_STATUS_PAUSED`: Bidding and budget spending are paused for the entity.; `ENTITY_STATUS_SCHEDULED_FOR_DELETION`: The entity is scheduled for deletion.' enum: - ENTITY_STATUS_UNSPECIFIED - ENTITY_STATUS_ACTIVE - ENTITY_STATUS_ARCHIVED - ENTITY_STATUS_DRAFT - ENTITY_STATUS_PAUSED - ENTITY_STATUS_SCHEDULED_FOR_DELETION readOnly: true AdGroup: type: object description: A single ad group associated with a line item. properties: adGroupFormat: type: string description: 'Required. Immutable. The format of the ads in the ad group. Allowed values — `AD_GROUP_FORMAT_UNSPECIFIED`: Format value is not specified or is unknown in this version.; `AD_GROUP_FORMAT_IN_STREAM`: In-stream ads.; `AD_GROUP_FORMAT_VIDEO_DISCOVERY`: In-feed ads.; `AD_GROUP_FORMAT_BUMPER`: Bumper ads.; `AD_GROUP_FORMAT_NON_SKIPPABLE_IN_STREAM`: Non-skippable in-stream ads.; `AD_GROUP_FORMAT_AUDIO`: Non-skippable in-stream audio ads.; `AD_GROUP_FORMAT_RESPONSIVE`: Responsive ads.; `AD_GROUP_FORMAT_REACH`: [Effective reach ad groups] (https://support.google.com/displayvideo/answer/9173684), including in-stream and bumper ads.; `AD_GROUP_FORMAT_MASTHEAD`: Masthead Ad that is surfaced on the top slot on the YouTube homepage.; `AD_GROUP_FORMAT_DEMAND_GEN`: Demand Gen ads.' enum: - AD_GROUP_FORMAT_UNSPECIFIED - AD_GROUP_FORMAT_IN_STREAM - AD_GROUP_FORMAT_VIDEO_DISCOVERY - AD_GROUP_FORMAT_BUMPER - AD_GROUP_FORMAT_NON_SKIPPABLE_IN_STREAM - AD_GROUP_FORMAT_AUDIO - AD_GROUP_FORMAT_RESPONSIVE - AD_GROUP_FORMAT_REACH - AD_GROUP_FORMAT_MASTHEAD - AD_GROUP_FORMAT_DEMAND_GEN advertiserId: type: string format: int64 description: Output only. The unique ID of the advertiser the ad group belongs to. readOnly: true adGroupId: type: string format: int64 description: Output only. The unique ID of the ad group. Assigned by the system. readOnly: true entityStatus: type: string description: 'Required. Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group''s parent line item is not active, the ad group can''t spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. Allowed values — `ENTITY_STATUS_UNSPECIFIED`: Default value when status is not specified or is unknown in this version.; `ENTITY_STATUS_ACTIVE`: The entity is enabled to bid and spend budget.; `ENTITY_STATUS_ARCHIVED`: The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.; `ENTITY_STATUS_DRAFT`: The entity is under draft. Bidding and budget spending are disabled.; `ENTITY_STATUS_PAUSED`: Bidding and budget spending are paused for the entity.; `ENTITY_STATUS_SCHEDULED_FOR_DELETION`: The entity is scheduled for deletion.' enum: - ENTITY_STATUS_UNSPECIFIED - ENTITY_STATUS_ACTIVE - ENTITY_STATUS_ARCHIVED - ENTITY_STATUS_DRAFT - ENTITY_STATUS_PAUSED - ENTITY_STATUS_SCHEDULED_FOR_DELETION adGroupInventoryControl: $ref: '#/components/schemas/AdGroupInventoryControl' bidStrategy: $ref: '#/components/schemas/BiddingStrategy' productFeedData: $ref: '#/components/schemas/ProductFeedData' targetingExpansion: $ref: '#/components/schemas/TargetingExpansionConfig' displayName: type: string description: Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes. name: type: string description: Output only. Identifier. The resource name of the ad group. readOnly: true lineItemId: type: string format: int64 description: Required. Immutable. The unique ID of the line item that the ad group belongs to. AdGroupAd: type: object description: A single ad associated with an ad group. properties: mastheadAd: $ref: '#/components/schemas/MastheadAd' demandGenProductAd: $ref: '#/components/schemas/DemandGenProductAd' adGroupId: type: string format: int64 description: Required. Immutable. The unique ID of the ad group that the ad belongs to. inStreamAd: $ref: '#/components/schemas/InStreamAd' adGroupAdId: type: string format: int64 description: Output only. The unique ID of the ad. Assigned by the system. readOnly: true entityStatus: type: string description: 'Required. The entity status of the ad. Allowed values — `ENTITY_STATUS_UNSPECIFIED`: Default value when status is not specified or is unknown in this version.; `ENTITY_STATUS_ACTIVE`: The entity is enabled to bid and spend budget.; `ENTITY_STATUS_ARCHIVED`: The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.; `ENTITY_STATUS_DRAFT`: The entity is under draft. Bidding and budget spending are disabled.; `ENTITY_STATUS_PAUSED`: Bidding and budget spending are paused for the entity.; `ENTITY_STATUS_SCHEDULED_FOR_DELETION`: The entity is scheduled for deletion.' enum: - ENTITY_STATUS_UNSPECIFIED - ENTITY_STATUS_ACTIVE - ENTITY_STATUS_ARCHIVED - ENTITY_STATUS_DRAFT - ENTITY_STATUS_PAUSED - ENTITY_STATUS_SCHEDULED_FOR_DELETION adPolicy: $ref: '#/components/schemas/AdPolicy' displayVideoSourceAd: $ref: '#/components/schemas/DisplayVideoSourceAd' adUrls: type: array description: Output only. List of URLs used by the ad. readOnly: true items: $ref: '#/components/schemas/AdUrl' dcmTrackingInfo: $ref: '#/components/schemas/DcmTrackingInfo' videoDiscoverAd: $ref: '#/components/schemas/VideoDiscoveryAd' demandGenCarouselAd: $ref: '#/components/schemas/DemandGenCarouselAd' demandGenVideoAd: $ref: '#/components/schemas/DemandGenVideoAd' demandGenImageAd: $ref: '#/components/schemas/DemandGenImageAd' advertiserId: type: string format: int64 description: Output only. The unique ID of the advertiser the ad belongs to. readOnly: true bumperAd: $ref: '#/components/schemas/BumperAd' audioAd: $ref: '#/components/schemas/AudioAd' nonSkippableAd: $ref: '#/components/schemas/NonSkippableAd' displayName: type: string description: Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes. videoPerformanceAd: $ref: '#/components/schemas/VideoPerformanceAd' name: type: string description: Output only. The resource name of the ad. readOnly: true AdGroupAssignedTargetingOption: type: object description: Wrapper object associating an AssignedTargetingOption resource and the ad group it is assigned to. properties: adGroupId: type: string format: int64 description: The ID of the ad group the assigned targeting option is assigned to. assignedTargetingOption: $ref: '#/components/schemas/AssignedTargetingOption' AdGroupInventoryControl: type: object description: The inventory control of the ad group. properties: adGroupInventoryStrategy: type: string description: 'The inventory strategy. Allowed values — `AD_GROUP_INVENTORY_STRATEGY_UNSPECIFIED`: Not specified or unknown.; `AD_GROUP_INVENTORY_STRATEGY_ALL_GOOGLE_AND_DISPLAY_NETWORK_INVENTORY`: The ad group is opted-in to all Google and Display Network inventory.; `AD_GROUP_INVENTORY_STRATEGY_ALL_GOOGLE_INVENTORY`: The ad group is opted-in to all Google inventory.' enum: - AD_GROUP_INVENTORY_STRATEGY_UNSPECIFIED - AD_GROUP_INVENTORY_STRATEGY_ALL_GOOGLE_AND_DISPLAY_NETWORK_INVENTORY - AD_GROUP_INVENTORY_STRATEGY_ALL_GOOGLE_INVENTORY selectedInventories: $ref: '#/components/schemas/SelectedInventories' AdPolicy: type: object description: A single ad policy associated with an ad group ad. properties: adPolicyApprovalStatus: type: string description: 'The policy approval status of an ad, indicating the approval decision. Allowed values — `AD_POLICY_APPROVAL_STATUS_UNKNOWN`: Unknown or not specified.; `DISAPPROVED`: Will not serve.; `APPROVED_LIMITED`: Will serve with restrictions.; `APPROVED`: Will serve without restrictions.; `AREA_OF_INTEREST_ONLY`: Will not serve in targeted countries, but may serve for users who are searching for information about the targeted countries.' enum: - AD_POLICY_APPROVAL_STATUS_UNKNOWN - DISAPPROVED - APPROVED_LIMITED - APPROVED - AREA_OF_INTEREST_ONLY adPolicyReviewStatus: type: string description: 'The policy review status of an ad, indicating where in the review process the ad is currently. Allowed values — `AD_POLICY_REVIEW_STATUS_UNKNOWN`: Unknown or not specified.; `REVIEW_IN_PROGRESS`: Currently under review.; `REVIEWED`: Primary review complete. Other reviews may still be in progress.; `UNDER_APPEAL`: Resubmitted for approval or a policy decision has been appealed.; `ELIGIBLE_MAY_SERVE`: Deemed eligible and may be serving. Further review could still follow.' enum: - AD_POLICY_REVIEW_STATUS_UNKNOWN - REVIEW_IN_PROGRESS - REVIEWED - UNDER_APPEAL - ELIGIBLE_MAY_SERVE adPolicyTopicEntry: type: array description: The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues. items: $ref: '#/components/schemas/AdPolicyTopicEntry' AdPolicyCriterionRestriction: type: object description: Represents a country restriction. properties: countryLabel: type: string description: Localized name for the country. May be empty. countryCriterionId: type: string format: int64 description: The country criterion id. AdPolicyTopicAppealInfo: type: object description: Information on how to appeal a policy decision. properties: appealType: type: string description: 'Whether the decision can be appealed through a self-service appeal or an appeal form. Allowed values — `AD_POLICY_APPEAL_TYPE_UNKNOWN`: Unknown or not specified.; `SELF_SERVICE_APPEAL`: The decision can be appealed through a self-service appeal.; `APPEAL_FORM`: The decision can be appealed using an appeal form.' enum: - AD_POLICY_APPEAL_TYPE_UNKNOWN - SELF_SERVICE_APPEAL - APPEAL_FORM appealFormLink: type: string description: Only available when appeal_type is `APPEAL_FORM`. AdPolicyTopicConstraint: type: object description: Details on ad serving constraints. properties: certificateMissingCountryList: $ref: '#/components/schemas/AdPolicyTopicConstraintAdPolicyCountryConstraintList' certificateDomainMismatchCountryList: $ref: '#/components/schemas/AdPolicyTopicConstraintAdPolicyCountryConstraintList' globalCertificateMissing: $ref: '#/components/schemas/AdPolicyTopicConstraintAdPolicyGlobalCertificateMissingConstraint' requestCertificateFormLink: type: string description: Link to the form to request a certificate for the constraint. resellerConstraint: $ref: '#/components/schemas/AdPolicyTopicConstraintAdPolicyResellerConstraint' countryConstraint: $ref: '#/components/schemas/AdPolicyTopicConstraintAdPolicyCountryConstraintList' globalCertificateDomainMismatch: $ref: '#/components/schemas/AdPolicyTopicConstraintAdPolicyGlobalCertificateDomainMismatchConstraint' AdPolicyTopicConstraintAdPolicyCountryConstraintList: type: object description: A list of countries where the ad cannot serve due to policy constraints. properties: countries: type: array description: Countries where the ad cannot serve. items: $ref: '#/components/schemas/AdPolicyCriterionRestriction' AdPolicyTopicConstraintAdPolicyGlobalCertificateDomainMismatchConstraint: type: object description: Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. AdPolicyTopicConstraintAdPolicyGlobalCertificateMissingConstraint: type: object description: Certificate is required to serve in any country. AdPolicyTopicConstraintAdPolicyResellerConstraint: type: object description: Policy topic was constrained due to disapproval of the website for reseller purposes. AdPolicyTopicEntry: type: object description: An entry describing how an ad has been identified as relating to an ad policy. properties: policyLabel: type: string description: Localized label text for policy. Examples include "Trademarks in text", "Contains Alcohol", etc. policyTopicDescription: type: string description: A short summary description of the policy topic. policyDecisionType: type: string description: 'The source of the policy decision. Allowed values — `AD_POLICY_DECISION_TYPE_UNKNOWN`: Unknown or not specified.; `PURSUANT_TO_NOTICE`: The decision is from a legal notice, court order, or trademark content owner complaint, etc.; `GOOGLE_INVESTIGATION`: The decision is from a Google-owned investigation.' enum: - AD_POLICY_DECISION_TYPE_UNKNOWN - PURSUANT_TO_NOTICE - GOOGLE_INVESTIGATION policyTopic: type: string description: The policy topic. Examples include "TRADEMARKS", "ALCOHOL", etc. helpCenterLink: type: string description: Ad policy help center link for the policy topic. appealInfo: $ref: '#/components/schemas/AdPolicyTopicAppealInfo' policyTopicEvidences: type: array description: The evidence used in the policy decision. items: $ref: '#/components/schemas/AdPolicyTopicEvidence' policyTopicConstraints: type: array description: The serving constraints relevant to the policy decision. items: $ref: '#/components/schemas/AdPolicyTopicConstraint' policyTopicType: type: string description: 'How ad serving will be affected due to the relation to the ad policy topic. Allowed values — `AD_POLICY_TOPIC_ENTRY_TYPE_UNKNOWN`: Unknown or not specified.; `PROHIBITED`: The resource will not serve.; `FULLY_LIMITED`: The resource will not serve in all targeted countries.; `LIMITED`: The resource cannot serve in some countries.; `DESCRIPTIVE`: The resource can serve.; `BROADENING`: The resource can serve, and may serve beyond normal coverage.; `AREA_OF_INTEREST_ONLY`: The resource is constrained for all targeted countries, but may serve for users who are searching for information about the targeted countries.' enum: - AD_POLICY_TOPIC_ENTRY_TYPE_UNKNOWN - PROHIBITED - FULLY_LIMITED - LIMITED - DESCRIPTIVE - BROADENING - AREA_OF_INTEREST_ONLY policyEnforcementMeans: type: string description: 'The policy enforcement means used in the policy review. Allowed values — `AD_POLICY_ENFORCEMENT_MEANS_UNKNOWN`: Unknown or not specified.; `AUTOMATED`: The enforcement process was fully automated.; `HUMAN_REVIEW`: A human was partially or fully involved in the decision enforcement process.' enum: - AD_POLICY_ENFORCEMENT_MEANS_UNKNOWN - AUTOMATED - HUMAN_REVIEW AdPolicyTopicEvidence: type: object description: Evidence information used in the policy decision. properties: destinationNotWorking: $ref: '#/components/schemas/AdPolicyTopicEvidenceDestinationNotWorking' regionalRequirements: $ref: '#/components/schemas/AdPolicyTopicEvidenceRegionalRequirements' languageCode: type: string description: The language the ad was detected to be written in. This field uses IETF language tags, such as "en-US". destinationMismatch: $ref: '#/components/schemas/AdPolicyTopicEvidenceDestinationMismatch' counterfeit: $ref: '#/components/schemas/AdPolicyTopicEvidenceCounterfeit' textList: $ref: '#/components/schemas/AdPolicyTopicEvidenceTextList' httpCode: type: integer format: int32 description: HTTP code returned when the final URL was crawled. destinationTextList: $ref: '#/components/schemas/AdPolicyTopicEvidenceDestinationTextList' legalRemoval: $ref: '#/components/schemas/AdPolicyTopicEvidenceLegalRemoval' websiteList: $ref: '#/components/schemas/AdPolicyTopicEvidenceWebsiteList' trademark: $ref: '#/components/schemas/AdPolicyTopicEvidenceTrademark' AdPolicyTopicEvidenceCounterfeit: type: object description: Details on the counterfeit enforcement that caused a policy violation. properties: owners: type: array description: The content or product owners that made a complaint. items: type: string AdPolicyTopicEvidenceDestinationMismatch: type: object description: Details on a mismatch between destination URL types. properties: uriTypes: type: array description: 'The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch.' items: type: string enum: - AD_POLICY_TOPIC_EVIDENCE_DESTINATION_MISMATCH_URL_TYPE_UNKNOWN - DISPLAY_URL - FINAL_URL - FINAL_MOBILE_URL - TRACKING_URL - MOBILE_TRACKING_URL description: 'Allowed values — `AD_POLICY_TOPIC_EVIDENCE_DESTINATION_MISMATCH_URL_TYPE_UNKNOWN`: Not specified or unknown.; `DISPLAY_URL`: The display URL.; `FINAL_URL`: The final URL.; `FINAL_MOBILE_URL`: The final mobile URL.; `TRACKING_URL`: The tracking URL.; `MOBILE_TRACKING_URL`: The mobile tracking URL.' AdPolicyTopicEvidenceDestinationNotWorking: type: object description: Details for on HTTP or DNS errors related to the ad destination. properties: httpErrorCode: type: string format: int64 description: The HTTP error code. expandedUri: type: string description: The full URL that didn't work. lastCheckedTime: type: string format: google-datetime description: The last time the error was seen when navigating to URL. dnsErrorType: type: string description: 'The type of DNS error. Allowed values — `AD_POLICY_TOPIC_EVIDENCE_DESTINATION_NOT_WORKING_DNS_ERROR_TYPE_UNKNOWN`: Not specified or unknown.; `HOSTNAME_NOT_FOUND`: Host name not found in DNS when fetching landing page.; `GOOGLE_CRAWLER_DNS_ISSUE`: Google could not crawl the landing page when communicating with DNS.' enum: - AD_POLICY_TOPIC_EVIDENCE_DESTINATION_NOT_WORKING_DNS_ERROR_TYPE_UNKNOWN - HOSTNAME_NOT_FOUND - GOOGLE_CRAWLER_DNS_ISSUE device: type: string description: 'The device where visiting the URL resulted in the error. Allowed values — `AD_POLICY_TOPIC_EVIDENCE_DESTINATION_NOT_WORKING_DEVICE_TYPE_UNKNOWN`: Not specified or unknown.; `DESKTOP`: Desktop device.; `ANDROID`: Android device.; `IOS`: iOS device.' enum: - AD_POLICY_TOPIC_EVIDENCE_DESTINATION_NOT_WORKING_DEVICE_TYPE_UNKNOWN - DESKTOP - ANDROID - IOS AdPolicyTopicEvidenceDestinationTextList: type: object description: A list of destination text that violated the policy. properties: destinationTexts: type: array description: Destination text that caused the policy finding. items: type: string AdPolicyTopicEvidenceLegalRemoval: type: object description: Legal related regulation enforcement, either from DMCA or local legal regulation. properties: restrictedUris: type: array description: The urls restricted due to the legal removal. items: type: string complaintType: type: string description: 'The type of complaint causing the legal removal. Allowed values — `AD_POLICY_TOPIC_EVIDENCE_LEGAL_REMOVAL_COMPLAINT_TYPE_UNKNOWN`: Not specified or unknown.; `COPYRIGHT`: Copyright. Only applies to DMCA.; `COURT_ORDER`: Court order. Only applies to local legal.; `LOCAL_LEGAL`: Local legal regulation. Only applies to local legal.' enum: - AD_POLICY_TOPIC_EVIDENCE_LEGAL_REMOVAL_COMPLAINT_TYPE_UNKNOWN - COPYRIGHT - COURT_ORDER - LOCAL_LEGAL dmca: $ref: '#/components/schemas/AdPolicyTopicEvidenceLegalRemovalDmca' localLegal: $ref: '#/components/schemas/AdPolicyTopicEvidenceLegalRemovalLocalLegal' countryRestrictions: type: array description: The countries restricted due to the legal removal. items: $ref: '#/components/schemas/AdPolicyCriterionRestriction' AdPolicyTopicEvidenceLegalRemovalDmca: type: object description: DMCA complaint details. properties: complainant: type: string description: The entity who made the legal complaint. AdPolicyTopicEvidenceLegalRemovalLocalLegal: type: object description: Local legal regulation details. properties: lawType: type: string description: Type of law for the legal notice. AdPolicyTopicEvidenceRegionalRequirements: type: object description: Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement. properties: regionalRequirementsEntries: type: array description: List of regional requirements. items: $ref: '#/components/schemas/AdPolicyTopicEvidenceRegionalRequirementsRegionalRequirementsEntry' AdPolicyTopicEvidenceRegionalRequirementsRegionalRequirementsEntry: type: object description: Policy level regional legal violation details. properties: legalPolicy: type: string description: The legal policy that is being violated. countryRestrictions: type: array description: The countries restricted due to the legal policy. items: $ref: '#/components/schemas/AdPolicyCriterionRestriction' AdPolicyTopicEvidenceTextList: type: object description: A list of fragments of text that violated the policy. properties: texts: type: array description: The fragments of text from the resource that caused the policy finding. items: type: string AdPolicyTopicEvidenceTrademark: type: object description: Trademark terms that caused a policy violation. properties: owner: type: string description: The trademark content owner. term: type: string description: The trademark term. countryRestrictions: type: array description: Countries where the policy violation is relevant. items: $ref: '#/components/schemas/AdPolicyCriterionRestriction' AdPolicyTopicEvidenceWebsiteList: type: object description: A list of websites that violated the policy. properties: websites: type: array description: Websites that caused the policy finding. items: type: string AdUrl: type: object description: Additional URLs related to the ad, including beacons. properties: type: type: string description: 'The type of the Ad URL. Allowed values — `AD_URL_TYPE_UNSPECIFIED`: Unknown or unspecified.; `AD_URL_TYPE_BEACON_IMPRESSION`: A 1x1 tracking pixel to ping when an impression of a creative is delivered.; `AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION`: Expandable DCM impression beacon. At serving time, it is expanded to several beacons.; `AD_URL_TYPE_BEACON_CLICK`: Tracking URL to ping when the click event is triggered.; `AD_URL_TYPE_BEACON_SKIP`: Tracking URL to ping when the skip event is triggered.' enum: - AD_URL_TYPE_UNSPECIFIED - AD_URL_TYPE_BEACON_IMPRESSION - AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION - AD_URL_TYPE_BEACON_CLICK - AD_URL_TYPE_BEACON_SKIP url: type: string description: The URL string value. Adloox: type: object description: Details of Scope3 (previously known as Adloox) brand safety settings. properties: illegalDrugsTobaccoEcigarettesVapingAlcoholContent: type: string description: 'Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. Allowed values — `GARM_RISK_EXCLUSION_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any GARM risk exclusion option.; `GARM_RISK_EXCLUSION_FLOOR`: Exclude floor risk.; `GARM_RISK_EXCLUSION_HIGH`: Exclude high and floor risk.; `GARM_RISK_EXCLUSION_MEDIUM`: Exclude medium, high, and floor risk.; `GARM_RISK_EXCLUSION_LOW`: Exclude all levels of risk (low, medium, high and floor).' enum: - GARM_RISK_EXCLUSION_UNSPECIFIED - GARM_RISK_EXCLUSION_FLOOR - GARM_RISK_EXCLUSION_HIGH - GARM_RISK_EXCLUSION_MEDIUM - GARM_RISK_EXCLUSION_LOW misinformationContent: type: string description: 'Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. Allowed values — `GARM_RISK_EXCLUSION_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any GARM risk exclusion option.; `GARM_RISK_EXCLUSION_FLOOR`: Exclude floor risk.; `GARM_RISK_EXCLUSION_HIGH`: Exclude high and floor risk.; `GARM_RISK_EXCLUSION_MEDIUM`: Exclude medium, high, and floor risk.; `GARM_RISK_EXCLUSION_LOW`: Exclude all levels of risk (low, medium, high and floor).' enum: - GARM_RISK_EXCLUSION_UNSPECIFIED - GARM_RISK_EXCLUSION_FLOOR - GARM_RISK_EXCLUSION_HIGH - GARM_RISK_EXCLUSION_MEDIUM - GARM_RISK_EXCLUSION_LOW terrorismContent: type: string description: 'Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. Allowed values — `GARM_RISK_EXCLUSION_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any GARM risk exclusion option.; `GARM_RISK_EXCLUSION_FLOOR`: Exclude floor risk.; `GARM_RISK_EXCLUSION_HIGH`: Exclude high and floor risk.; `GARM_RISK_EXCLUSION_MEDIUM`: Exclude medium, high, and floor risk.; `GARM_RISK_EXCLUSION_LOW`: Exclude all levels of risk (low, medium, high and floor).' enum: - GARM_RISK_EXCLUSION_UNSPECIFIED - GARM_RISK_EXCLUSION_FLOOR - GARM_RISK_EXCLUSION_HIGH - GARM_RISK_EXCLUSION_MEDIUM - GARM_RISK_EXCLUSION_LOW displayIabViewability: type: string description: 'Optional. IAB viewability threshold for display ads. Allowed values — `DISPLAY_IAB_VIEWABILITY_UNSPECIFIED`: Default value when not specified or is unknown in this version.; `DISPLAY_IAB_VIEWABILITY_10`: 10%+ in view (IAB display viewability standard).; `DISPLAY_IAB_VIEWABILITY_20`: 20%+ in view (IAB display viewability standard).; `DISPLAY_IAB_VIEWABILITY_35`: 35%+ in view (IAB display viewability standard).; `DISPLAY_IAB_VIEWABILITY_50`: 50%+ in view (IAB display viewability standard).; `DISPLAY_IAB_VIEWABILITY_75`: 75%+ in view (IAB display viewability standard).' enum: - DISPLAY_IAB_VIEWABILITY_UNSPECIFIED - DISPLAY_IAB_VIEWABILITY_10 - DISPLAY_IAB_VIEWABILITY_20 - DISPLAY_IAB_VIEWABILITY_35 - DISPLAY_IAB_VIEWABILITY_50 - DISPLAY_IAB_VIEWABILITY_75 adultExplicitSexualContent: type: string description: 'Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. Allowed values — `GARM_RISK_EXCLUSION_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any GARM risk exclusion option.; `GARM_RISK_EXCLUSION_FLOOR`: Exclude floor risk.; `GARM_RISK_EXCLUSION_HIGH`: Exclude high and floor risk.; `GARM_RISK_EXCLUSION_MEDIUM`: Exclude medium, high, and floor risk.; `GARM_RISK_EXCLUSION_LOW`: Exclude all levels of risk (low, medium, high and floor).' enum: - GARM_RISK_EXCLUSION_UNSPECIFIED - GARM_RISK_EXCLUSION_FLOOR - GARM_RISK_EXCLUSION_HIGH - GARM_RISK_EXCLUSION_MEDIUM - GARM_RISK_EXCLUSION_LOW excludedFraudIvtMfaCategories: type: array description: Optional. Scope3's fraud IVT MFA categories to exclude. items: type: string enum: - FRAUD_IVT_MFA_CATEGORY_UNSPECIFIED - FRAUD_IVT_MFA description: 'Allowed values — `FRAUD_IVT_MFA_CATEGORY_UNSPECIFIED`: Default value when a Scope3 Fraud, IVT, MFA category is not specified or is unknown in this version.; `FRAUD_IVT_MFA`: FRAUD, IVT, MFA.' onlinePiracyContent: type: string description: 'Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. Allowed values — `GARM_RISK_EXCLUSION_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any GARM risk exclusion option.; `GARM_RISK_EXCLUSION_FLOOR`: Exclude floor risk.; `GARM_RISK_EXCLUSION_HIGH`: Exclude high and floor risk.; `GARM_RISK_EXCLUSION_MEDIUM`: Exclude medium, high, and floor risk.; `GARM_RISK_EXCLUSION_LOW`: Exclude all levels of risk (low, medium, high and floor).' enum: - GARM_RISK_EXCLUSION_UNSPECIFIED - GARM_RISK_EXCLUSION_FLOOR - GARM_RISK_EXCLUSION_HIGH - GARM_RISK_EXCLUSION_MEDIUM - GARM_RISK_EXCLUSION_LOW armsAmmunitionContent: type: string description: 'Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. Allowed values — `GARM_RISK_EXCLUSION_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any GARM risk exclusion option.; `GARM_RISK_EXCLUSION_FLOOR`: Exclude floor risk.; `GARM_RISK_EXCLUSION_HIGH`: Exclude high and floor risk.; `GARM_RISK_EXCLUSION_MEDIUM`: Exclude medium, high, and floor risk.; `GARM_RISK_EXCLUSION_LOW`: Exclude all levels of risk (low, medium, high and floor).' enum: - GARM_RISK_EXCLUSION_UNSPECIFIED - GARM_RISK_EXCLUSION_FLOOR - GARM_RISK_EXCLUSION_HIGH - GARM_RISK_EXCLUSION_MEDIUM - GARM_RISK_EXCLUSION_LOW obscenityProfanityContent: type: string description: 'Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. Allowed values — `GARM_RISK_EXCLUSION_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any GARM risk exclusion option.; `GARM_RISK_EXCLUSION_FLOOR`: Exclude floor risk.; `GARM_RISK_EXCLUSION_HIGH`: Exclude high and floor risk.; `GARM_RISK_EXCLUSION_MEDIUM`: Exclude medium, high, and floor risk.; `GARM_RISK_EXCLUSION_LOW`: Exclude all levels of risk (low, medium, high and floor).' enum: - GARM_RISK_EXCLUSION_UNSPECIFIED - GARM_RISK_EXCLUSION_FLOOR - GARM_RISK_EXCLUSION_HIGH - GARM_RISK_EXCLUSION_MEDIUM - GARM_RISK_EXCLUSION_LOW deathInjuryMilitaryConflictContent: type: string description: 'Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. Allowed values — `GARM_RISK_EXCLUSION_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any GARM risk exclusion option.; `GARM_RISK_EXCLUSION_FLOOR`: Exclude floor risk.; `GARM_RISK_EXCLUSION_HIGH`: Exclude high and floor risk.; `GARM_RISK_EXCLUSION_MEDIUM`: Exclude medium, high, and floor risk.; `GARM_RISK_EXCLUSION_LOW`: Exclude all levels of risk (low, medium, high and floor).' enum: - GARM_RISK_EXCLUSION_UNSPECIFIED - GARM_RISK_EXCLUSION_FLOOR - GARM_RISK_EXCLUSION_HIGH - GARM_RISK_EXCLUSION_MEDIUM - GARM_RISK_EXCLUSION_LOW hateSpeechActsAggressionContent: type: string description: 'Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. Allowed values — `GARM_RISK_EXCLUSION_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any GARM risk exclusion option.; `GARM_RISK_EXCLUSION_FLOOR`: Exclude floor risk.; `GARM_RISK_EXCLUSION_HIGH`: Exclude high and floor risk.; `GARM_RISK_EXCLUSION_MEDIUM`: Exclude medium, high, and floor risk.; `GARM_RISK_EXCLUSION_LOW`: Exclude all levels of risk (low, medium, high and floor).' enum: - GARM_RISK_EXCLUSION_UNSPECIFIED - GARM_RISK_EXCLUSION_FLOOR - GARM_RISK_EXCLUSION_HIGH - GARM_RISK_EXCLUSION_MEDIUM - GARM_RISK_EXCLUSION_LOW videoIabViewability: type: string description: 'Optional. IAB viewability threshold for video ads. Allowed values — `VIDEO_IAB_VIEWABILITY_UNSPECIFIED`: Default value when not specified or is unknown in this version.; `VIDEO_IAB_VIEWABILITY_10`: 10%+ in view (IAB video viewability standard).; `VIDEO_IAB_VIEWABILITY_20`: 20%+ in view (IAB video viewability standard).; `VIDEO_IAB_VIEWABILITY_35`: 35%+ in view (IAB video viewability standard).; `VIDEO_IAB_VIEWABILITY_50`: 50%+ in view (IAB video viewability standard).; `VIDEO_IAB_VIEWABILITY_75`: 75%+ in view (IAB video viewability standard).' enum: - VIDEO_IAB_VIEWABILITY_UNSPECIFIED - VIDEO_IAB_VIEWABILITY_10 - VIDEO_IAB_VIEWABILITY_20 - VIDEO_IAB_VIEWABILITY_35 - VIDEO_IAB_VIEWABILITY_50 - VIDEO_IAB_VIEWABILITY_75 excludedAdlooxCategories: type: array description: Scope3 categories to exclude. items: type: string enum: - ADLOOX_UNSPECIFIED - ADULT_CONTENT_HARD - ADULT_CONTENT_SOFT - ILLEGAL_CONTENT - BORDERLINE_CONTENT - DISCRIMINATORY_CONTENT - VIOLENT_CONTENT_WEAPONS - LOW_VIEWABILITY_DOMAINS - FRAUD description: 'Allowed values — `ADLOOX_UNSPECIFIED`: Default value when a Scope3 category is not specified or is unknown in this version.; `ADULT_CONTENT_HARD`: Adult content (hard).; `ADULT_CONTENT_SOFT`: Adult content (soft).; `ILLEGAL_CONTENT`: Illegal content.; `BORDERLINE_CONTENT`: Borderline content.; `DISCRIMINATORY_CONTENT`: Discriminatory content.; `VIOLENT_CONTENT_WEAPONS`: Violent content & weapons.; `LOW_VIEWABILITY_DOMAINS`: Low viewability domains.; `FRAUD`: Fraud.' crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent: type: string description: 'Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. Allowed values — `GARM_RISK_EXCLUSION_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any GARM risk exclusion option.; `GARM_RISK_EXCLUSION_FLOOR`: Exclude floor risk.; `GARM_RISK_EXCLUSION_HIGH`: Exclude high and floor risk.; `GARM_RISK_EXCLUSION_MEDIUM`: Exclude medium, high, and floor risk.; `GARM_RISK_EXCLUSION_LOW`: Exclude all levels of risk (low, medium, high and floor).' enum: - GARM_RISK_EXCLUSION_UNSPECIFIED - GARM_RISK_EXCLUSION_FLOOR - GARM_RISK_EXCLUSION_HIGH - GARM_RISK_EXCLUSION_MEDIUM - GARM_RISK_EXCLUSION_LOW debatedSensitiveSocialIssueContent: type: string description: 'Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. Allowed values — `GARM_RISK_EXCLUSION_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any GARM risk exclusion option.; `GARM_RISK_EXCLUSION_FLOOR`: Exclude floor risk.; `GARM_RISK_EXCLUSION_HIGH`: Exclude high and floor risk.; `GARM_RISK_EXCLUSION_MEDIUM`: Exclude medium, high, and floor risk.; `GARM_RISK_EXCLUSION_LOW`: Exclude all levels of risk (low, medium, high and floor).' enum: - GARM_RISK_EXCLUSION_UNSPECIFIED - GARM_RISK_EXCLUSION_FLOOR - GARM_RISK_EXCLUSION_HIGH - GARM_RISK_EXCLUSION_MEDIUM - GARM_RISK_EXCLUSION_LOW spamHarmfulContent: type: string description: 'Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. Allowed values — `GARM_RISK_EXCLUSION_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any GARM risk exclusion option.; `GARM_RISK_EXCLUSION_FLOOR`: Exclude floor risk.; `GARM_RISK_EXCLUSION_HIGH`: Exclude high and floor risk.; `GARM_RISK_EXCLUSION_MEDIUM`: Exclude medium, high, and floor risk.; `GARM_RISK_EXCLUSION_LOW`: Exclude all levels of risk (low, medium, high and floor).' enum: - GARM_RISK_EXCLUSION_UNSPECIFIED - GARM_RISK_EXCLUSION_FLOOR - GARM_RISK_EXCLUSION_HIGH - GARM_RISK_EXCLUSION_MEDIUM - GARM_RISK_EXCLUSION_LOW AdvancedProductTargeting: type: object description: Product-specific targeting overrides. properties: userListIds: type: array description: Optional. The user list IDs to target. Plannable user lists can be retrieved using the `RetrievePlannableUserInterests` method. items: type: string plannableLocationIds: type: array description: Optional. Plannable location IDs to target. items: type: string format: int64 targetFrequency: $ref: '#/components/schemas/TargetFrequency' frequencyCap: $ref: '#/components/schemas/FrequencyCap' ageRange: type: string description: 'Optional. The age range to target. Allowed values — `PLANNABLE_AGE_RANGE_UNSPECIFIED`: Not specified.; `PLANNABLE_AGE_RANGE_18_24`: 18 to 24 years old.; `PLANNABLE_AGE_RANGE_18_34`: 18 to 34 years old.; `PLANNABLE_AGE_RANGE_18_44`: 18 to 44 years old.; `PLANNABLE_AGE_RANGE_18_49`: 18 to 49 years old.; `PLANNABLE_AGE_RANGE_18_54`: 18 to 54 years old.; `PLANNABLE_AGE_RANGE_18_64`: 18 to 64 years old.; `PLANNABLE_AGE_RANGE_18_65_UP`: 18 to 65+ years old.; `PLANNABLE_AGE_RANGE_21_34`: 21 to 34 years old.; `PLANNABLE_AGE_RANGE_21_44`: 21 to 44 years old.; `PLANNABLE_AGE_RANGE_21_49`: 21 to 49 years old.; `PLANNABLE_AGE_RANGE_21_54`: 21 to 54 years old.; `PLANNABLE_AGE_RANGE_21_64`: 21 to 64 years old.; `PLANNABLE_AGE_RANGE_21_65_UP`: 21 to 65+ years old.; `PLANNABLE_AGE_RANGE_25_34`: 25 to 34 years old.; `PLANNABLE_AGE_RANGE_25_44`: 25 to 44 years old.; `PLANNABLE_AGE_RANGE_25_49`: 25 to 49 years old.; `PLANNABLE_AGE_RANGE_25_54`: 25 to 54 years old.; `PLANNABLE_AGE_RANGE_25_64`: 25 to 64 years old.; `PLANNABLE_AGE_RANGE_25_65_UP`: 25 to 65+ years old.; `PLANNABLE_AGE_RANGE_35_44`: 35 to 44 years old.; `PLANNABLE_AGE_RANGE_35_49`: 35 to 49 years old.; `PLANNABLE_AGE_RANGE_35_54`: 35 to 54 years old.; `PLANNABLE_AGE_RANGE_35_64`: 35 to 64 years old.; `PLANNABLE_AGE_RANGE_35_65_UP`: 35 to 65+ years old.; `PLANNABLE_AGE_RANGE_45_54`: 45 to 54 years old.; `PLANNABLE_AGE_RANGE_45_64`: 45 to 64 years old.; `PLANNABLE_AGE_RANGE_45_65_UP`: 45 to 65+ years old.; `PLANNABLE_AGE_RANGE_50_65_UP`: 50 to 65+ years old.; `PLANNABLE_AGE_RANGE_55_64`: 55 to 64 years old.; `PLANNABLE_AGE_RANGE_55_65_UP`: 55 to 65+ years old.; `PLANNABLE_AGE_RANGE_65_UP`: 65+ years old.' enum: - PLANNABLE_AGE_RANGE_UNSPECIFIED - PLANNABLE_AGE_RANGE_18_24 - PLANNABLE_AGE_RANGE_18_34 - PLANNABLE_AGE_RANGE_18_44 - PLANNABLE_AGE_RANGE_18_49 - PLANNABLE_AGE_RANGE_18_54 - PLANNABLE_AGE_RANGE_18_64 - PLANNABLE_AGE_RANGE_18_65_UP - PLANNABLE_AGE_RANGE_21_34 - PLANNABLE_AGE_RANGE_21_44 - PLANNABLE_AGE_RANGE_21_49 - PLANNABLE_AGE_RANGE_21_54 - PLANNABLE_AGE_RANGE_21_64 - PLANNABLE_AGE_RANGE_21_65_UP - PLANNABLE_AGE_RANGE_25_34 - PLANNABLE_AGE_RANGE_25_44 - PLANNABLE_AGE_RANGE_25_49 - PLANNABLE_AGE_RANGE_25_54 - PLANNABLE_AGE_RANGE_25_64 - PLANNABLE_AGE_RANGE_25_65_UP - PLANNABLE_AGE_RANGE_35_44 - PLANNABLE_AGE_RANGE_35_49 - PLANNABLE_AGE_RANGE_35_54 - PLANNABLE_AGE_RANGE_35_64 - PLANNABLE_AGE_RANGE_35_65_UP - PLANNABLE_AGE_RANGE_45_54 - PLANNABLE_AGE_RANGE_45_64 - PLANNABLE_AGE_RANGE_45_65_UP - PLANNABLE_AGE_RANGE_50_65_UP - PLANNABLE_AGE_RANGE_55_64 - PLANNABLE_AGE_RANGE_55_65_UP - PLANNABLE_AGE_RANGE_65_UP dateRange: $ref: '#/components/schemas/DateRange' userInterestIds: type: array description: Optional. The user interest IDs to target. Plannable user interests can be retrieved using the `RetrievePlannableUserInterests` method. items: type: string surfaceTargetingSettings: $ref: '#/components/schemas/SurfaceTargetingSettings' network: type: string description: 'Optional. The network to target. Allowed values — `PLANNABLE_NETWORK_UNSPECIFIED`: Not specified.; `PLANNABLE_NETWORK_YOUTUBE`: YouTube.; `PLANNABLE_NETWORK_GOOGLE_VIDEO_PARTNERS`: Google Video Partners.; `PLANNABLE_NETWORK_YOUTUBE_AND_GOOGLE_VIDEO_PARTNERS`: YouTube and Google Video Partners.' enum: - PLANNABLE_NETWORK_UNSPECIFIED - PLANNABLE_NETWORK_YOUTUBE - PLANNABLE_NETWORK_GOOGLE_VIDEO_PARTNERS - PLANNABLE_NETWORK_YOUTUBE_AND_GOOGLE_VIDEO_PARTNERS genders: type: array description: Optional. The gender options to target. items: type: string enum: - GENDER_UNSPECIFIED - GENDER_MALE - GENDER_FEMALE - GENDER_UNKNOWN description: 'Allowed values — `GENDER_UNSPECIFIED`: Default value when gender is not specified in this version. This enum is a place holder for default value and does not represent a real gender option.; `GENDER_MALE`: The audience gender is male.; `GENDER_FEMALE`: The audience gender is female.; `GENDER_UNKNOWN`: The audience gender is unknown.' devices: type: array description: Optional. The devices to target. items: type: string enum: - DEVICE_TYPE_UNSPECIFIED - DEVICE_TYPE_COMPUTER - DEVICE_TYPE_CONNECTED_TV - DEVICE_TYPE_SMART_PHONE - DEVICE_TYPE_TABLET - DEVICE_TYPE_CONNECTED_DEVICE description: 'Allowed values — `DEVICE_TYPE_UNSPECIFIED`: Default value when device type is not specified in this version. This enum is a placeholder for default value and does not represent a real device type option.; `DEVICE_TYPE_COMPUTER`: Computer.; `DEVICE_TYPE_CONNECTED_TV`: Connected TV.; `DEVICE_TYPE_SMART_PHONE`: Smart phone.; `DEVICE_TYPE_TABLET`: Tablet.; `DEVICE_TYPE_CONNECTED_DEVICE`: Connected device.' youtubeSelectSettings: $ref: '#/components/schemas/YouTubeSelectSettings' Advertiser: type: object description: A single advertiser in Display & Video 360 (DV360). properties: defaultLogoAssetId: type: string format: int64 description: Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API. containsEuPoliticalAds: type: string description: 'Optional. Whether this advertiser contains line items that serve European Union political ads. If this field is set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING`, then the following will happen: * Any new line items created under this advertiser will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. * Any existing line items under this advertiser that do not have a set value be updated to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` within a day. Allowed values — `EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN`: Unknown.; `CONTAINS_EU_POLITICAL_ADVERTISING`: Contains EU political advertising.; `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING`: Does not contain EU political advertising.' enum: - EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN - CONTAINS_EU_POLITICAL_ADVERTISING - DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING entityStatus: type: string description: 'Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. Allowed values — `ENTITY_STATUS_UNSPECIFIED`: Default value when status is not specified or is unknown in this version.; `ENTITY_STATUS_ACTIVE`: The entity is enabled to bid and spend budget.; `ENTITY_STATUS_ARCHIVED`: The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.; `ENTITY_STATUS_DRAFT`: The entity is under draft. Bidding and budget spending are disabled.; `ENTITY_STATUS_PAUSED`: Bidding and budget spending are paused for the entity.; `ENTITY_STATUS_SCHEDULED_FOR_DELETION`: The entity is scheduled for deletion.' enum: - ENTITY_STATUS_UNSPECIFIED - ENTITY_STATUS_ACTIVE - ENTITY_STATUS_ARCHIVED - ENTITY_STATUS_DRAFT - ENTITY_STATUS_PAUSED - ENTITY_STATUS_SCHEDULED_FOR_DELETION servingConfig: $ref: '#/components/schemas/AdvertiserTargetingConfig' updateTime: type: string format: google-datetime description: Output only. The timestamp when the advertiser was last updated. Assigned by the system. readOnly: true dataAccessConfig: $ref: '#/components/schemas/AdvertiserDataAccessConfig' displayName: type: string description: Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. name: type: string description: Output only. The resource name of the advertiser. readOnly: true creativeConfig: $ref: '#/components/schemas/AdvertiserCreativeConfig' defaultBusinessName: type: string description: Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided. prismaEnabled: type: boolean description: 'Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser.' adServerConfig: $ref: '#/components/schemas/AdvertiserAdServerConfig' advertiserId: type: string format: int64 description: Output only. The unique ID of the advertiser. Assigned by the system. readOnly: true generalConfig: $ref: '#/components/schemas/AdvertiserGeneralConfig' partnerId: type: string format: int64 description: Required. Immutable. The unique ID of the partner that the advertiser belongs to. integrationDetails: $ref: '#/components/schemas/IntegrationDetails' billingConfig: $ref: '#/components/schemas/AdvertiserBillingConfig' AdvertiserAdServerConfig: type: object description: Ad server related settings of an advertiser. properties: thirdPartyOnlyConfig: $ref: '#/components/schemas/ThirdPartyOnlyConfig' cmHybridConfig: $ref: '#/components/schemas/CmHybridConfig' AdvertiserBillingConfig: type: object description: Billing related settings of an advertiser. properties: billingProfileId: type: string format: int64 description: Required. The ID of a billing profile assigned to the advertiser. AdvertiserCreativeConfig: type: object description: Creatives related settings of an advertiser. properties: dynamicCreativeEnabled: type: boolean description: Whether or not the advertiser is enabled for dynamic creatives. obaComplianceDisabled: type: boolean description: 'Whether or not to disable Google''s About this Ad feature that adds badging (to identify the content as an ad) and transparency information (on interaction with About this Ad) to your ads for Online Behavioral Advertising (OBA) and regulatory requirements. About this Ad gives users greater control over the ads they see and helps you explain why they''re seeing your ad. [Learn more](//support.google.com/displayvideo/answer/14315795). If you choose to set this field to `true`, note that ads served through Display & Video 360 must comply to the following: * Be Online Behavioral Advertising (OBA) compliant, as per your contract with Google Marketing Platform. * In the European Economic Area (EEA), include transparency information and a mechanism for users to report illegal content in ads. If using an alternative ad badging, transparency, and reporting solution, you must ensure it includes the required transparency information and illegal content flagging mechanism and that you notify Google of any illegal content reports using the appropriate [form](//support.google.com/legal/troubleshooter/1114905?sjid=6787484030557261960-EU#ts=2981967%2C2982031%2C12980091).' videoCreativeDataSharingAuthorized: type: boolean description: By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display & Video 360 advertiser to provide reporting and features related to the advertiser's television campaigns. Applicable only when the advertiser has a CM360 hybrid ad server configuration. iasClientId: type: string format: int64 description: An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS "Campaign Monitor" tag containing this ID to the creative tag. AdvertiserDataAccessConfig: type: object description: Settings that control how advertiser related data may be accessed. properties: sdfConfig: $ref: '#/components/schemas/AdvertiserSdfConfig' AdvertiserGeneralConfig: type: object description: General settings of an advertiser. properties: domainUrl: type: string description: Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com currencyCode: type: string description: 'Required. Immutable. Advertiser''s currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand' timeZone: type: string description: 'Output only. The standard TZ database name of the advertiser''s time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM360 hybrid advertisers, the time zone is the same as that of the associated CM360 account; for third-party only advertisers, the time zone is the same as that of the parent partner.' readOnly: true AdvertiserSdfConfig: type: object description: Structured Data Files (SDF) settings of an advertiser. properties: overridePartnerSdfConfig: type: boolean description: Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig. sdfConfig: $ref: '#/components/schemas/SdfConfig' AdvertiserTargetingConfig: type: object description: Targeting settings related to ad serving of an advertiser. properties: exemptTvFromViewabilityTargeting: type: boolean description: Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser. AgeRangeAssignedTargetingOptionDetails: type: object description: Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. properties: ageRange: type: string description: 'Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age. Allowed values — `AGE_RANGE_UNSPECIFIED`: Default value when age range is not specified in this version. This enum is a placeholder for default value and does not represent a real age range option.; `AGE_RANGE_18_24`: The age range of the audience is 18 to 24.; `AGE_RANGE_25_34`: The age range of the audience is 25 to 34.; `AGE_RANGE_35_44`: The age range of the audience is 35 to 44.; `AGE_RANGE_45_54`: The age range of the audience is 45 to 54.; `AGE_RANGE_55_64`: The age range of the audience is 55 to 64.; `AGE_RANGE_65_PLUS`: The age range of the audience is 65 and up.; `AGE_RANGE_UNKNOWN`: The age range of the audience is unknown.; `AGE_RANGE_18_20`: The age range of the audience is 18 to 20, only supported for the AdGroup of YouTube Programmatic Reservation line item.; `AGE_RANGE_21_24`: The age range of the audience is 21 to 24, only supported for the AdGroup of YouTube Programmatic Reservation line item.; `AGE_RANGE_25_29`: The age range of the audience is 25 to 29, only supported for the AdGroup of YouTube Programmatic Reservation line item.; `AGE_RANGE_30_34`: The age range of the audience is 30 to 34, only supported for the AdGroup of YouTube Programmatic Reservation line item.; `AGE_RANGE_35_39`: The age range of the audience is 35 to 39, only supported for the AdGroup of YouTube Programmatic Reservation line item.; `AGE_RANGE_40_44`: The age range of the audience is 40 to 44, only supported for the AdGroup of YouTube Programmatic Reservation line item.; `AGE_RANGE_45_49`: The age range of the audience is 45 to 49, only supported for the AdGroup of YouTube Programmatic Reservation line item.; `AGE_RANGE_50_54`: The age range of the audience is 50 to 54, only supported for the AdGroup of YouTube Programmatic Reservation line item.; `AGE_RANGE_55_59`: The age range of the audience is 55 to 59, only supported for the AdGroup of YouTube Programmatic Reservation line item.; `AGE_RANGE_60_64`: The age range of the audience is 60 to 64, only supported for the AdGroup of YouTube Programmatic Reservation line item.' 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 - AGE_RANGE_18_20 - AGE_RANGE_21_24 - AGE_RANGE_25_29 - AGE_RANGE_30_34 - AGE_RANGE_35_39 - AGE_RANGE_40_44 - AGE_RANGE_45_49 - AGE_RANGE_50_54 - AGE_RANGE_55_59 - AGE_RANGE_60_64 AgeRangeTargetingOptionDetails: type: object description: Represents a targetable age range. This will be populated in the age_range_details field when targeting_type is `TARGETING_TYPE_AGE_RANGE`. properties: ageRange: type: string description: 'Output only. The age range of an audience. Allowed values — `AGE_RANGE_UNSPECIFIED`: Default value when age range is not specified in this version. This enum is a placeholder for default value and does not represent a real age range option.; `AGE_RANGE_18_24`: The age range of the audience is 18 to 24.; `AGE_RANGE_25_34`: The age range of the audience is 25 to 34.; `AGE_RANGE_35_44`: The age range of the audience is 35 to 44.; `AGE_RANGE_45_54`: The age range of the audience is 45 to 54.; `AGE_RANGE_55_64`: The age range of the audience is 55 to 64.; `AGE_RANGE_65_PLUS`: The age range of the audience is 65 and up.; `AGE_RANGE_UNKNOWN`: The age range of the audience is unknown.; `AGE_RANGE_18_20`: The age range of the audience is 18 to 20, only supported for the AdGroup of YouTube Programmatic Reservation line item.; `AGE_RANGE_21_24`: The age range of the audience is 21 to 24, only supported for the AdGroup of YouTube Programmatic Reservation line item.; `AGE_RANGE_25_29`: The age range of the audience is 25 to 29, only supported for the AdGroup of YouTube Programmatic Reservation line item.; `AGE_RANGE_30_34`: The age range of the audience is 30 to 34, only supported for the AdGroup of YouTube Programmatic Reservation line item.; `AGE_RANGE_35_39`: The age range of the audience is 35 to 39, only supported for the AdGroup of YouTube Programmatic Reservation line item.; `AGE_RANGE_40_44`: The age range of the audience is 40 to 44, only supported for the AdGroup of YouTube Programmatic Reservation line item.; `AGE_RANGE_45_49`: The age range of the audience is 45 to 49, only supported for the AdGroup of YouTube Programmatic Reservation line item.; `AGE_RANGE_50_54`: The age range of the audience is 50 to 54, only supported for the AdGroup of YouTube Programmatic Reservation line item.; `AGE_RANGE_55_59`: The age range of the audience is 55 to 59, only supported for the AdGroup of YouTube Programmatic Reservation line item.; `AGE_RANGE_60_64`: The age range of the audience is 60 to 64, only supported for the AdGroup of YouTube Programmatic Reservation line item.' 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 - AGE_RANGE_18_20 - AGE_RANGE_21_24 - AGE_RANGE_25_29 - AGE_RANGE_30_34 - AGE_RANGE_35_39 - AGE_RANGE_40_44 - AGE_RANGE_45_49 - AGE_RANGE_50_54 - AGE_RANGE_55_59 - AGE_RANGE_60_64 readOnly: true AppAssignedTargetingOptionDetails: type: object description: Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. properties: displayName: type: string description: Output only. The display name of the app. readOnly: true appId: type: string description: Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`. negative: type: boolean description: Indicates if this option is being negatively targeted. appPlatform: type: string description: 'Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID. Allowed values — `APP_PLATFORM_UNSPECIFIED`: Default value when app platform is not specified in this version. This enum is a placeholder for default value and does not represent a real platform option.; `APP_PLATFORM_IOS`: The app platform is iOS.; `APP_PLATFORM_ANDROID`: The app platform is Android.; `APP_PLATFORM_ROKU`: The app platform is Roku.; `APP_PLATFORM_AMAZON_FIRETV`: The app platform is Amazon FireTV.; `APP_PLATFORM_PLAYSTATION`: The app platform is Playstation.; `APP_PLATFORM_APPLE_TV`: The app platform is Apple TV.; `APP_PLATFORM_XBOX`: The app platform is Xbox.; `APP_PLATFORM_SAMSUNG_TV`: The app platform is Samsung TV.; `APP_PLATFORM_ANDROID_TV`: The app platform is Android TV.; `APP_PLATFORM_GENERIC_CTV`: The app platform is a CTV platform that is not explicitly listed elsewhere.; `APP_PLATFORM_LG_TV`: The app platform is LG TV.; `APP_PLATFORM_VIZIO_TV`: The app platform is VIZIO TV.; `APP_PLATFORM_VIDAA`: The app platform is Vidaa.' enum: - APP_PLATFORM_UNSPECIFIED - APP_PLATFORM_IOS - APP_PLATFORM_ANDROID - APP_PLATFORM_ROKU - APP_PLATFORM_AMAZON_FIRETV - APP_PLATFORM_PLAYSTATION - APP_PLATFORM_APPLE_TV - APP_PLATFORM_XBOX - APP_PLATFORM_SAMSUNG_TV - APP_PLATFORM_ANDROID_TV - APP_PLATFORM_GENERIC_CTV - APP_PLATFORM_LG_TV - APP_PLATFORM_VIZIO_TV - APP_PLATFORM_VIDAA AppCategoryAssignedTargetingOptionDetails: type: object description: Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. properties: displayName: type: string description: Output only. The display name of the app category. readOnly: true targetingOptionId: type: string description: Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. negative: type: boolean description: Indicates if this option is being negatively targeted. AppCategoryTargetingOptionDetails: type: object description: Represents a targetable collection of apps. A collection lets you target dynamic groups of related apps that are maintained by the platform, for example `All Apps/Google Play/Games`. This will be populated in the app_category_details field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. properties: displayName: type: string description: Output only. The name of the app collection. readOnly: true Asset: type: object description: A single asset. properties: mediaId: type: string format: int64 description: Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset. content: type: string description: The asset content. For uploaded assets, the content is the serving path. AssetAssociation: type: object description: Asset association for the creative. properties: role: type: string description: 'Optional. The role of this asset for the creative. Allowed values — `ASSET_ROLE_UNSPECIFIED`: Asset role is not specified or is unknown in this version.; `ASSET_ROLE_MAIN`: The asset is the main asset of the creative.; `ASSET_ROLE_BACKUP`: The asset is a backup asset of the creative.; `ASSET_ROLE_POLITE_LOAD`: The asset is a polite load asset of the creative.; `ASSET_ROLE_HEADLINE`: Headline of a native creative. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`; `ASSET_ROLE_LONG_HEADLINE`: Long headline of a native creative. The content must be UTF-8 encoded with a length of no more than 50 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`; `ASSET_ROLE_BODY`: Body text of a native creative. The content must be UTF-8 encoded with a length of no more than 90 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`; `ASSET_ROLE_LONG_BODY`: Long body text of a native creative. The content must be UTF-8 encoded with a length of no more than 150 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`; `ASSET_ROLE_CAPTION_URL`: A short, friendly version of the landing page URL to show in the creative. This URL gives people an idea of where they''ll arrive after they click on the creative. The content must be UTF-8 encoded with a length of no more than 30 characters. For example, if the landing page URL is ''http://www.example.com/page'', the caption URL can be ''example.com''. The protocol (http://) is optional, but the URL can''t contain spaces or special characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`; `ASSET_ROLE_CALL_TO_ACTION`: The text to use on the call-to-action button of a native creative. The content must be UTF-8 encoded with a length of no more than 15 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`; `ASSET_ROLE_ADVERTISER_NAME`: The text that identifies the advertiser or brand name. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`; `ASSET_ROLE_PRICE`: The purchase price of your app in the Google play store or iOS app store (for example, $5.99). Note that this value is not automatically synced with the actual value listed in the store. It will always be the one provided when save the creative. The content must be UTF-8 encoded with a length of no more than 15 characters. Assets of this role are read-only.; `ASSET_ROLE_ANDROID_APP_ID`: The ID of an Android app in the Google play store. You can find this ID in the App’s Google Play Store URL after ‘id’. For example, in `https://play.google.com/store/apps/details?id=com.company.appname` the identifier is com.company.appname. Assets of this role are read-only.; `ASSET_ROLE_IOS_APP_ID`: The ID of an iOS app in the Apple app store. This ID number can be found in the Apple App Store URL as the string of numbers directly after "id". For example, in `https://apps.apple.com/us/app/gmail-email-by-google/id422689480` the ID is 422689480. Assets of this role are read-only.; `ASSET_ROLE_RATING`: The rating of an app in the Google play store or iOS app store. Note that this value is not automatically synced with the actual rating in the store. It will always be the one provided when save the creative. Assets of this role are read-only.; `ASSET_ROLE_ICON`: The icon of a creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`; `ASSET_ROLE_COVER_IMAGE`: The cover image of a native video creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_VIDEO`; `ASSET_ROLE_BACKGROUND_COLOR`: The main color to use in a creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`; `ASSET_ROLE_ACCENT_COLOR`: The accent color to use in a creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`; `ASSET_ROLE_REQUIRE_LOGO`: Whether the creative must use a logo asset. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`; `ASSET_ROLE_REQUIRE_IMAGE`: Whether the creative must use an image asset. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`; `ASSET_ROLE_ENABLE_ASSET_ENHANCEMENTS`: Whether asset enhancements can be applied to the creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_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 - ASSET_ROLE_BACKGROUND_COLOR - ASSET_ROLE_ACCENT_COLOR - ASSET_ROLE_REQUIRE_LOGO - ASSET_ROLE_REQUIRE_IMAGE - ASSET_ROLE_ENABLE_ASSET_ENHANCEMENTS asset: $ref: '#/components/schemas/Asset' AssignedInventorySource: type: object description: An assignment between a targetable inventory source and an inventory source group. properties: inventorySourceId: type: string description: Required. The ID of the inventory source entity being targeted. assignedInventorySourceId: type: string format: int64 description: Output only. The unique ID of the assigned inventory source. The ID is only unique within a given inventory source group. It may be reused in other contexts. readOnly: true name: type: string description: Output only. The resource name of the assigned inventory source. readOnly: true AssignedLocation: type: object description: An assignment between a location list and a relevant targeting option. properties: name: type: string description: Output only. The resource name of the assigned location. readOnly: true assignedLocationId: type: string format: int64 description: Output only. The unique ID of the assigned location. The ID is only unique within a location list. It may be reused in other contexts. readOnly: true targetingOptionId: type: string description: Required. The ID of the targeting option assigned to the location list. AssignedTargetingOption: type: object description: A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings. properties: channelDetails: $ref: '#/components/schemas/ChannelAssignedTargetingOptionDetails' negativeKeywordListDetails: $ref: '#/components/schemas/NegativeKeywordListAssignedTargetingOptionDetails' browserDetails: $ref: '#/components/schemas/BrowserAssignedTargetingOptionDetails' viewabilityDetails: $ref: '#/components/schemas/ViewabilityAssignedTargetingOptionDetails' omidDetails: $ref: '#/components/schemas/OmidAssignedTargetingOptionDetails' contentDurationDetails: $ref: '#/components/schemas/ContentDurationAssignedTargetingOptionDetails' assignedTargetingOptionId: type: string description: Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. readOnly: true parentalStatusDetails: $ref: '#/components/schemas/ParentalStatusAssignedTargetingOptionDetails' contentGenreDetails: $ref: '#/components/schemas/ContentGenreAssignedTargetingOptionDetails' keywordDetails: $ref: '#/components/schemas/KeywordAssignedTargetingOptionDetails' geoRegionDetails: $ref: '#/components/schemas/GeoRegionAssignedTargetingOptionDetails' categoryDetails: $ref: '#/components/schemas/CategoryAssignedTargetingOptionDetails' contentStreamTypeDetails: $ref: '#/components/schemas/ContentStreamTypeAssignedTargetingOptionDetails' targetingType: type: string description: 'Output only. Identifies the type of this assigned targeting option. Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack.' 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 - TARGETING_TYPE_POI - TARGETING_TYPE_BUSINESS_CHAIN - TARGETING_TYPE_CONTENT_DURATION - TARGETING_TYPE_CONTENT_STREAM_TYPE - TARGETING_TYPE_NATIVE_CONTENT_POSITION - TARGETING_TYPE_OMID - TARGETING_TYPE_AUDIO_CONTENT_TYPE - TARGETING_TYPE_CONTENT_GENRE - TARGETING_TYPE_YOUTUBE_VIDEO - TARGETING_TYPE_YOUTUBE_CHANNEL - TARGETING_TYPE_SESSION_POSITION - TARGETING_TYPE_CONTENT_THEME_EXCLUSION - TARGETING_TYPE_YOUTUBE_CHANNEL_PACK readOnly: true deviceMakeModelDetails: $ref: '#/components/schemas/DeviceMakeModelAssignedTargetingOptionDetails' urlDetails: $ref: '#/components/schemas/UrlAssignedTargetingOptionDetails' operatingSystemDetails: $ref: '#/components/schemas/OperatingSystemAssignedTargetingOptionDetails' audioContentTypeDetails: $ref: '#/components/schemas/AudioContentTypeAssignedTargetingOptionDetails' regionalLocationListDetails: $ref: '#/components/schemas/RegionalLocationListAssignedTargetingOptionDetails' digitalContentLabelExclusionDetails: $ref: '#/components/schemas/DigitalContentLabelAssignedTargetingOptionDetails' userRewardedContentDetails: $ref: '#/components/schemas/UserRewardedContentAssignedTargetingOptionDetails' youtubeChannelPackDetails: $ref: '#/components/schemas/YoutubeChannelPackAssignedTargetingOptionDetails' appDetails: $ref: '#/components/schemas/AppAssignedTargetingOptionDetails' onScreenPositionDetails: $ref: '#/components/schemas/OnScreenPositionAssignedTargetingOptionDetails' businessChainDetails: $ref: '#/components/schemas/BusinessChainAssignedTargetingOptionDetails' genderDetails: $ref: '#/components/schemas/GenderAssignedTargetingOptionDetails' videoPlayerSizeDetails: $ref: '#/components/schemas/VideoPlayerSizeAssignedTargetingOptionDetails' contentOutstreamPositionDetails: $ref: '#/components/schemas/ContentOutstreamPositionAssignedTargetingOptionDetails' sensitiveCategoryExclusionDetails: $ref: '#/components/schemas/SensitiveCategoryAssignedTargetingOptionDetails' assignedTargetingOptionIdAlias: type: string description: 'Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`' readOnly: true exchangeDetails: $ref: '#/components/schemas/ExchangeAssignedTargetingOptionDetails' thirdPartyVerifierDetails: $ref: '#/components/schemas/ThirdPartyVerifierAssignedTargetingOptionDetails' audienceGroupDetails: $ref: '#/components/schemas/AudienceGroupAssignedTargetingOptionDetails' youtubeVideoDetails: $ref: '#/components/schemas/YoutubeVideoAssignedTargetingOptionDetails' inheritance: type: string description: 'Output only. The inheritance status of the assigned targeting option. Allowed values — `INHERITANCE_UNSPECIFIED`: The inheritance is unspecified or unknown.; `NOT_INHERITED`: The assigned targeting option is not inherited from higher level entity.; `INHERITED_FROM_PARTNER`: The assigned targeting option is inherited from partner targeting settings.; `INHERITED_FROM_ADVERTISER`: The assigned targeting option is inherited from advertiser targeting settings.' enum: - INHERITANCE_UNSPECIFIED - NOT_INHERITED - INHERITED_FROM_PARTNER - INHERITED_FROM_ADVERTISER readOnly: true appCategoryDetails: $ref: '#/components/schemas/AppCategoryAssignedTargetingOptionDetails' poiDetails: $ref: '#/components/schemas/PoiAssignedTargetingOptionDetails' nativeContentPositionDetails: $ref: '#/components/schemas/NativeContentPositionAssignedTargetingOptionDetails' languageDetails: $ref: '#/components/schemas/LanguageAssignedTargetingOptionDetails' subExchangeDetails: $ref: '#/components/schemas/SubExchangeAssignedTargetingOptionDetails' environmentDetails: $ref: '#/components/schemas/EnvironmentAssignedTargetingOptionDetails' contentInstreamPositionDetails: $ref: '#/components/schemas/ContentInstreamPositionAssignedTargetingOptionDetails' inventorySourceGroupDetails: $ref: '#/components/schemas/InventorySourceGroupAssignedTargetingOptionDetails' dayAndTimeDetails: $ref: '#/components/schemas/DayAndTimeAssignedTargetingOptionDetails' contentThemeExclusionDetails: $ref: '#/components/schemas/ContentThemeAssignedTargetingOptionDetails' proximityLocationListDetails: $ref: '#/components/schemas/ProximityLocationListAssignedTargetingOptionDetails' householdIncomeDetails: $ref: '#/components/schemas/HouseholdIncomeAssignedTargetingOptionDetails' deviceTypeDetails: $ref: '#/components/schemas/DeviceTypeAssignedTargetingOptionDetails' inventorySourceDetails: $ref: '#/components/schemas/InventorySourceAssignedTargetingOptionDetails' authorizedSellerStatusDetails: $ref: '#/components/schemas/AuthorizedSellerStatusAssignedTargetingOptionDetails' carrierAndIspDetails: $ref: '#/components/schemas/CarrierAndIspAssignedTargetingOptionDetails' youtubeChannelDetails: $ref: '#/components/schemas/YoutubeChannelAssignedTargetingOptionDetails' ageRangeDetails: $ref: '#/components/schemas/AgeRangeAssignedTargetingOptionDetails' sessionPositionDetails: $ref: '#/components/schemas/SessionPositionAssignedTargetingOptionDetails' name: type: string description: Output only. The resource name for this assigned targeting option. readOnly: true AssignedUserRole: type: object description: A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser. properties: assignedUserRoleId: type: string description: Output only. The ID of the assigned user role. readOnly: true userRole: type: string description: 'Required. The user role to assign to a user for the entity. Allowed values — `USER_ROLE_UNSPECIFIED`: Default value when the user role is not specified or is unknown in this version.; `ADMIN`: The user can manage campaigns, creatives, insertion orders, line items, and reports for the entity. They can view and edit billing information, create or modify users, and enable or disable exchanges. This role can only be assigned for a partner entity.; `ADMIN_PARTNER_CLIENT`: The user can manage campaigns, creatives, insertion orders, line items, and reports for the entity. They can create and modify other `ADMIN_PARTNER_CLIENT` users and view billing information. They cannot view revenue models, markups, or any other reseller-sensitive fields. This role can only be assigned for a partner entity.; `STANDARD`: The user can manage campaigns, creatives, insertion orders, line items, and reports for the entity. They cannot create and modify users or view billing information.; `STANDARD_PLANNER`: The user can view all campaigns, creatives, insertion orders, line items, and reports for the entity, including all cost data. They can create and modify planning-related features, including plans and inventory.; `STANDARD_PLANNER_LIMITED`: The user can view all campaigns, creatives, insertion orders, line items, and reports for the entity. They can create or modify planning-related features, including plans and inventory. They have no access to cost data and cannot start, accept, or negotiate deals.; `STANDARD_PARTNER_CLIENT`: The user can manage campaigns, creatives, insertion orders, line items, and reports for the entity. They cannot create or modify other users or view billing information. They cannot view revenue models, markups, or any other reseller-sensitive fields. This role can only be assigned for an advertiser entity.; `READ_ONLY`: The user can only build reports and view data for the entity.; `REPORTING_ONLY`: The user can only create and manage reports.; `LIMITED_REPORTING_ONLY`: The user can only create and manage the following client-safe reports: General, Audience Performance, Cross-Partner, Keyword, Order ID, Category, and Third-Party Data Provider.; `CREATIVE`: The user can view media plan information they need to collaborate, but can''t view cost-related data or Marketplace.; `CREATIVE_ADMIN`: The user can view media plan information they need to collaborate, but can''t view cost-related data or Marketplace. In addition, they can add other creative admins or creative users to the entity.' enum: - USER_ROLE_UNSPECIFIED - ADMIN - ADMIN_PARTNER_CLIENT - STANDARD - STANDARD_PLANNER - STANDARD_PLANNER_LIMITED - STANDARD_PARTNER_CLIENT - READ_ONLY - REPORTING_ONLY - LIMITED_REPORTING_ONLY - CREATIVE - CREATIVE_ADMIN partnerId: type: string format: int64 description: The ID of the partner that the assigned user role applies to. advertiserId: type: string format: int64 description: The ID of the advertiser that the assigend user role applies to. AudienceGroupAssignedTargetingOptionDetails: type: object description: Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. properties: includedCombinedAudienceGroup: $ref: '#/components/schemas/CombinedAudienceGroup' includedCustomListGroup: $ref: '#/components/schemas/CustomListGroup' includedGoogleAudienceGroup: $ref: '#/components/schemas/GoogleAudienceGroup' excludedGoogleAudienceGroup: $ref: '#/components/schemas/GoogleAudienceGroup' includedFirstPartyAndPartnerAudienceGroups: type: array description: Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. items: $ref: '#/components/schemas/FirstPartyAndPartnerAudienceGroup' excludedFirstPartyAndPartnerAudienceGroup: $ref: '#/components/schemas/FirstPartyAndPartnerAudienceGroup' AudioAd: type: object description: Details for an audio ad. properties: finalUrl: type: string description: The URL address of the webpage that people reach after they click the ad. video: $ref: '#/components/schemas/YoutubeVideoDetails' trackingUrl: type: string description: The URL address loaded in the background for tracking purposes. displayUrl: type: string description: The webpage address that appears with the ad. AudioContentTypeAssignedTargetingOptionDetails: type: object description: Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. properties: audioContentType: type: string description: 'Required. The audio content type. Allowed values — `AUDIO_CONTENT_TYPE_UNSPECIFIED`: Audio content type is not specified in this version. This enum is a place holder for a default value and does not represent a real content stream type.; `AUDIO_CONTENT_TYPE_UNKNOWN`: The audio content type is unknown.; `AUDIO_CONTENT_TYPE_MUSIC`: The audio content type is music.; `AUDIO_CONTENT_TYPE_BROADCAST`: The audio content type is broadcast.; `AUDIO_CONTENT_TYPE_PODCAST`: The audio content type is podcast.; `AUDIO_CONTENT_TYPE_CATCH_UP_RADIO`: The audio content type is catch-up radio.; `AUDIO_CONTENT_TYPE_WEB_RADIO`: The audio content type is web radio.; `AUDIO_CONTENT_TYPE_VIDEO_GAME`: The audio content type is video game.; `AUDIO_CONTENT_TYPE_TEXT_TO_SPEECH`: The audio content type is text-to-speech.' enum: - AUDIO_CONTENT_TYPE_UNSPECIFIED - AUDIO_CONTENT_TYPE_UNKNOWN - AUDIO_CONTENT_TYPE_MUSIC - AUDIO_CONTENT_TYPE_BROADCAST - AUDIO_CONTENT_TYPE_PODCAST - AUDIO_CONTENT_TYPE_CATCH_UP_RADIO - AUDIO_CONTENT_TYPE_WEB_RADIO - AUDIO_CONTENT_TYPE_VIDEO_GAME - AUDIO_CONTENT_TYPE_TEXT_TO_SPEECH AudioContentTypeTargetingOptionDetails: type: object description: Represents a targetable audio content type. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. properties: audioContentType: type: string description: 'Output only. The audio content type. Allowed values — `AUDIO_CONTENT_TYPE_UNSPECIFIED`: Audio content type is not specified in this version. This enum is a place holder for a default value and does not represent a real content stream type.; `AUDIO_CONTENT_TYPE_UNKNOWN`: The audio content type is unknown.; `AUDIO_CONTENT_TYPE_MUSIC`: The audio content type is music.; `AUDIO_CONTENT_TYPE_BROADCAST`: The audio content type is broadcast.; `AUDIO_CONTENT_TYPE_PODCAST`: The audio content type is podcast.; `AUDIO_CONTENT_TYPE_CATCH_UP_RADIO`: The audio content type is catch-up radio.; `AUDIO_CONTENT_TYPE_WEB_RADIO`: The audio content type is web radio.; `AUDIO_CONTENT_TYPE_VIDEO_GAME`: The audio content type is video game.; `AUDIO_CONTENT_TYPE_TEXT_TO_SPEECH`: The audio content type is text-to-speech.' enum: - AUDIO_CONTENT_TYPE_UNSPECIFIED - AUDIO_CONTENT_TYPE_UNKNOWN - AUDIO_CONTENT_TYPE_MUSIC - AUDIO_CONTENT_TYPE_BROADCAST - AUDIO_CONTENT_TYPE_PODCAST - AUDIO_CONTENT_TYPE_CATCH_UP_RADIO - AUDIO_CONTENT_TYPE_WEB_RADIO - AUDIO_CONTENT_TYPE_VIDEO_GAME - AUDIO_CONTENT_TYPE_TEXT_TO_SPEECH readOnly: true AudioVideoOffset: type: object description: The length an audio or a video has been played. properties: percentage: type: string format: int64 description: Optional. The offset in percentage of the audio or video duration. seconds: type: string format: int64 description: Optional. The offset in seconds from the start of the audio or video. AuditAdvertiserResponse: type: object description: Response message for AdvertiserService.AuditAdvertiser. properties: adGroupCriteriaCount: type: string format: int64 description: 'The number of individual targeting options from the following targeting types that are assigned to a line item under this advertiser. These individual targeting options count towards the limit of 4500000 ad group targeting options per advertiser. Qualifying Targeting types: * Channels, URLs, apps, and collections * Demographic * Google Audiences, including Affinity, Custom Affinity, and In-market audiences * Inventory source * Keyword * Mobile app category * User lists * Video targeting * Viewability' channelsCount: type: string format: int64 description: The number of channels created under this advertiser. These channels count towards the limit of 1000 channels per advertiser. negativelyTargetedChannelsCount: type: string format: int64 description: The number of negatively targeted channels created under this advertiser. These negatively targeted channels count towards the limit of 5 negatively targeted channels per advertiser. usedInsertionOrdersCount: type: string format: int64 description: The number of ACTIVE, PAUSED and DRAFT insertion orders under this advertiser. These insertion orders count towards the limit of 9999 insertion orders per advertiser. usedLineItemsCount: type: string format: int64 description: The number of ACTIVE, PAUSED, and DRAFT line items under this advertiser. These line items count towards the limit of 9999 line items per advertiser. usedCampaignsCount: type: string format: int64 description: The number of ACTIVE and PAUSED campaigns under this advertiser. These campaigns count towards the limit of 9999 campaigns per advertiser. negativeKeywordListsCount: type: string format: int64 description: The number of negative keyword lists created under this advertiser. These negative keyword lists count towards the limit of 20 negative keyword lists per advertiser. campaignCriteriaCount: type: string format: int64 description: 'The number of individual targeting options from the following targeting types that are assigned to a line item under this advertiser. These individual targeting options count towards the limit of 900000 campaign targeting options per advertiser. Qualifying Targeting types: * Position * Browser * Connection speed * Day and time * Device and operating system * Digital content label * Sensitive categories * Environment * Geography, including business chains and proximity * ISP * Language * Third-party verification' AuthorizedSellerStatusAssignedTargetingOptionDetails: type: object description: Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. properties: authorizedSellerStatus: type: string description: 'Output only. The authorized seller status to target. Allowed values — `AUTHORIZED_SELLER_STATUS_UNSPECIFIED`: Default value when authorized seller status is not specified in this version. This enum is a placeholder for the default value, or "Authorized Direct Sellers and Resellers" in the UI.; `AUTHORIZED_SELLER_STATUS_AUTHORIZED_DIRECT_SELLERS_ONLY`: Only authorized sellers that directly own the inventory being monetized, as indicated by a DIRECT declaration in the ads.txt file. This value is equivalent to "Authorized Direct Sellers" in the UI.; `AUTHORIZED_SELLER_STATUS_AUTHORIZED_AND_NON_PARTICIPATING_PUBLISHERS`: All authorized sellers, including publishers that have not posted an ads.txt file. Display & Video 360 automatically disallows unauthorized sellers. This value is equivalent to "Authorized and Non-Participating Publishers" in the UI.' enum: - AUTHORIZED_SELLER_STATUS_UNSPECIFIED - AUTHORIZED_SELLER_STATUS_AUTHORIZED_DIRECT_SELLERS_ONLY - AUTHORIZED_SELLER_STATUS_AUTHORIZED_AND_NON_PARTICIPATING_PUBLISHERS readOnly: true targetingOptionId: type: string description: Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. AuthorizedSellerStatusTargetingOptionDetails: type: object description: Represents a targetable authorized seller status. This will be populated in the authorized_seller_status_details field when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. properties: authorizedSellerStatus: type: string description: 'Output only. The authorized seller status. Allowed values — `AUTHORIZED_SELLER_STATUS_UNSPECIFIED`: Default value when authorized seller status is not specified in this version. This enum is a placeholder for the default value, or "Authorized Direct Sellers and Resellers" in the UI.; `AUTHORIZED_SELLER_STATUS_AUTHORIZED_DIRECT_SELLERS_ONLY`: Only authorized sellers that directly own the inventory being monetized, as indicated by a DIRECT declaration in the ads.txt file. This value is equivalent to "Authorized Direct Sellers" in the UI.; `AUTHORIZED_SELLER_STATUS_AUTHORIZED_AND_NON_PARTICIPATING_PUBLISHERS`: All authorized sellers, including publishers that have not posted an ads.txt file. Display & Video 360 automatically disallows unauthorized sellers. This value is equivalent to "Authorized and Non-Participating Publishers" in the UI.' enum: - AUTHORIZED_SELLER_STATUS_UNSPECIFIED - AUTHORIZED_SELLER_STATUS_AUTHORIZED_DIRECT_SELLERS_ONLY - AUTHORIZED_SELLER_STATUS_AUTHORIZED_AND_NON_PARTICIPATING_PUBLISHERS readOnly: true BiddingStrategy: type: object description: Settings that control the bid strategy. Bid strategy determines the bid price. properties: youtubeAndPartnersBid: $ref: '#/components/schemas/YoutubeAndPartnersBiddingStrategy' fixedBid: $ref: '#/components/schemas/FixedBidStrategy' maximizeSpendAutoBid: $ref: '#/components/schemas/MaximizeSpendBidStrategy' performanceGoalAutoBid: $ref: '#/components/schemas/PerformanceGoalBidStrategy' demandGenBid: $ref: '#/components/schemas/DemandGenBiddingStrategy' BrowserAssignedTargetingOptionDetails: type: object description: Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. properties: negative: type: boolean description: Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field. displayName: type: string description: Output only. The display name of the browser. readOnly: true targetingOptionId: type: string description: Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`. BrowserTargetingOptionDetails: type: object description: Represents a targetable browser. This will be populated in the browser_details field when targeting_type is `TARGETING_TYPE_BROWSER`. properties: displayName: type: string description: Output only. The display name of the browser. readOnly: true BudgetSummary: type: object description: Summarized information of an individual campaign budget. properties: preTaxAmountMicros: type: string format: int64 description: The sum of charges made under this budget before taxes, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar. taxAmountMicros: type: string format: int64 description: The amount of tax applied to charges under this budget, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar. prismaCpeCode: $ref: '#/components/schemas/PrismaCpeCode' externalBudgetId: type: string description: Corresponds to the external_budget_id of a campaign budget. If the value is not set in the campaign budget, this field will be empty. totalAmountMicros: type: string format: int64 description: The total sum of charges made under this budget, including tax, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar. BulkCreateAdAssetsRequest: type: object description: A request message for BulkCreateAdAssets. properties: adAssets: type: array description: Required. Ad assets to create. Only supports assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`. items: $ref: '#/components/schemas/AdAsset' BulkCreateAdAssetsResponse: type: object description: A response message for BulkCreateAdAssets. properties: adAssets: type: array description: The created ad assets. items: $ref: '#/components/schemas/AdAsset' BulkEditAdGroupAssignedTargetingOptionsRequest: type: object description: Request message for BulkEditAdGroupAssignedTargetingOptions. properties: adGroupIds: type: array description: Required. The IDs of the ad groups the assigned targeting options will belong to. A maximum of 25 ad group IDs can be specified. items: type: string format: int64 deleteRequests: type: array description: 'Optional. The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`' items: $ref: '#/components/schemas/DeleteAssignedTargetingOptionsRequest' createRequests: type: array description: 'Optional. The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionRequest`. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`' items: $ref: '#/components/schemas/CreateAssignedTargetingOptionsRequest' BulkEditAdGroupAssignedTargetingOptionsResponse: type: object description: Response message for BulkEditAssignedTargetingOptions. properties: updatedAdGroupIds: type: array description: Output only. The IDs of the ad groups which were successfully updated. readOnly: true items: type: string format: int64 errors: type: array description: Output only. The error information for each ad group that failed to update. readOnly: true items: $ref: '#/components/schemas/Status' failedAdGroupIds: type: array description: Output only. The IDs of the ad groups which failed to update. readOnly: true items: type: string format: int64 BulkEditAdvertiserAssignedTargetingOptionsRequest: type: object description: Request message for BulkEditAdvertiserAssignedTargetingOptions. properties: deleteRequests: type: array description: 'The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`' items: $ref: '#/components/schemas/DeleteAssignedTargetingOptionsRequest' createRequests: type: array description: 'The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`' items: $ref: '#/components/schemas/CreateAssignedTargetingOptionsRequest' BulkEditAdvertiserAssignedTargetingOptionsResponse: type: object properties: createdAssignedTargetingOptions: type: array description: The list of assigned targeting options that have been successfully created. This list will be absent if empty. items: $ref: '#/components/schemas/AssignedTargetingOption' BulkEditAssignedInventorySourcesRequest: type: object description: Request message for AssignedInventorySourceService.BulkEdit. properties: createdAssignedInventorySources: type: array description: The assigned inventory sources to create in bulk, specified as a list of AssignedInventorySources. items: $ref: '#/components/schemas/AssignedInventorySource' partnerId: type: string format: int64 description: The ID of the partner that owns the inventory source group. Only this partner has write access to these assigned inventory sources. advertiserId: type: string format: int64 description: The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to these assigned inventory sources. deletedAssignedInventorySources: type: array description: The IDs of the assigned inventory sources to delete in bulk, specified as a list of assigned_inventory_source_ids. items: type: string format: int64 BulkEditAssignedInventorySourcesResponse: type: object description: Response message for AssignedInventorySourceService.BulkEdit. properties: assignedInventorySources: type: array description: The list of assigned inventory sources that have been successfully created. This list will be absent if empty. items: $ref: '#/components/schemas/AssignedInventorySource' BulkEditAssignedLocationsRequest: type: object description: Request message for AssignedLocationService.BulkEditAssignedLocations. properties: deletedAssignedLocations: type: array description: The IDs of the assigned locations to delete in bulk, specified as a list of assignedLocationId values. items: type: string format: int64 createdAssignedLocations: type: array description: The assigned locations to create in bulk, specified as a list of AssignedLocation resources. items: $ref: '#/components/schemas/AssignedLocation' BulkEditAssignedLocationsResponse: type: object properties: assignedLocations: type: array description: The list of assigned locations that have been successfully created. This list will be absent if empty. items: $ref: '#/components/schemas/AssignedLocation' BulkEditAssignedTargetingOptionsRequest: type: object description: Request message for BulkEditLineItemsAssignedTargetingOptions. properties: lineItemIds: type: array description: Required. The ID of the line items whose targeting is being updated. items: type: string format: int64 createRequests: type: array description: 'The assigned targeting options to create in batch, specified as a list of CreateAssignedTargetingOptionsRequest. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`' items: $ref: '#/components/schemas/CreateAssignedTargetingOptionsRequest' deleteRequests: type: array description: 'The assigned targeting options to delete in batch, specified as a list of DeleteAssignedTargetingOptionsRequest. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`' items: $ref: '#/components/schemas/DeleteAssignedTargetingOptionsRequest' BulkEditAssignedTargetingOptionsResponse: type: object properties: errors: type: array description: The error information for each line item that failed to update. items: $ref: '#/components/schemas/Status' updatedLineItemIds: type: array description: Output only. The IDs of the line items which successfully updated. readOnly: true items: type: string format: int64 failedLineItemIds: type: array description: Output only. The IDs of the line items which failed. readOnly: true items: type: string format: int64 BulkEditAssignedUserRolesRequest: type: object description: Request message for BulkEditAssignedUserRoles. properties: deletedAssignedUserRoles: type: array description: The assigned user roles to delete in batch, specified as a list of assigned_user_role_ids. The format of assigned_user_role_id is `entityType-entityid`, for example `partner-123`. items: type: string createdAssignedUserRoles: type: array description: The assigned user roles to create in batch, specified as a list of AssignedUserRoles. items: $ref: '#/components/schemas/AssignedUserRole' BulkEditAssignedUserRolesResponse: type: object properties: createdAssignedUserRoles: type: array description: The list of assigned user roles that have been successfully created. This list will be absent if empty. items: $ref: '#/components/schemas/AssignedUserRole' BulkEditNegativeKeywordsRequest: type: object description: Request message for NegativeKeywordService.BulkEditNegativeKeywords. properties: deletedNegativeKeywords: type: array description: The negative keywords to delete in batch, specified as a list of keyword_values. items: type: string createdNegativeKeywords: type: array description: The negative keywords to create in batch, specified as a list of NegativeKeywords. items: $ref: '#/components/schemas/NegativeKeyword' BulkEditNegativeKeywordsResponse: type: object description: Response message for NegativeKeywordService.BulkEditNegativeKeywords. properties: negativeKeywords: type: array description: The list of negative keywords that have been successfully created. This list will be absent if empty. items: $ref: '#/components/schemas/NegativeKeyword' BulkEditPartnerAssignedTargetingOptionsRequest: type: object description: Request message for BulkEditPartnerAssignedTargetingOptions. properties: deleteRequests: type: array description: 'The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL`' items: $ref: '#/components/schemas/DeleteAssignedTargetingOptionsRequest' createRequests: type: array description: 'The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL`' items: $ref: '#/components/schemas/CreateAssignedTargetingOptionsRequest' BulkEditPartnerAssignedTargetingOptionsResponse: type: object properties: createdAssignedTargetingOptions: type: array description: The list of assigned targeting options that have been successfully created. This list will be absent if empty. items: $ref: '#/components/schemas/AssignedTargetingOption' BulkEditSitesRequest: type: object description: Request message for SiteService.BulkEditSites. properties: deletedSites: type: array description: The sites to delete in batch, specified as a list of site url_or_app_ids. items: type: string advertiserId: type: string format: int64 description: The ID of the advertiser that owns the parent channel. partnerId: type: string format: int64 description: The ID of the partner that owns the parent channel. createdSites: type: array description: The sites to create in batch, specified as a list of Sites. items: $ref: '#/components/schemas/Site' BulkEditSitesResponse: type: object description: Response message for SiteService.BulkEditSites. properties: sites: type: array description: The list of sites that have been successfully created. This list will be absent if empty. items: $ref: '#/components/schemas/Site' BulkListAdGroupAssignedTargetingOptionsResponse: type: object properties: adGroupAssignedTargetingOptions: type: array description: The list of wrapper objects, each providing an assigned targeting option and the ad group it is assigned to. This list will be absent if empty. items: $ref: '#/components/schemas/AdGroupAssignedTargetingOption' nextPageToken: type: string description: A token identifying the next page of results. This value should be specified as the pageToken in a subsequent call to `BulkListAdGroupAssignedTargetingOptions` to fetch the next page of results. This token will be absent if there are no more AdGroupAssignedTargetingOption resources to return. BulkListAdvertiserAssignedTargetingOptionsResponse: type: object properties: assignedTargetingOptions: type: array description: The list of assigned targeting options. This list will be absent if empty. items: $ref: '#/components/schemas/AssignedTargetingOption' nextPageToken: type: string description: A token identifying the next page of results. This value should be specified as the pageToken in a subsequent BulkListAdvertiserAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return. BulkListAssignedTargetingOptionsResponse: type: object properties: lineItemAssignedTargetingOptions: type: array description: The list of wrapper objects, each providing an assigned targeting option and the line item it is assigned to. This list will be absent if empty. items: $ref: '#/components/schemas/LineItemAssignedTargetingOption' nextPageToken: type: string description: A token identifying the next page of results. This value should be specified as the pageToken in a subsequent call to `BulkListAssignedTargetingOptions` to fetch the next page of results. This token will be absent if there are no more line_item_assigned_targeting_options to return. BulkUpdateLineItemsRequest: type: object description: Request message for LineItemService.BulkUpdateLineItems. properties: lineItemIds: type: array description: Required. IDs of line items to update. items: type: string format: int64 updateMask: type: string format: google-fieldmask description: 'Required. A field mask identifying which fields to update. Only the following fields are currently supported: * entityStatus * containsEuPoliticalAds' targetLineItem: $ref: '#/components/schemas/LineItem' BulkUpdateLineItemsResponse: type: object description: Response message for LineItemService.BulkUpdateLineItems. properties: failedLineItemIds: type: array description: The IDs of line items that failed to update. items: type: string format: int64 skippedLineItemIds: type: array description: The IDs of line items that are skipped for updates. For example, unnecessary mutates that will result in effectively no changes to line items will be skipped and corresponding line item IDs can be tracked here. items: type: string format: int64 errors: type: array description: Errors returned by line items that failed to update. items: $ref: '#/components/schemas/Status' updatedLineItemIds: type: array description: The IDs of successfully updated line items. items: type: string format: int64 BumperAd: type: object description: Details for a bumper ad. properties: commonInStreamAttribute: $ref: '#/components/schemas/CommonInStreamAttribute' BusinessChainAssignedTargetingOptionDetails: type: object description: Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. properties: displayName: type: string description: Output only. The display name of a business chain, e.g. "KFC", "Chase Bank". readOnly: true targetingOptionId: type: string description: Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions. proximityRadiusAmount: type: number format: double description: Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6. proximityRadiusUnit: type: string description: 'Required. The unit of distance by which the targeting radius is measured. Allowed values — `DISTANCE_UNIT_UNSPECIFIED`: Type value is not specified or is unknown in this version.; `DISTANCE_UNIT_MILES`: Miles.; `DISTANCE_UNIT_KILOMETERS`: Kilometers.' enum: - DISTANCE_UNIT_UNSPECIFIED - DISTANCE_UNIT_MILES - DISTANCE_UNIT_KILOMETERS BusinessChainSearchTerms: type: object description: Search terms for Business Chain targeting options. At least one of the field should be populated. properties: businessChainQuery: type: string description: The search query for the desired business chain. The query must be the full name of the business, e.g. "KFC", "mercedes-benz". regionQuery: type: string description: The search query for the desired geo region, e.g. "Seattle", "United State". BusinessChainTargetingOptionDetails: type: object description: Represents a targetable business chain within a geo region. This will be populated in the business_chain_details field when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. properties: businessChain: type: string description: Output only. The display name of the business chain, e.g. "KFC", "Chase Bank". readOnly: true geoRegion: type: string description: Output only. The display name of the geographic region, e.g. "Ontario, Canada". readOnly: true geoRegionType: type: string description: 'Output only. The type of the geographic region. Allowed values — `GEO_REGION_TYPE_UNKNOWN`: The geographic region type is unknown.; `GEO_REGION_TYPE_OTHER`: The geographic region type is other.; `GEO_REGION_TYPE_COUNTRY`: The geographic region is a country.; `GEO_REGION_TYPE_REGION`: The geographic region type is region.; `GEO_REGION_TYPE_TERRITORY`: The geographic region is a territory.; `GEO_REGION_TYPE_PROVINCE`: The geographic region is a province.; `GEO_REGION_TYPE_STATE`: The geographic region is a state.; `GEO_REGION_TYPE_PREFECTURE`: The geographic region is a prefecture.; `GEO_REGION_TYPE_GOVERNORATE`: The geographic region is a governorate.; `GEO_REGION_TYPE_CANTON`: The geographic region is a canton.; `GEO_REGION_TYPE_UNION_TERRITORY`: The geographic region is a union territory.; `GEO_REGION_TYPE_AUTONOMOUS_COMMUNITY`: The geographic region is an autonomous community.; `GEO_REGION_TYPE_DMA_REGION`: The geographic region is a designated market area (DMA) region.; `GEO_REGION_TYPE_METRO`: The geographic region type is metro.; `GEO_REGION_TYPE_CONGRESSIONAL_DISTRICT`: The geographic region is a congressional district.; `GEO_REGION_TYPE_COUNTY`: The geographic region is a county.; `GEO_REGION_TYPE_MUNICIPALITY`: The geographic region is a municipality.; `GEO_REGION_TYPE_CITY`: The geographic region is a city.; `GEO_REGION_TYPE_POSTAL_CODE`: The geographic region targeting type is postal code.; `GEO_REGION_TYPE_DEPARTMENT`: The geographic region targeting type is department.; `GEO_REGION_TYPE_AIRPORT`: The geographic region is an airport.; `GEO_REGION_TYPE_TV_REGION`: The geographic region is a TV region.; `GEO_REGION_TYPE_OKRUG`: The geographic region is an okrug.; `GEO_REGION_TYPE_BOROUGH`: The geographic region is a borough.; `GEO_REGION_TYPE_CITY_REGION`: The geographic region is a city region.; `GEO_REGION_TYPE_ARRONDISSEMENT`: The geographic region is an arrondissement.; `GEO_REGION_TYPE_NEIGHBORHOOD`: The geographic region is a neighborhood.; `GEO_REGION_TYPE_UNIVERSITY`: The geographic region is a university.; `GEO_REGION_TYPE_DISTRICT`: The geographic region is a district.; `GEO_REGION_TYPE_NATIONAL_PARK`: The geographic region is a national park.; `GEO_REGION_TYPE_BARRIO`: The geographic region is a barrio.; `GEO_REGION_TYPE_SUB_WARD`: The geographic region is a sub ward.; `GEO_REGION_TYPE_MUNICIPALITY_DISTRICT`: The geographic region is a municipality district.; `GEO_REGION_TYPE_SUB_DISTRICT`: The geographic region is a sub district.; `GEO_REGION_TYPE_QUARTER`: The geographic region is a quarter.; `GEO_REGION_TYPE_DIVISION`: The geographic region is a division.; `GEO_REGION_TYPE_COMMUNE`: The geographic region is a commune.; `GEO_REGION_TYPE_COLLOQUIAL_AREA`: The geographic region is a colloquial area.; `GEO_REGION_TYPE_POST_TOWN`: The geographic region is a post town.; `GEO_REGION_TYPE_WARD`: The geographic region is a ward.; `GEO_REGION_TYPE_TOWN`: The geographic region is a town.; `GEO_REGION_TYPE_VILLAGE`: The geographic region is a village.; `GEO_REGION_TYPE_CITY_DISTRICT`: The geographic region is a city district.; `GEO_REGION_TYPE_SUBURB`: The geographic region is a suburb.; `GEO_REGION_TYPE_HAMLET`: The geographic region is a hamlet.; `GEO_REGION_TYPE_MUNICIPAL_DISTRICT`: The geographic region is a municipal district.; `GEO_REGION_TYPE_COMMUNITY`: The geographic region is a community.; `GEO_REGION_TYPE_TOWNSHIP`: The geographic region is a township.; `GEO_REGION_TYPE_URBAN_DISTRICT`: The geographic region is an urban district.; `GEO_REGION_TYPE_RESIDENTIAL_AREA`: The geographic region is a residential area.; `GEO_REGION_TYPE_INDEPENDENT_CITY`: The geographic region is an independent city.; `GEO_REGION_TYPE_SECTOR`: The geographic region is a sector.; `GEO_REGION_TYPE_AREA`: The geographic region is an area.; `GEO_REGION_TYPE_ESTATE`: The geographic region is an estate.; `GEO_REGION_TYPE_PARISH`: The geographic region is a parish.; `GEO_REGION_TYPE_SETTLEMENT`: The geographic region is a settlement.; `GEO_REGION_TYPE_ZONE`: The geographic region is a zone.; `GEO_REGION_TYPE_COLONY`: The geographic region is a colony.; `GEO_REGION_TYPE_INDUSTRIAL_AREA`: The geographic region is an industrial area.; `GEO_REGION_TYPE_PROVINCIAL_CITY`: The geographic region is a provincial city.; `GEO_REGION_TYPE_RURAL_DISTRICT`: The geographic region is a rural district.' 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 - GEO_REGION_TYPE_NATIONAL_PARK - GEO_REGION_TYPE_BARRIO - GEO_REGION_TYPE_SUB_WARD - GEO_REGION_TYPE_MUNICIPALITY_DISTRICT - GEO_REGION_TYPE_SUB_DISTRICT - GEO_REGION_TYPE_QUARTER - GEO_REGION_TYPE_DIVISION - GEO_REGION_TYPE_COMMUNE - GEO_REGION_TYPE_COLLOQUIAL_AREA - GEO_REGION_TYPE_POST_TOWN - GEO_REGION_TYPE_WARD - GEO_REGION_TYPE_TOWN - GEO_REGION_TYPE_VILLAGE - GEO_REGION_TYPE_CITY_DISTRICT - GEO_REGION_TYPE_SUBURB - GEO_REGION_TYPE_HAMLET - GEO_REGION_TYPE_MUNICIPAL_DISTRICT - GEO_REGION_TYPE_COMMUNITY - GEO_REGION_TYPE_TOWNSHIP - GEO_REGION_TYPE_URBAN_DISTRICT - GEO_REGION_TYPE_RESIDENTIAL_AREA - GEO_REGION_TYPE_INDEPENDENT_CITY - GEO_REGION_TYPE_SECTOR - GEO_REGION_TYPE_AREA - GEO_REGION_TYPE_ESTATE - GEO_REGION_TYPE_PARISH - GEO_REGION_TYPE_SETTLEMENT - GEO_REGION_TYPE_ZONE - GEO_REGION_TYPE_COLONY - GEO_REGION_TYPE_INDUSTRIAL_AREA - GEO_REGION_TYPE_PROVINCIAL_CITY - GEO_REGION_TYPE_RURAL_DISTRICT readOnly: true Campaign: type: object description: A single campaign. properties: campaignGoal: $ref: '#/components/schemas/CampaignGoal' advertiserId: type: string format: int64 description: Output only. The unique ID of the advertiser the campaign belongs to. readOnly: true campaignId: type: string format: int64 description: Output only. The unique ID of the campaign. Assigned by the system. readOnly: true updateTime: type: string format: google-datetime description: Output only. The timestamp when the campaign was last updated. Assigned by the system. readOnly: true entityStatus: type: string description: 'Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed. Allowed values — `ENTITY_STATUS_UNSPECIFIED`: Default value when status is not specified or is unknown in this version.; `ENTITY_STATUS_ACTIVE`: The entity is enabled to bid and spend budget.; `ENTITY_STATUS_ARCHIVED`: The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.; `ENTITY_STATUS_DRAFT`: The entity is under draft. Bidding and budget spending are disabled.; `ENTITY_STATUS_PAUSED`: Bidding and budget spending are paused for the entity.; `ENTITY_STATUS_SCHEDULED_FOR_DELETION`: The entity is scheduled for deletion.' enum: - ENTITY_STATUS_UNSPECIFIED - ENTITY_STATUS_ACTIVE - ENTITY_STATUS_ARCHIVED - ENTITY_STATUS_DRAFT - ENTITY_STATUS_PAUSED - ENTITY_STATUS_SCHEDULED_FOR_DELETION campaignBudgets: type: array description: The list of budgets available to this campaign. If this field is not set, the campaign uses an unlimited budget. items: $ref: '#/components/schemas/CampaignBudget' frequencyCap: $ref: '#/components/schemas/FrequencyCap' name: type: string description: Output only. The resource name of the campaign. readOnly: true displayName: type: string description: Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes. campaignFlight: $ref: '#/components/schemas/CampaignFlight' CampaignBudget: type: object description: Settings that control how the campaign budget is allocated. properties: externalBudgetSource: type: string description: 'Required. The external source of the budget. Allowed values — `EXTERNAL_BUDGET_SOURCE_UNSPECIFIED`: External budget source value is not specified or unknown in this version.; `EXTERNAL_BUDGET_SOURCE_NONE`: Budget has no external source.; `EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN`: Budget source is Mediaocean.' enum: - EXTERNAL_BUDGET_SOURCE_UNSPECIFIED - EXTERNAL_BUDGET_SOURCE_NONE - EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN budgetId: type: string format: int64 description: The unique ID of the campaign budget. Assigned by the system. Do not set for new budgets. Must be included when updating or adding budgets to campaign_budgets. Otherwise, a new ID will be generated and assigned. externalBudgetId: type: string description: Immutable. The ID identifying this budget to the external source. If this field is set and the invoice detail level of the corresponding billing profile is set to "Budget level PO", all impressions served against this budget will include this ID on the invoice. Must be unique under the campaign. prismaConfig: $ref: '#/components/schemas/PrismaConfig' budgetAmountMicros: type: string format: int64 description: Required. The total amount the linked insertion order segments can budget. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. invoiceGroupingId: type: string description: Immutable. The ID used to group budgets to be included the same invoice. If this field is set and the invoice level of the corresponding billing profile is set to "Budget invoice grouping ID", all external_budget_id sharing the same invoice_grouping_id will be grouped in the same invoice. budgetUnit: type: string description: 'Required. Immutable. Specifies whether the budget is measured in currency or impressions. Allowed values — `BUDGET_UNIT_UNSPECIFIED`: Type value is not specified or is unknown in this version.; `BUDGET_UNIT_CURRENCY`: Budgeting in currency amounts.; `BUDGET_UNIT_IMPRESSIONS`: Budgeting in impression amounts.' enum: - BUDGET_UNIT_UNSPECIFIED - BUDGET_UNIT_CURRENCY - BUDGET_UNIT_IMPRESSIONS displayName: type: string description: Required. The display name of the budget. Must be UTF-8 encoded with a maximum size of 240 bytes. dateRange: $ref: '#/components/schemas/DateRange' CampaignDuration: type: object description: The duration of the reach plan. properties: durationDays: type: integer format: int32 description: Required. The number of days the plan covers. dateRange: $ref: '#/components/schemas/DateRange' CampaignFlight: type: object description: Settings that track the planned spend and duration of a campaign. properties: plannedDates: $ref: '#/components/schemas/DateRange' plannedSpendAmountMicros: type: string format: int64 description: The amount the campaign is expected to spend for its given planned_dates. This will not limit serving, but will be used for tracking spend in the DV360 UI. The amount is in micros. Must be greater than or equal to 0. For example, 500000000 represents 500 standard units of the currency. CampaignGoal: type: object description: Settings that control the goal of a campaign. properties: campaignGoalType: type: string description: 'Required. The type of the campaign goal. Allowed values — `CAMPAIGN_GOAL_TYPE_UNSPECIFIED`: Goal value is not specified or unknown in this version.; `CAMPAIGN_GOAL_TYPE_APP_INSTALL`: Drive app installs or engagements.; `CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS`: Raise awareness of a brand or product.; `CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION`: Drive offline or in-store sales.; `CAMPAIGN_GOAL_TYPE_ONLINE_ACTION`: Drive online action or visits.' 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 performanceGoal: $ref: '#/components/schemas/PerformanceGoal' CarouselCard: type: object description: Details for a Demand Gen carousel card. properties: headline: type: string description: Required. The headline of the card. portraitMarketingImage: $ref: '#/components/schemas/ImageAsset' finalMobileUrl: type: string description: Optional. The URL address of the webpage that people reach after they click the card on a mobile device. callToAction: type: string description: Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. finalUrl: type: string description: Required. The URL address of the webpage that people reach after they click the card. marketingImage: $ref: '#/components/schemas/ImageAsset' squareMarketingImage: $ref: '#/components/schemas/ImageAsset' CarrierAndIspAssignedTargetingOptionDetails: type: object description: Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. properties: displayName: type: string description: Output only. The display name of the carrier or ISP. readOnly: true targetingOptionId: type: string description: Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`. negative: type: boolean description: Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field. CarrierAndIspTargetingOptionDetails: type: object description: Represents a targetable carrier or ISP. This will be populated in the carrier_and_isp_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. properties: type: type: string description: 'Output only. The type indicating if it''s carrier or ISP. Allowed values — `CARRIER_AND_ISP_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `CARRIER_AND_ISP_TYPE_ISP`: Indicates this targeting resource refers to an ISP.; `CARRIER_AND_ISP_TYPE_CARRIER`: Indicates this targeting resource refers to a mobile carrier.' enum: - CARRIER_AND_ISP_TYPE_UNSPECIFIED - CARRIER_AND_ISP_TYPE_ISP - CARRIER_AND_ISP_TYPE_CARRIER readOnly: true displayName: type: string description: Output only. The display name of the carrier or ISP. readOnly: true CategoryAssignedTargetingOptionDetails: type: object description: Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. properties: negative: type: boolean description: Indicates if this option is being negatively targeted. displayName: type: string description: Output only. The display name of the category. readOnly: true targetingOptionId: type: string description: Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`. CategoryTargetingOptionDetails: type: object description: Represents a targetable category. This will be populated in the category_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CATEGORY`. properties: displayName: type: string description: Output only. The display name of the category. readOnly: true Channel: type: object description: A single channel. Channels are custom groups of related websites and apps. properties: channelId: type: string format: int64 description: Output only. The unique ID of the channel. Assigned by the system. readOnly: true partnerId: type: string format: int64 description: The ID of the partner that owns the channel. negativelyTargetedLineItemCount: type: string format: int64 description: Output only. Number of line items that are directly targeting this channel negatively. readOnly: true advertiserId: type: string format: int64 description: The ID of the advertiser that owns the channel. displayName: type: string description: Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes. positivelyTargetedLineItemCount: type: string format: int64 description: Output only. Number of line items that are directly targeting this channel positively. readOnly: true name: type: string description: Output only. The resource name of the channel. readOnly: true ChannelAssignedTargetingOptionDetails: type: object description: Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. properties: channelId: type: string format: int64 description: Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource. negative: type: boolean description: Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true. CmHybridConfig: type: object description: Settings for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers. properties: cmSyncableSiteIds: type: array description: A list of CM360 sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM360 site. Removing sites from this list may cause DV360 creatives synced from CM360 to be deleted. At least one site must be specified. items: type: string format: int64 dv360ToCmDataSharingEnabled: type: boolean description: Whether or not to include DV360 data in CM360 data transfer reports. dv360ToCmCostReportingEnabled: type: boolean description: Whether or not to report DV360 cost to CM360. cmFloodlightConfigId: type: string format: int64 description: Required. Immutable. ID of the CM360 Floodlight configuration linked with the DV360 advertiser. cmAccountId: type: string format: int64 description: Required. Immutable. Account ID of the CM360 Floodlight configuration linked with the DV360 advertiser. cmAdvertiserIds: type: array description: Output only. The set of CM360 Advertiser IDs sharing the CM360 Floodlight configuration. readOnly: true items: type: string format: int64 cmFloodlightLinkingAuthorized: type: boolean description: Required. Immutable. By setting this field to `true`, you, on behalf of your company, authorize the sharing of information from the given Floodlight configuration to this Display & Video 360 advertiser. CmTrackingAd: type: object description: A Campaign Manager 360 tracking ad. properties: cmPlacementId: type: string format: int64 description: Optional. The placement ID of the campaign manager 360 tracking Ad. cmCreativeId: type: string format: int64 description: Optional. The creative ID of the campaign manager 360 tracking Ad. cmAdId: type: string format: int64 description: Optional. The ad ID of the campaign manager 360 tracking Ad. CombinedAudience: type: object description: Describes a combined audience resource. properties: displayName: type: string description: Output only. The display name of the combined audience. . readOnly: true name: type: string description: Output only. The resource name of the combined audience. readOnly: true combinedAudienceId: type: string format: int64 description: Output only. The unique ID of the combined audience. Assigned by the system. readOnly: true CombinedAudienceGroup: type: object description: Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. properties: settings: type: array description: Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. items: $ref: '#/components/schemas/CombinedAudienceTargetingSetting' CombinedAudienceTargetingSetting: type: object description: Details of combined audience targeting setting. properties: combinedAudienceId: type: string format: int64 description: Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. CommonInStreamAttribute: type: object description: Common attributes for in-stream, non-skippable and bumper ads. properties: trackingUrl: type: string description: The URL address loaded in the background for tracking purposes. companionBanner: $ref: '#/components/schemas/ImageAsset' finalUrl: type: string description: The URL address of the webpage that people reach after they click the ad. displayUrl: type: string description: The webpage address that appears with the ad. actionButtonLabel: type: string description: The text on the call-to-action button. actionHeadline: type: string description: The headline of the call-to-action banner. video: $ref: '#/components/schemas/YoutubeVideoDetails' Consent: type: object description: User consent status. properties: adPersonalization: type: string description: 'Represents consent for ad personalization. Allowed values — `CONSENT_STATUS_UNSPECIFIED`: Type value is not specified or is unknown in this version.; `CONSENT_STATUS_GRANTED`: Consent is granted.; `CONSENT_STATUS_DENIED`: Consent is denied.' enum: - CONSENT_STATUS_UNSPECIFIED - CONSENT_STATUS_GRANTED - CONSENT_STATUS_DENIED adUserData: type: string description: 'Represents consent for ad user data. Allowed values — `CONSENT_STATUS_UNSPECIFIED`: Type value is not specified or is unknown in this version.; `CONSENT_STATUS_GRANTED`: Consent is granted.; `CONSENT_STATUS_DENIED`: Consent is denied.' enum: - CONSENT_STATUS_UNSPECIFIED - CONSENT_STATUS_GRANTED - CONSENT_STATUS_DENIED ContactInfo: type: object description: Contact information defining a Customer Match audience member. properties: hashedFirstName: type: string description: 'Optional. SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes' hashedEmails: type: array description: Optional. A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. items: type: string hashedPhoneNumbers: type: array description: Optional. A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](https://en.wikipedia.org/wiki/E.164) and include the country calling code. items: type: string countryCode: type: string description: 'Optional. Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes' hashedLastName: type: string description: 'Optional. SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes' zipCodes: type: array description: 'Optional. A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name' items: type: string ContactInfoList: type: object description: Wrapper message for a list of contact information defining Customer Match audience members. properties: contactInfos: type: array description: Optional. A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000. items: $ref: '#/components/schemas/ContactInfo' consent: $ref: '#/components/schemas/Consent' ContentDurationAssignedTargetingOptionDetails: type: object description: Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. properties: targetingOptionId: type: string description: Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. contentDuration: type: string description: 'Output only. The content duration. Allowed values — `CONTENT_DURATION_UNSPECIFIED`: Content duration is not specified in this version. This enum is a place holder for a default value and does not represent a real content duration.; `CONTENT_DURATION_UNKNOWN`: The content duration is unknown.; `CONTENT_DURATION_0_TO_1_MIN`: Content is 0-1 minute long.; `CONTENT_DURATION_1_TO_5_MIN`: Content is 1-5 minutes long.; `CONTENT_DURATION_5_TO_15_MIN`: Content is 5-15 minutes long.; `CONTENT_DURATION_15_TO_30_MIN`: Content is 15-30 minutes long.; `CONTENT_DURATION_30_TO_60_MIN`: Content is 30-60 minutes long.; `CONTENT_DURATION_OVER_60_MIN`: Content is over 60 minutes long.' enum: - CONTENT_DURATION_UNSPECIFIED - CONTENT_DURATION_UNKNOWN - CONTENT_DURATION_0_TO_1_MIN - CONTENT_DURATION_1_TO_5_MIN - CONTENT_DURATION_5_TO_15_MIN - CONTENT_DURATION_15_TO_30_MIN - CONTENT_DURATION_30_TO_60_MIN - CONTENT_DURATION_OVER_60_MIN readOnly: true ContentDurationTargetingOptionDetails: type: object description: Represents a targetable content duration. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. properties: contentDuration: type: string description: 'Output only. The content duration. Allowed values — `CONTENT_DURATION_UNSPECIFIED`: Content duration is not specified in this version. This enum is a place holder for a default value and does not represent a real content duration.; `CONTENT_DURATION_UNKNOWN`: The content duration is unknown.; `CONTENT_DURATION_0_TO_1_MIN`: Content is 0-1 minute long.; `CONTENT_DURATION_1_TO_5_MIN`: Content is 1-5 minutes long.; `CONTENT_DURATION_5_TO_15_MIN`: Content is 5-15 minutes long.; `CONTENT_DURATION_15_TO_30_MIN`: Content is 15-30 minutes long.; `CONTENT_DURATION_30_TO_60_MIN`: Content is 30-60 minutes long.; `CONTENT_DURATION_OVER_60_MIN`: Content is over 60 minutes long.' enum: - CONTENT_DURATION_UNSPECIFIED - CONTENT_DURATION_UNKNOWN - CONTENT_DURATION_0_TO_1_MIN - CONTENT_DURATION_1_TO_5_MIN - CONTENT_DURATION_5_TO_15_MIN - CONTENT_DURATION_15_TO_30_MIN - CONTENT_DURATION_30_TO_60_MIN - CONTENT_DURATION_OVER_60_MIN readOnly: true ContentGenreAssignedTargetingOptionDetails: type: object description: Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. properties: targetingOptionId: type: string description: Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. displayName: type: string description: Output only. The display name of the content genre. readOnly: true negative: type: boolean description: Indicates if this option is being negatively targeted. ContentGenreTargetingOptionDetails: type: object description: Represents a targetable content genre. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. properties: displayName: type: string description: Output only. The display name of the content genre readOnly: true ContentInstreamPositionAssignedTargetingOptionDetails: type: object description: Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. properties: contentInstreamPosition: type: string description: 'Required. The content instream position for video or audio ads. Allowed values — `CONTENT_INSTREAM_POSITION_UNSPECIFIED`: Content instream position is not specified in this version. This enum is a place holder for a default value and does not represent a real in stream ad position.; `CONTENT_INSTREAM_POSITION_PRE_ROLL`: Ads that play before streaming content.; `CONTENT_INSTREAM_POSITION_MID_ROLL`: Ads that play between the beginning and end of streaming content.; `CONTENT_INSTREAM_POSITION_POST_ROLL`: Ads that play at the end of streaming content.; `CONTENT_INSTREAM_POSITION_UNKNOWN`: Ads instream position is unknown.' enum: - CONTENT_INSTREAM_POSITION_UNSPECIFIED - CONTENT_INSTREAM_POSITION_PRE_ROLL - CONTENT_INSTREAM_POSITION_MID_ROLL - CONTENT_INSTREAM_POSITION_POST_ROLL - CONTENT_INSTREAM_POSITION_UNKNOWN adType: type: string description: 'Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`. Allowed values — `AD_TYPE_UNSPECIFIED`: Ad type is not specified or is unknown in this version.; `AD_TYPE_DISPLAY`: Display creatives, e.g. image and HTML5.; `AD_TYPE_VIDEO`: Video creatives, e.g. video ads that play during streaming content in video players.; `AD_TYPE_AUDIO`: Audio creatives, e.g. audio ads that play during audio content.' enum: - AD_TYPE_UNSPECIFIED - AD_TYPE_DISPLAY - AD_TYPE_VIDEO - AD_TYPE_AUDIO readOnly: true ContentInstreamPositionTargetingOptionDetails: type: object description: Represents a targetable content instream position, which could be used by video and audio ads. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. properties: contentInstreamPosition: type: string description: 'Output only. The content instream position. Allowed values — `CONTENT_INSTREAM_POSITION_UNSPECIFIED`: Content instream position is not specified in this version. This enum is a place holder for a default value and does not represent a real in stream ad position.; `CONTENT_INSTREAM_POSITION_PRE_ROLL`: Ads that play before streaming content.; `CONTENT_INSTREAM_POSITION_MID_ROLL`: Ads that play between the beginning and end of streaming content.; `CONTENT_INSTREAM_POSITION_POST_ROLL`: Ads that play at the end of streaming content.; `CONTENT_INSTREAM_POSITION_UNKNOWN`: Ads instream position is unknown.' enum: - CONTENT_INSTREAM_POSITION_UNSPECIFIED - CONTENT_INSTREAM_POSITION_PRE_ROLL - CONTENT_INSTREAM_POSITION_MID_ROLL - CONTENT_INSTREAM_POSITION_POST_ROLL - CONTENT_INSTREAM_POSITION_UNKNOWN readOnly: true ContentOutstreamPositionAssignedTargetingOptionDetails: type: object description: Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. properties: adType: type: string description: 'Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. Allowed values — `AD_TYPE_UNSPECIFIED`: Ad type is not specified or is unknown in this version.; `AD_TYPE_DISPLAY`: Display creatives, e.g. image and HTML5.; `AD_TYPE_VIDEO`: Video creatives, e.g. video ads that play during streaming content in video players.; `AD_TYPE_AUDIO`: Audio creatives, e.g. audio ads that play during audio content.' enum: - AD_TYPE_UNSPECIFIED - AD_TYPE_DISPLAY - AD_TYPE_VIDEO - AD_TYPE_AUDIO readOnly: true contentOutstreamPosition: type: string description: 'Required. The content outstream position. Allowed values — `CONTENT_OUTSTREAM_POSITION_UNSPECIFIED`: Content outstream position is not specified in this version. This enum is a place holder for a default value and does not represent a real content outstream position.; `CONTENT_OUTSTREAM_POSITION_UNKNOWN`: The ad position is unknown in the content outstream.; `CONTENT_OUTSTREAM_POSITION_IN_ARTICLE`: Ads that appear between the paragraphs of your pages.; `CONTENT_OUTSTREAM_POSITION_IN_BANNER`: Ads that display on the top and the sides of a page.; `CONTENT_OUTSTREAM_POSITION_IN_FEED`: Ads that appear in a scrollable stream of content. A feed is typically editorial (e.g. a list of articles or news) or listings (e.g. a list of products or services).; `CONTENT_OUTSTREAM_POSITION_INTERSTITIAL`: Ads shown before or between content loads.' 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 ContentOutstreamPositionTargetingOptionDetails: type: object description: Represents a targetable content outstream position, which could be used by display and video ads. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. properties: contentOutstreamPosition: type: string description: 'Output only. The content outstream position. Allowed values — `CONTENT_OUTSTREAM_POSITION_UNSPECIFIED`: Content outstream position is not specified in this version. This enum is a place holder for a default value and does not represent a real content outstream position.; `CONTENT_OUTSTREAM_POSITION_UNKNOWN`: The ad position is unknown in the content outstream.; `CONTENT_OUTSTREAM_POSITION_IN_ARTICLE`: Ads that appear between the paragraphs of your pages.; `CONTENT_OUTSTREAM_POSITION_IN_BANNER`: Ads that display on the top and the sides of a page.; `CONTENT_OUTSTREAM_POSITION_IN_FEED`: Ads that appear in a scrollable stream of content. A feed is typically editorial (e.g. a list of articles or news) or listings (e.g. a list of products or services).; `CONTENT_OUTSTREAM_POSITION_INTERSTITIAL`: Ads shown before or between content loads.' 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 readOnly: true ContentStreamTypeAssignedTargetingOptionDetails: type: object description: Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. properties: targetingOptionId: type: string description: Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. contentStreamType: type: string description: 'Output only. The content stream type. Allowed values — `CONTENT_STREAM_TYPE_UNSPECIFIED`: Content stream type is not specified in this version. This enum is a place holder for a default value and does not represent a real content stream type.; `CONTENT_LIVE_STREAM`: The content is being live-streamed.; `CONTENT_ON_DEMAND`: The content is viewed on-demand.' enum: - CONTENT_STREAM_TYPE_UNSPECIFIED - CONTENT_LIVE_STREAM - CONTENT_ON_DEMAND readOnly: true ContentStreamTypeTargetingOptionDetails: type: object description: Represents a targetable content stream type. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. properties: contentStreamType: type: string description: 'Output only. The content stream type. Allowed values — `CONTENT_STREAM_TYPE_UNSPECIFIED`: Content stream type is not specified in this version. This enum is a place holder for a default value and does not represent a real content stream type.; `CONTENT_LIVE_STREAM`: The content is being live-streamed.; `CONTENT_ON_DEMAND`: The content is viewed on-demand.' enum: - CONTENT_STREAM_TYPE_UNSPECIFIED - CONTENT_LIVE_STREAM - CONTENT_ON_DEMAND readOnly: true ContentThemeAssignedTargetingOptionDetails: type: object description: Targeting details for content theme. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. properties: excludedTargetingOptionId: type: string description: Required. ID of the content theme to be EXCLUDED. contentTheme: type: string description: 'Output only. An enum for the DV360 content theme classifier. Allowed values — `CONTENT_THEME_UNSPECIFIED`: Content theme is not specified or is unknown in this version.; `CONTENT_THEME_FIGHTING_VIDEO_GAMES`: Fighting video games.; `CONTENT_THEME_MATURE_GAMES`: Mature games.; `CONTENT_THEME_NOT_YET_DETERMINED_HEALTH_SOURCES`: Not yet determined health sources.; `CONTENT_THEME_NOT_YET_DETERMINED_NEWS_SOURCES`: Not yet determined news sources.; `CONTENT_THEME_POLITICS`: Politics.; `CONTENT_THEME_RECENT_NEWS`: Recent news.; `CONTENT_THEME_RELIGION`: Religion.; `CONTENT_THEME_UNPLEASANT_HEALTH_CONTENT`: Unpleasant health content.; `CONTENT_THEME_UNPLEASANT_NEWS`: Unpleasant news.' enum: - CONTENT_THEME_UNSPECIFIED - CONTENT_THEME_FIGHTING_VIDEO_GAMES - CONTENT_THEME_MATURE_GAMES - CONTENT_THEME_NOT_YET_DETERMINED_HEALTH_SOURCES - CONTENT_THEME_NOT_YET_DETERMINED_NEWS_SOURCES - CONTENT_THEME_POLITICS - CONTENT_THEME_RECENT_NEWS - CONTENT_THEME_RELIGION - CONTENT_THEME_UNPLEASANT_HEALTH_CONTENT - CONTENT_THEME_UNPLEASANT_NEWS readOnly: true excludedContentTheme: type: string description: 'Required. An enum for the DV360 content theme classified to be EXCLUDED. Allowed values — `CONTENT_THEME_UNSPECIFIED`: Content theme is not specified or is unknown in this version.; `CONTENT_THEME_FIGHTING_VIDEO_GAMES`: Fighting video games.; `CONTENT_THEME_MATURE_GAMES`: Mature games.; `CONTENT_THEME_NOT_YET_DETERMINED_HEALTH_SOURCES`: Not yet determined health sources.; `CONTENT_THEME_NOT_YET_DETERMINED_NEWS_SOURCES`: Not yet determined news sources.; `CONTENT_THEME_POLITICS`: Politics.; `CONTENT_THEME_RECENT_NEWS`: Recent news.; `CONTENT_THEME_RELIGION`: Religion.; `CONTENT_THEME_UNPLEASANT_HEALTH_CONTENT`: Unpleasant health content.; `CONTENT_THEME_UNPLEASANT_NEWS`: Unpleasant news.' enum: - CONTENT_THEME_UNSPECIFIED - CONTENT_THEME_FIGHTING_VIDEO_GAMES - CONTENT_THEME_MATURE_GAMES - CONTENT_THEME_NOT_YET_DETERMINED_HEALTH_SOURCES - CONTENT_THEME_NOT_YET_DETERMINED_NEWS_SOURCES - CONTENT_THEME_POLITICS - CONTENT_THEME_RECENT_NEWS - CONTENT_THEME_RELIGION - CONTENT_THEME_UNPLEASANT_HEALTH_CONTENT - CONTENT_THEME_UNPLEASANT_NEWS ContentThemeTargetingOptionDetails: type: object description: Represents a targetable content theme. This will be populated in the content_theme_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. properties: contentTheme: type: string description: 'Output only. An enum for the DV360 content theme content classifier. Allowed values — `CONTENT_THEME_UNSPECIFIED`: Content theme is not specified or is unknown in this version.; `CONTENT_THEME_FIGHTING_VIDEO_GAMES`: Fighting video games.; `CONTENT_THEME_MATURE_GAMES`: Mature games.; `CONTENT_THEME_NOT_YET_DETERMINED_HEALTH_SOURCES`: Not yet determined health sources.; `CONTENT_THEME_NOT_YET_DETERMINED_NEWS_SOURCES`: Not yet determined news sources.; `CONTENT_THEME_POLITICS`: Politics.; `CONTENT_THEME_RECENT_NEWS`: Recent news.; `CONTENT_THEME_RELIGION`: Religion.; `CONTENT_THEME_UNPLEASANT_HEALTH_CONTENT`: Unpleasant health content.; `CONTENT_THEME_UNPLEASANT_NEWS`: Unpleasant news.' enum: - CONTENT_THEME_UNSPECIFIED - CONTENT_THEME_FIGHTING_VIDEO_GAMES - CONTENT_THEME_MATURE_GAMES - CONTENT_THEME_NOT_YET_DETERMINED_HEALTH_SOURCES - CONTENT_THEME_NOT_YET_DETERMINED_NEWS_SOURCES - CONTENT_THEME_POLITICS - CONTENT_THEME_RECENT_NEWS - CONTENT_THEME_RELIGION - CONTENT_THEME_UNPLEASANT_HEALTH_CONTENT - CONTENT_THEME_UNPLEASANT_NEWS readOnly: true ConversionCountingConfig: type: object description: Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. properties: floodlightActivityConfigs: type: array description: The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. items: $ref: '#/components/schemas/TrackingFloodlightActivityConfig' primaryAttributionModelId: type: string format: int64 description: Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. postViewCountPercentageMillis: type: string format: int64 description: The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. CounterEvent: type: object description: Counter event of the creative. properties: reportingName: type: string description: Required. The name used to identify this counter event in reports. name: type: string description: Required. The name of the counter event. CreateAdAssetRequest: type: object description: A request message for CreateAdAsset. properties: adAsset: $ref: '#/components/schemas/AdAsset' CreateAssetRequest: type: object description: A request message for CreateAsset. properties: filename: type: string description: Required. The filename of the asset, including the file extension. The filename must be UTF-8 encoded with a maximum size of 240 bytes. CreateAssetResponse: type: object description: A response message for CreateAsset. properties: asset: $ref: '#/components/schemas/Asset' CreateAssignedTargetingOptionsRequest: type: object description: A request listing which assigned targeting options of a given targeting type should be created and added. properties: targetingType: type: string description: 'Required. Identifies the type of this assigned targeting option. Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack.' 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 - TARGETING_TYPE_POI - TARGETING_TYPE_BUSINESS_CHAIN - TARGETING_TYPE_CONTENT_DURATION - TARGETING_TYPE_CONTENT_STREAM_TYPE - TARGETING_TYPE_NATIVE_CONTENT_POSITION - TARGETING_TYPE_OMID - TARGETING_TYPE_AUDIO_CONTENT_TYPE - TARGETING_TYPE_CONTENT_GENRE - TARGETING_TYPE_YOUTUBE_VIDEO - TARGETING_TYPE_YOUTUBE_CHANNEL - TARGETING_TYPE_SESSION_POSITION - TARGETING_TYPE_CONTENT_THEME_EXCLUSION - TARGETING_TYPE_YOUTUBE_CHANNEL_PACK assignedTargetingOptions: type: array description: Required. The assigned targeting options to create and add. items: $ref: '#/components/schemas/AssignedTargetingOption' CreateSdfDownloadTaskRequest: type: object description: Request message for [SdfDownloadTaskService.CreateSdfDownloadTask]. properties: advertiserId: type: string format: int64 description: The ID of the advertiser to download SDF for. partnerId: type: string format: int64 description: The ID of the partner to download SDF for. inventorySourceFilter: $ref: '#/components/schemas/InventorySourceFilter' parentEntityFilter: $ref: '#/components/schemas/ParentEntityFilter' idFilter: $ref: '#/components/schemas/IdFilter' version: type: string description: 'Required. The SDF version of the downloaded file. If set to `SDF_VERSION_UNSPECIFIED`, this will default to the version specified by the advertiser or partner identified by `root_id`. An advertiser inherits its SDF version from its partner unless configured otherwise. Allowed values — `SDF_VERSION_UNSPECIFIED`: SDF version value is not specified or is unknown in this version.; `SDF_VERSION_3_1`: SDF version 3.1; `SDF_VERSION_4`: SDF version 4; `SDF_VERSION_4_1`: SDF version 4.1; `SDF_VERSION_4_2`: SDF version 4.2; `SDF_VERSION_5`: SDF version 5.; `SDF_VERSION_5_1`: SDF version 5.1; `SDF_VERSION_5_2`: SDF version 5.2; `SDF_VERSION_5_3`: SDF version 5.3; `SDF_VERSION_5_4`: SDF version 5.4; `SDF_VERSION_5_5`: SDF version 5.5; `SDF_VERSION_6`: SDF version 6; `SDF_VERSION_7`: SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.; `SDF_VERSION_7_1`: SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.; `SDF_VERSION_8`: SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.; `SDF_VERSION_8_1`: SDF version 8.1.; `SDF_VERSION_9`: SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.; `SDF_VERSION_9_1`: SDF version 9.1.; `SDF_VERSION_9_2`: SDF version 9.2.; `SDF_VERSION_10`: SDF version 10.; `SDF_VERSION_10_1`: SDF version 10.1.' 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 - SDF_VERSION_5_2 - SDF_VERSION_5_3 - SDF_VERSION_5_4 - SDF_VERSION_5_5 - SDF_VERSION_6 - SDF_VERSION_7 - SDF_VERSION_7_1 - SDF_VERSION_8 - SDF_VERSION_8_1 - SDF_VERSION_9 - SDF_VERSION_9_1 - SDF_VERSION_9_2 - SDF_VERSION_10 - SDF_VERSION_10_1 Creative: type: object description: A single Creative. properties: dynamic: type: boolean description: Output only. Indicates whether the creative is dynamic. readOnly: true companionCreativeIds: type: array description: 'Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher''s video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`' items: type: string format: int64 reviewStatus: $ref: '#/components/schemas/ReviewStatusInfo' skipOffset: $ref: '#/components/schemas/AudioVideoOffset' progressOffset: $ref: '#/components/schemas/AudioVideoOffset' vpaid: type: boolean description: 'Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video Player-Ad Interface). Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`' readOnly: true iasCampaignMonitoring: type: boolean description: Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. requireMraid: type: boolean description: 'Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`' assets: type: array description: Required. Assets associated to this creative. items: $ref: '#/components/schemas/AssetAssociation' updateTime: type: string format: google-datetime description: Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system. readOnly: true integrationCode: type: string description: Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. createTime: type: string format: google-datetime description: Output only. The timestamp when the creative was created. Assigned by the system. readOnly: true expandingDirection: type: string description: 'Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE` Allowed values — `EXPANDING_DIRECTION_UNSPECIFIED`: The expanding direction is not specified.; `EXPANDING_DIRECTION_NONE`: Does not expand in any direction.; `EXPANDING_DIRECTION_UP`: Expands up.; `EXPANDING_DIRECTION_DOWN`: Expands down.; `EXPANDING_DIRECTION_LEFT`: Expands left.; `EXPANDING_DIRECTION_RIGHT`: Expands right.; `EXPANDING_DIRECTION_UP_AND_LEFT`: Expands up and to the left side.; `EXPANDING_DIRECTION_UP_AND_RIGHT`: Expands up and to the right side.; `EXPANDING_DIRECTION_DOWN_AND_LEFT`: Expands down and to the left side.; `EXPANDING_DIRECTION_DOWN_AND_RIGHT`: Expands down and to the right side.; `EXPANDING_DIRECTION_UP_OR_DOWN`: Expands either up or down.; `EXPANDING_DIRECTION_LEFT_OR_RIGHT`: Expands to either the left or the right side.; `EXPANDING_DIRECTION_ANY_DIAGONAL`: Can expand in any diagonal direction.' 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 dimensions: $ref: '#/components/schemas/Dimensions' creativeType: type: string description: 'Required. Immutable. The type of the creative. Allowed values — `CREATIVE_TYPE_UNSPECIFIED`: Type value is not specified or is unknown in this version.; `CREATIVE_TYPE_STANDARD`: Standard display creative. Create and update methods are supported for this creative type if the hosting_source is one of the following: * `HOSTING_SOURCE_HOSTED` * `HOSTING_SOURCE_THIRD_PARTY`; `CREATIVE_TYPE_EXPANDABLE`: Expandable creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_THIRD_PARTY`; `CREATIVE_TYPE_VIDEO`: Video creative. Create and update methods are supported for this creative type if the hosting_source is one of the following: * `HOSTING_SOURCE_HOSTED` * `HOSTING_SOURCE_THIRD_PARTY`; `CREATIVE_TYPE_NATIVE`: Native creative rendered by publishers with assets from advertiser. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`; `CREATIVE_TYPE_TEMPLATED_APP_INSTALL`: Templated app install mobile creative (banner). Create and update methods are **not** supported for this creative type.; `CREATIVE_TYPE_NATIVE_SITE_SQUARE`: Square native creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`; `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL`: Interstitial creative including both display and video. Create and update methods are **not** supported for this creative type.; `CREATIVE_TYPE_LIGHTBOX`: Responsive and expandable Lightbox creative. Create and update methods are **not** supported for this creative type.; `CREATIVE_TYPE_NATIVE_APP_INSTALL`: Native app install creative. Create and update methods are **not** supported for this creative type.; `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`: Square native app install creative. Create and update methods are **not** supported for this creative type.; `CREATIVE_TYPE_AUDIO`: Audio creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`; `CREATIVE_TYPE_PUBLISHER_HOSTED`: Publisher hosted creative. Create and update methods are **not** supported for this creative type.; `CREATIVE_TYPE_NATIVE_VIDEO`: Native video creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`; `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO`: Templated app install mobile video creative. Create and update methods are **not** supported for this creative type.; `CREATIVE_TYPE_ASSET_BASED_CREATIVE`: Asset-based creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`.' 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 - CREATIVE_TYPE_ASSET_BASED_CREATIVE thirdPartyUrls: type: array description: 'Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO`' items: $ref: '#/components/schemas/ThirdPartyUrl' requirePingForAttribution: type: boolean description: 'Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager 360 tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`' timerEvents: type: array description: Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. items: $ref: '#/components/schemas/TimerEvent' advertiserId: type: string format: int64 description: Output only. The unique ID of the advertiser the creative belongs to. readOnly: true requireHtml5: type: boolean description: 'Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`' oggAudio: type: boolean description: 'Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`' readOnly: true transcodes: type: array description: 'Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher''s system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO`' readOnly: true items: $ref: '#/components/schemas/Transcode' vastTagUrl: type: string description: 'Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`' html5Video: type: boolean description: 'Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`' readOnly: true lineItemIds: type: array description: Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead. readOnly: true items: type: string format: int64 notes: type: string description: Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. additionalDimensions: type: array description: 'Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0.' items: $ref: '#/components/schemas/Dimensions' universalAdId: $ref: '#/components/schemas/UniversalAdId' entityStatus: type: string description: 'Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED` Allowed values — `ENTITY_STATUS_UNSPECIFIED`: Default value when status is not specified or is unknown in this version.; `ENTITY_STATUS_ACTIVE`: The entity is enabled to bid and spend budget.; `ENTITY_STATUS_ARCHIVED`: The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.; `ENTITY_STATUS_DRAFT`: The entity is under draft. Bidding and budget spending are disabled.; `ENTITY_STATUS_PAUSED`: Bidding and budget spending are paused for the entity.; `ENTITY_STATUS_SCHEDULED_FOR_DELETION`: The entity is scheduled for deletion.' enum: - ENTITY_STATUS_UNSPECIFIED - ENTITY_STATUS_ACTIVE - ENTITY_STATUS_ARCHIVED - ENTITY_STATUS_DRAFT - ENTITY_STATUS_PAUSED - ENTITY_STATUS_SCHEDULED_FOR_DELETION cmTrackingAd: $ref: '#/components/schemas/CmTrackingAd' syntheticContentAttestationStatus: type: string description: 'Optional. Whether to add a label to the creative as created or edited using AI when served in regions with local AI labeling regulations. Allowed values — `SYNTHETIC_CONTENT_ATTESTATION_STATUS_UNSPECIFIED`: No attestation has been provided.; `NOT_SYNTHETIC`: Attested as not created or edited using AI.; `IS_SYNTHETIC`: Attested as created or edited using AI.' enum: - SYNTHETIC_CONTENT_ATTESTATION_STATUS_UNSPECIFIED - NOT_SYNTHETIC - IS_SYNTHETIC skippable: type: boolean description: 'Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`' counterEvents: type: array description: Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. items: $ref: '#/components/schemas/CounterEvent' displayName: type: string description: Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes. hostingSource: type: string description: 'Required. Indicates where the creative is hosted. Allowed values — `HOSTING_SOURCE_UNSPECIFIED`: Hosting source is not specified or is unknown in this version.; `HOSTING_SOURCE_CM`: A creative synced from Campaign Manager 360. Create and update methods are **not** supported for this hosting type.; `HOSTING_SOURCE_THIRD_PARTY`: A creative hosted by a third-party ad server (3PAS). Create and update methods are supported for this hosting type if the creative_type is one of the following: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`; `HOSTING_SOURCE_HOSTED`: A creative created in DV360 and hosted by Campaign Manager 360. Create and update methods are supported for this hosting type if the creative_type is one of the following: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`; `HOSTING_SOURCE_RICH_MEDIA`: A rich media creative created in Studio and hosted by Campaign Manager 360. Create and update methods are **not** supported for this hosting type.' enum: - HOSTING_SOURCE_UNSPECIFIED - HOSTING_SOURCE_CM - HOSTING_SOURCE_THIRD_PARTY - HOSTING_SOURCE_HOSTED - HOSTING_SOURCE_RICH_MEDIA name: type: string description: Output only. The resource name of the creative. readOnly: true exitEvents: type: array description: 'Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser''s landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer''s tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats.' items: $ref: '#/components/schemas/ExitEvent' jsTrackerUrl: type: string description: 'Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`' thirdPartyTag: type: string description: 'Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`' cmPlacementId: type: string format: int64 description: Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager. readOnly: true appendedTag: type: string description: Optional. Third-party HTML tracking tag to be appended to the creative tag. obaIcon: $ref: '#/components/schemas/ObaIcon' trackerUrls: type: array description: 'Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn''t require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`' items: type: string creativeAttributes: type: array description: Output only. A list of attributes of the creative that is generated by the system. readOnly: true items: type: string enum: - CREATIVE_ATTRIBUTE_UNSPECIFIED - CREATIVE_ATTRIBUTE_VAST - CREATIVE_ATTRIBUTE_VPAID_LINEAR - CREATIVE_ATTRIBUTE_VPAID_NON_LINEAR description: 'Allowed values — `CREATIVE_ATTRIBUTE_UNSPECIFIED`: The creative attribute is not specified or is unknown in this version.; `CREATIVE_ATTRIBUTE_VAST`: The creative is a VAST creative.; `CREATIVE_ATTRIBUTE_VPAID_LINEAR`: The creative is a linear VPAID creative.; `CREATIVE_ATTRIBUTE_VPAID_NON_LINEAR`: The creative is a non-linear VPAID creative.' expandOnHover: type: boolean description: 'Optional. Indicates the creative will automatically expand on hover. Optional and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`' mp3Audio: type: boolean description: 'Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`' readOnly: true creativeId: type: string format: int64 description: Output only. The unique ID of the creative. Assigned by the system. readOnly: true mediaDuration: type: string format: google-duration description: 'Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED`' readOnly: true CreativeConfig: type: object description: Creative requirements configuration for the inventory source. properties: displayCreativeConfig: $ref: '#/components/schemas/InventorySourceDisplayCreativeConfig' videoCreativeConfig: $ref: '#/components/schemas/InventorySourceVideoCreativeConfig' creativeType: type: string description: 'The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO` Allowed values — `CREATIVE_TYPE_UNSPECIFIED`: Type value is not specified or is unknown in this version.; `CREATIVE_TYPE_STANDARD`: Standard display creative. Create and update methods are supported for this creative type if the hosting_source is one of the following: * `HOSTING_SOURCE_HOSTED` * `HOSTING_SOURCE_THIRD_PARTY`; `CREATIVE_TYPE_EXPANDABLE`: Expandable creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_THIRD_PARTY`; `CREATIVE_TYPE_VIDEO`: Video creative. Create and update methods are supported for this creative type if the hosting_source is one of the following: * `HOSTING_SOURCE_HOSTED` * `HOSTING_SOURCE_THIRD_PARTY`; `CREATIVE_TYPE_NATIVE`: Native creative rendered by publishers with assets from advertiser. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`; `CREATIVE_TYPE_TEMPLATED_APP_INSTALL`: Templated app install mobile creative (banner). Create and update methods are **not** supported for this creative type.; `CREATIVE_TYPE_NATIVE_SITE_SQUARE`: Square native creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`; `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL`: Interstitial creative including both display and video. Create and update methods are **not** supported for this creative type.; `CREATIVE_TYPE_LIGHTBOX`: Responsive and expandable Lightbox creative. Create and update methods are **not** supported for this creative type.; `CREATIVE_TYPE_NATIVE_APP_INSTALL`: Native app install creative. Create and update methods are **not** supported for this creative type.; `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`: Square native app install creative. Create and update methods are **not** supported for this creative type.; `CREATIVE_TYPE_AUDIO`: Audio creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`; `CREATIVE_TYPE_PUBLISHER_HOSTED`: Publisher hosted creative. Create and update methods are **not** supported for this creative type.; `CREATIVE_TYPE_NATIVE_VIDEO`: Native video creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`; `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO`: Templated app install mobile video creative. Create and update methods are **not** supported for this creative type.; `CREATIVE_TYPE_ASSET_BASED_CREATIVE`: Asset-based creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`.' 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 - CREATIVE_TYPE_ASSET_BASED_CREATIVE CustomBiddingAlgorithm: type: object description: A single custom bidding algorithm. properties: customBiddingAlgorithmType: type: string description: 'Required. Immutable. The type of custom bidding algorithm. Allowed values — `CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED`: Algorithm type is not specified or is unknown in this version.; `SCRIPT_BASED`: Algorithm generated through customer-uploaded custom bidding script files.; `RULE_BASED`: Algorithm based in defined rules. These rules are defined in the API using the AlgorithmRules object. This algorithm type is only available to allowlisted customers. Other customers attempting to use this type will receive an error.' enum: - CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED - SCRIPT_BASED - RULE_BASED name: type: string description: Output only. The resource name of the custom bidding algorithm. readOnly: true customBiddingAlgorithmId: type: string format: int64 description: Output only. The unique ID of the custom bidding algorithm. Assigned by the system. readOnly: true displayName: type: string description: Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes. partnerId: type: string format: int64 description: Immutable. The unique ID of the partner that owns the custom bidding algorithm. thirdPartyOptimizationPartner: type: string description: 'Optional. Immutable. Designates the third party optimization partner that manages this algorithm. Allowed values — `UNKNOWN`: Type value is not specified or is unknown in this version.; `SCIBIDS`: Third party data science service provider that DV3 partners/advertisers can partner with.; `ADELAIDE`: Third party attention measurement service provider that DV3 partners/advertisers can partner with.' enum: - UNKNOWN - SCIBIDS - ADELAIDE advertiserId: type: string format: int64 description: Immutable. The unique ID of the advertiser that owns the custom bidding algorithm. sharedAdvertiserIds: type: array description: The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor). items: type: string format: int64 modelDetails: type: array description: Output only. The details of custom bidding models for each advertiser who has access. This field may only include the details of the queried advertiser if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor). readOnly: true items: $ref: '#/components/schemas/CustomBiddingModelDetails' entityStatus: type: string description: 'Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` Allowed values — `ENTITY_STATUS_UNSPECIFIED`: Default value when status is not specified or is unknown in this version.; `ENTITY_STATUS_ACTIVE`: The entity is enabled to bid and spend budget.; `ENTITY_STATUS_ARCHIVED`: The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.; `ENTITY_STATUS_DRAFT`: The entity is under draft. Bidding and budget spending are disabled.; `ENTITY_STATUS_PAUSED`: Bidding and budget spending are paused for the entity.; `ENTITY_STATUS_SCHEDULED_FOR_DELETION`: The entity is scheduled for deletion.' enum: - ENTITY_STATUS_UNSPECIFIED - ENTITY_STATUS_ACTIVE - ENTITY_STATUS_ARCHIVED - ENTITY_STATUS_DRAFT - ENTITY_STATUS_PAUSED - ENTITY_STATUS_SCHEDULED_FOR_DELETION CustomBiddingAlgorithmRules: type: object description: A single custom bidding algorithm rules. properties: active: type: boolean description: Output only. Whether the rules resource is currently being used for scoring by the parent algorithm. readOnly: true error: $ref: '#/components/schemas/CustomBiddingAlgorithmRulesError' name: type: string description: Output only. The resource name of the rules resource. readOnly: true customBiddingAlgorithmId: type: string format: int64 description: Output only. The unique ID of the custom bidding algorithm that the rules resource belongs to. readOnly: true createTime: type: string format: google-datetime description: Output only. The time when the rules resource was created. readOnly: true state: type: string description: 'Output only. The state of the rules resource. Allowed values — `STATE_UNSPECIFIED`: The rules state are unspecified or unknown in this version.; `ACCEPTED`: The rules have been accepted for scoring impressions.; `REJECTED`: The rules have been rejected by backend pipelines. They may have errors.' enum: - STATE_UNSPECIFIED - ACCEPTED - REJECTED readOnly: true customBiddingAlgorithmRulesId: type: string format: int64 description: Output only. The unique ID of the rules resource. readOnly: true rules: $ref: '#/components/schemas/CustomBiddingAlgorithmRulesRef' CustomBiddingAlgorithmRulesError: type: object description: An error message for a CustomBiddingAlgorithmRules resource. properties: errorCode: type: string description: 'The type of error. Allowed values — `ERROR_CODE_UNSPECIFIED`: The error is not specified or is unknown in this version.; `SYNTAX_ERROR`: The rules have a syntax error.; `CONSTRAINT_VIOLATION_ERROR`: The rules have a constraint violation error.; `INTERNAL_ERROR`: Internal errors were thrown while processing the rules.' enum: - ERROR_CODE_UNSPECIFIED - SYNTAX_ERROR - CONSTRAINT_VIOLATION_ERROR - INTERNAL_ERROR CustomBiddingAlgorithmRulesRef: type: object description: The reference to the uploaded AlgorithmRules file. Retrieve the location to upload new AlgorithmRules file to using customBiddingAlgorithms.uploadRules. properties: resourceName: type: string description: A resource name to be used in media.download to download the rules files. Or media.upload to upload the rules files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/rulesRef/{ref_id}`. CustomBiddingModelDetails: type: object description: The details of a custom bidding algorithm model for a single shared advertiser. properties: advertiserId: type: string format: int64 description: The unique ID of the relevant advertiser. readinessState: type: string description: 'The readiness state of custom bidding model. Allowed values — `READINESS_STATE_UNSPECIFIED`: State is not specified or is unknown in this version.; `READINESS_STATE_ACTIVE`: The model is trained and ready for serving.; `READINESS_STATE_INSUFFICIENT_DATA`: There is not enough data to train the serving model.; `READINESS_STATE_TRAINING`: The model is training and not ready for serving.; `READINESS_STATE_NO_VALID_SCRIPT`: A valid custom bidding script has not been provided with which to train the model. This state will only be applied to algorithms whose `custom_bidding_algorithm_type` is `SCRIPT_BASED`.; `READINESS_STATE_EVALUATION_FAILURE`: A valid script was provided but failed evaluation. This is applicable for scripts that could not be evaluated in the alloted time.' enum: - READINESS_STATE_UNSPECIFIED - READINESS_STATE_ACTIVE - READINESS_STATE_INSUFFICIENT_DATA - READINESS_STATE_TRAINING - READINESS_STATE_NO_VALID_SCRIPT - READINESS_STATE_EVALUATION_FAILURE suspensionState: type: string description: 'Output only. The suspension state of custom bidding model. Allowed values — `SUSPENSION_STATE_UNSPECIFIED`: State is not specified or is unknown in this version.; `SUSPENSION_STATE_ENABLED`: Model is enabled, either recently used, currently used or scheduled to be used. The algorithm is actively scoring impressions for this advertiser.; `SUSPENSION_STATE_DORMANT`: Model has not been used recently. Although the model still acts as `ENABLED`, it will eventually be suspended if not used.; `SUSPENSION_STATE_SUSPENDED`: Model is suspended from scoring impressions and cannot serve. If the algorithm is assigned to a line item under this advertiser or otherwise updated, it will switch back to the `ENABLED` state and require time to prepare the serving model again.' enum: - SUSPENSION_STATE_UNSPECIFIED - SUSPENSION_STATE_ENABLED - SUSPENSION_STATE_DORMANT - SUSPENSION_STATE_SUSPENDED readOnly: true CustomBiddingScript: type: object description: A single custom bidding script. properties: active: type: boolean description: Output only. Whether the script is currently being used for scoring by the parent algorithm. readOnly: true errors: type: array description: Output only. Error details of a rejected custom bidding script. This field will only be populated when state is REJECTED. readOnly: true items: $ref: '#/components/schemas/ScriptError' script: $ref: '#/components/schemas/CustomBiddingScriptRef' customBiddingScriptId: type: string format: int64 description: Output only. The unique ID of the custom bidding script. readOnly: true createTime: type: string format: google-datetime description: Output only. The time when the script was created. readOnly: true state: type: string description: 'Output only. The state of the custom bidding script. Allowed values — `STATE_UNSPECIFIED`: The script state is not specified or is unknown in this version.; `ACCEPTED`: The script has been accepted for scoring impressions.; `REJECTED`: The script has been rejected by backend pipelines. It may have errors.; `PENDING`: The script is being processed for backend pipelines.' enum: - STATE_UNSPECIFIED - ACCEPTED - REJECTED - PENDING readOnly: true name: type: string description: Output only. The resource name of the custom bidding script. readOnly: true customBiddingAlgorithmId: type: string format: int64 description: Output only. The unique ID of the custom bidding algorithm the script belongs to. readOnly: true CustomBiddingScriptRef: type: object description: The reference to the uploaded custom bidding script file. properties: resourceName: type: string description: A resource name to be used in media.download to Download the script files. Or media.upload to Upload the script files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/scriptRef/{ref_id}`. CustomLabel: type: object description: The key and value of a custom label. properties: key: type: string description: 'The key of the label. Allowed values — `CUSTOM_LABEL_KEY_UNSPECIFIED`: Not specified or unknown.; `CUSTOM_LABEL_KEY_0`: Key index 0.; `CUSTOM_LABEL_KEY_1`: Key index 1.; `CUSTOM_LABEL_KEY_2`: Key index 2.; `CUSTOM_LABEL_KEY_3`: Key index 3.; `CUSTOM_LABEL_KEY_4`: Key index 4.' enum: - CUSTOM_LABEL_KEY_UNSPECIFIED - CUSTOM_LABEL_KEY_0 - CUSTOM_LABEL_KEY_1 - CUSTOM_LABEL_KEY_2 - CUSTOM_LABEL_KEY_3 - CUSTOM_LABEL_KEY_4 value: type: string description: The value of the label. CustomList: type: object description: Describes a custom list entity, such as a custom affinity or custom intent audience list. properties: name: type: string description: Output only. The resource name of the custom list. readOnly: true customListId: type: string format: int64 description: Output only. The unique ID of the custom list. Assigned by the system. readOnly: true displayName: type: string description: Output only. The display name of the custom list. . readOnly: true CustomListGroup: type: object description: Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. properties: settings: type: array description: Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. items: $ref: '#/components/schemas/CustomListTargetingSetting' CustomListTargetingSetting: type: object description: Details of custom list targeting setting. properties: customListId: type: string format: int64 description: Required. Custom id of custom list targeting setting. This id is custom_list_id. Date: type: object description: 'Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp' properties: year: type: integer format: int32 description: Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. month: type: integer format: int32 description: Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. day: type: integer format: int32 description: Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. DateRange: type: object description: A date range. properties: startDate: $ref: '#/components/schemas/Date' endDate: $ref: '#/components/schemas/Date' DayAndTimeAssignedTargetingOptionDetails: type: object description: Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. properties: startHour: type: integer format: int32 description: Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). endHour: type: integer format: int32 description: Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). dayOfWeek: type: string description: 'Required. The day of the week for this day and time targeting setting. Allowed values — `DAY_OF_WEEK_UNSPECIFIED`: The day of the week is unspecified.; `MONDAY`: Monday; `TUESDAY`: Tuesday; `WEDNESDAY`: Wednesday; `THURSDAY`: Thursday; `FRIDAY`: Friday; `SATURDAY`: Saturday; `SUNDAY`: Sunday' enum: - DAY_OF_WEEK_UNSPECIFIED - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY timeZoneResolution: type: string description: 'Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. Allowed values — `TIME_ZONE_RESOLUTION_UNSPECIFIED`: Time zone resolution is either unspecific or unknown.; `TIME_ZONE_RESOLUTION_END_USER`: Times are resolved in the time zone of the user that saw the ad.; `TIME_ZONE_RESOLUTION_ADVERTISER`: Times are resolved in the time zone of the advertiser that served the ad.' enum: - TIME_ZONE_RESOLUTION_UNSPECIFIED - TIME_ZONE_RESOLUTION_END_USER - TIME_ZONE_RESOLUTION_ADVERTISER DcmTrackingInfo: type: object description: Details on the DCM tracking. properties: creativeId: type: string format: int64 description: Required. The DCM creative id. placementId: type: string format: int64 description: Required. The DCM placement id. trackingAdId: type: string format: int64 description: Required. The DCM tracking ad id. DeleteAssignedTargetingOptionsRequest: type: object description: A request listing which assigned targeting options of a given targeting type should be deleted. properties: targetingType: type: string description: 'Required. Identifies the type of this assigned targeting option. Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack.' 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 - TARGETING_TYPE_POI - TARGETING_TYPE_BUSINESS_CHAIN - TARGETING_TYPE_CONTENT_DURATION - TARGETING_TYPE_CONTENT_STREAM_TYPE - TARGETING_TYPE_NATIVE_CONTENT_POSITION - TARGETING_TYPE_OMID - TARGETING_TYPE_AUDIO_CONTENT_TYPE - TARGETING_TYPE_CONTENT_GENRE - TARGETING_TYPE_YOUTUBE_VIDEO - TARGETING_TYPE_YOUTUBE_CHANNEL - TARGETING_TYPE_SESSION_POSITION - TARGETING_TYPE_CONTENT_THEME_EXCLUSION - TARGETING_TYPE_YOUTUBE_CHANNEL_PACK assignedTargetingOptionIds: type: array description: Required. The assigned targeting option IDs to delete. items: type: string DemandGenBiddingStrategy: type: object description: Settings that control the bid strategy for Demand Gen resources. properties: value: type: string format: int64 description: 'Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser''s currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0.' effectiveBiddingValueSource: type: string description: 'Output only. Source of the effective bidding value. Allowed values — `BIDDING_SOURCE_UNSPECIFIED`: Bidding source is not specified or unknown.; `BIDDING_SOURCE_LINE_ITEM`: Bidding value is inherited from the line item.; `BIDDING_SOURCE_AD_GROUP`: Bidding value is defined in the ad group.' enum: - BIDDING_SOURCE_UNSPECIFIED - BIDDING_SOURCE_LINE_ITEM - BIDDING_SOURCE_AD_GROUP readOnly: true type: type: string description: 'Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. Allowed values — `DEMAND_GEN_BIDDING_STRATEGY_TYPE_UNSPECIFIED`: Type is not specified or unknown.; `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA`: A bidding strategy that automatically optimizes conversions per dollar.; `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`: A bidding strategy that automatically maximizes revenue while averaging a specific target Return On Ad Spend (ROAS).; `DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS`: A bidding strategy that automatically maximizes number of conversions; `DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSION_VALUE`: A bidding strategy that automatically maximizes revenue while spending your budget.; `DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CLICKS`: A bidding strategy that automatically maximizes clicks within a given budget.; `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC`: A bidding strategy that automatically optimizes cost per click.' enum: - DEMAND_GEN_BIDDING_STRATEGY_TYPE_UNSPECIFIED - DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA - DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS - DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS - DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSION_VALUE - DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CLICKS - DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC effectiveBiddingValue: type: string format: int64 description: Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. readOnly: true DemandGenCarouselAd: type: object description: Details for a Demand Gen carousel ad. properties: headline: type: string description: Required. The headline of the ad. customParameters: type: object description: Optional. The custom parameters and accompanying values to add to the tracking URL. additionalProperties: type: string logo: $ref: '#/components/schemas/ImageAsset' description: type: string description: Required. The description of the ad. businessName: type: string description: Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. userSpecifiedTrackingUrl: type: string description: Optional. The tracking URL specified by the user manually. trackingUrl: type: string description: Output only. The URL address loaded in the background for tracking purposes. readOnly: true cards: type: array description: Required. The list of cards shown on the ad. items: $ref: '#/components/schemas/CarouselCard' finalUrl: type: string description: Required. The URL address of the webpage that people reach after they click the ad. finalUrlSuffix: type: string description: Optional. The suffix to append to landing page URLs. DemandGenImageAd: type: object description: Details for a Demand Gen image ad. properties: logoImages: type: array description: The list of logo images shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. items: $ref: '#/components/schemas/ImageAsset' descriptions: type: array description: Required. The list of descriptions shown on the ad. items: type: string portraitMarketingImages: type: array description: The list of portrait marketing images shown on the ad. items: $ref: '#/components/schemas/ImageAsset' marketingImages: type: array description: The list of marketing images shown on the ad. items: $ref: '#/components/schemas/ImageAsset' finalUrlSuffix: type: string description: Optional. The suffix to append to landing page URLs. customParameters: type: object description: Optional. The custom parameters and accompanying values to add to the tracking URL. additionalProperties: type: string callToAction: type: string description: Required. The call-to-action button shown on the ad. businessName: type: string description: Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. finalMobileUrl: type: string description: Optional. The URL address of the webpage that people reach after they click the ad on a mobile device. userSpecifiedTrackingUrl: type: string description: Optional. The tracking URL specified by the user manually. headlines: type: array description: Required. The list of headlines shown on the ad. items: type: string squareMarketingImages: type: array description: The list of square marketing images shown on the ad. items: $ref: '#/components/schemas/ImageAsset' finalUrl: type: string description: Required. The URL address of the webpage that people reach after they click the ad. trackingUrl: type: string description: Output only. The URL address loaded in the background for tracking purposes. readOnly: true DemandGenProductAd: type: object description: Details for a Demand Gen product ad. properties: customParameters: type: object description: Optional. The custom parameters and accompanying values to add to the tracking URL. additionalProperties: type: string logo: $ref: '#/components/schemas/ImageAsset' headline: type: string description: Required. The headline of the ad. businessName: type: string description: Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. callToAction: type: string description: 'Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` Allowed values — `CALL_TO_ACTION_UNSPECIFIED`: Not specified or unknown.; `AUTOMATED`: Automated.; `LEARN_MORE`: Learn more.; `GET_QUOTE`: Get quote.; `APPLY_NOW`: Apply now.; `SIGN_UP`: Sign up.; `CONTACT_US`: Contact us.; `SUBSCRIBE`: Subscribe.; `DOWNLOAD`: Download.; `BOOK_NOW`: Book now.; `SHOP_NOW`: Shop now.; `BUY_NOW`: Buy now.; `DONATE_NOW`: Donate now.; `ORDER_NOW`: Order now.; `PLAY_NOW`: Play now.; `SEE_MORE`: See more.; `START_NOW`: Start now.; `VISIT_SITE`: Visit site.; `WATCH_NOW`: Watch now.' enum: - CALL_TO_ACTION_UNSPECIFIED - AUTOMATED - LEARN_MORE - GET_QUOTE - APPLY_NOW - SIGN_UP - CONTACT_US - SUBSCRIBE - DOWNLOAD - BOOK_NOW - SHOP_NOW - BUY_NOW - DONATE_NOW - ORDER_NOW - PLAY_NOW - SEE_MORE - START_NOW - VISIT_SITE - WATCH_NOW description: type: string description: Required. The description of the ad. userSpecifiedTrackingUrl: type: string description: Optional. The tracking URL specified by the user manually. displayUrlBreadcrumb1: type: string description: Optional. The first piece after the domain in the display URL. finalUrl: type: string description: Required. The URL address of the webpage that people reach after they click the ad. finalUrlSuffix: type: string description: Optional. The suffix to append to landing page URLs. trackingUrl: type: string description: Output only. The URL address loaded in the background for tracking purposes. readOnly: true displayUrlBreadcrumb2: type: string description: Optional. The second piece after the domain in the display URL. DemandGenSettings: type: object description: Settings for Demand Gen line items. properties: geoLanguageTargetingEnabled: type: boolean description: Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. thirdPartyMeasurementConfigs: $ref: '#/components/schemas/ThirdPartyMeasurementConfigs' linkedMerchantId: type: string format: int64 description: Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. DemandGenVideoAd: type: object description: Details for a Demand Gen video ad. properties: logo: $ref: '#/components/schemas/ImageAsset' descriptions: type: array description: Required. The list of descriptions shown on the ad. items: type: string finalUrlSuffix: type: string description: Optional. The suffix to append to landing page URLs. customParameters: type: object description: Optional. The custom parameters and accompanying values to add to the tracking URL. additionalProperties: type: string callToAction: type: string description: 'Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` Allowed values — `CALL_TO_ACTION_UNSPECIFIED`: Not specified or unknown.; `AUTOMATED`: Automated.; `LEARN_MORE`: Learn more.; `GET_QUOTE`: Get quote.; `APPLY_NOW`: Apply now.; `SIGN_UP`: Sign up.; `CONTACT_US`: Contact us.; `SUBSCRIBE`: Subscribe.; `DOWNLOAD`: Download.; `BOOK_NOW`: Book now.; `SHOP_NOW`: Shop now.; `BUY_NOW`: Buy now.; `DONATE_NOW`: Donate now.; `ORDER_NOW`: Order now.; `PLAY_NOW`: Play now.; `SEE_MORE`: See more.; `START_NOW`: Start now.; `VISIT_SITE`: Visit site.; `WATCH_NOW`: Watch now.' enum: - CALL_TO_ACTION_UNSPECIFIED - AUTOMATED - LEARN_MORE - GET_QUOTE - APPLY_NOW - SIGN_UP - CONTACT_US - SUBSCRIBE - DOWNLOAD - BOOK_NOW - SHOP_NOW - BUY_NOW - DONATE_NOW - ORDER_NOW - PLAY_NOW - SEE_MORE - START_NOW - VISIT_SITE - WATCH_NOW businessName: type: string description: Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. companionBanner: $ref: '#/components/schemas/ImageAsset' finalMobileUrl: type: string description: Optional. The URL address of the webpage that people reach after they click the ad on a mobile device. userSpecifiedTrackingUrl: type: string description: Optional. The tracking URL specified by the user manually. displayUrlBreadcrumb1: type: string description: Optional. The first piece after the domain in the display URL. headlines: type: array description: Required. The list of headlines shown on the ad. items: type: string longHeadlines: type: array description: Required. The list of long headlines shown on the ad. items: type: string videos: type: array description: Required. The list of YouTube video assets used by this ad. items: $ref: '#/components/schemas/YoutubeVideoDetails' finalUrl: type: string description: Required. The URL address of the webpage that people reach after they click the ad. trackingUrl: type: string description: Output only. The URL address loaded in the background for tracking purposes. readOnly: true displayUrlBreadcrumb2: type: string description: Optional. The second piece after the domain in the display URL. DeviceMakeModelAssignedTargetingOptionDetails: type: object description: Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. properties: negative: type: boolean description: Indicates if this option is being negatively targeted. displayName: type: string description: Output only. The display name of the device make and model. readOnly: true targetingOptionId: type: string description: Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. DeviceMakeModelTargetingOptionDetails: type: object description: Represents a targetable device make and model. This will be populated in the device_make_model_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. properties: displayName: type: string description: Output only. The display name of the device make and model. readOnly: true DeviceTypeAssignedTargetingOptionDetails: type: object description: Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. properties: deviceType: type: string description: 'Required. The display name of the device type. Allowed values — `DEVICE_TYPE_UNSPECIFIED`: Default value when device type is not specified in this version. This enum is a placeholder for default value and does not represent a real device type option.; `DEVICE_TYPE_COMPUTER`: Computer.; `DEVICE_TYPE_CONNECTED_TV`: Connected TV.; `DEVICE_TYPE_SMART_PHONE`: Smart phone.; `DEVICE_TYPE_TABLET`: Tablet.; `DEVICE_TYPE_CONNECTED_DEVICE`: Connected device.' enum: - DEVICE_TYPE_UNSPECIFIED - DEVICE_TYPE_COMPUTER - DEVICE_TYPE_CONNECTED_TV - DEVICE_TYPE_SMART_PHONE - DEVICE_TYPE_TABLET - DEVICE_TYPE_CONNECTED_DEVICE youtubeAndPartnersBidMultiplier: type: number format: double description: Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. readOnly: true DeviceTypeTargetingOptionDetails: type: object description: Represents a targetable device type. This will be populated in the device_type_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. properties: deviceType: type: string description: 'Output only. The device type that is used to be targeted. Allowed values — `DEVICE_TYPE_UNSPECIFIED`: Default value when device type is not specified in this version. This enum is a placeholder for default value and does not represent a real device type option.; `DEVICE_TYPE_COMPUTER`: Computer.; `DEVICE_TYPE_CONNECTED_TV`: Connected TV.; `DEVICE_TYPE_SMART_PHONE`: Smart phone.; `DEVICE_TYPE_TABLET`: Tablet.; `DEVICE_TYPE_CONNECTED_DEVICE`: Connected device.' enum: - DEVICE_TYPE_UNSPECIFIED - DEVICE_TYPE_COMPUTER - DEVICE_TYPE_CONNECTED_TV - DEVICE_TYPE_SMART_PHONE - DEVICE_TYPE_TABLET - DEVICE_TYPE_CONNECTED_DEVICE readOnly: true DigitalContentLabelAssignedTargetingOptionDetails: type: object description: Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. properties: excludedContentRatingTier: type: string description: 'Required. The display name of the digital content label rating tier to be EXCLUDED. Allowed values — `CONTENT_RATING_TIER_UNSPECIFIED`: Content label is not specified in this version. This enum is a place holder for a default value and does not represent a real content rating.; `CONTENT_RATING_TIER_UNRATED`: Content that has not been labeled.; `CONTENT_RATING_TIER_GENERAL`: Content suitable for general audiences.; `CONTENT_RATING_TIER_PARENTAL_GUIDANCE`: Content suitable for most audiences with parental guidance.; `CONTENT_RATING_TIER_TEENS`: Content suitable for teen and older audiences.; `CONTENT_RATING_TIER_MATURE`: Content suitable only for mature audiences.; `CONTENT_RATING_TIER_FAMILIES`: Content suitable for family audiences. It is a subset of CONTENT_RATING_TIER_GENERAL. Only applicable to YouTube and Partners line items.' 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 - CONTENT_RATING_TIER_FAMILIES DigitalContentLabelTargetingOptionDetails: type: object description: Represents a targetable digital content label rating tier. This will be populated in the digital_content_label_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. properties: contentRatingTier: type: string description: 'Output only. An enum for the content label brand safety tiers. Allowed values — `CONTENT_RATING_TIER_UNSPECIFIED`: Content label is not specified in this version. This enum is a place holder for a default value and does not represent a real content rating.; `CONTENT_RATING_TIER_UNRATED`: Content that has not been labeled.; `CONTENT_RATING_TIER_GENERAL`: Content suitable for general audiences.; `CONTENT_RATING_TIER_PARENTAL_GUIDANCE`: Content suitable for most audiences with parental guidance.; `CONTENT_RATING_TIER_TEENS`: Content suitable for teen and older audiences.; `CONTENT_RATING_TIER_MATURE`: Content suitable only for mature audiences.; `CONTENT_RATING_TIER_FAMILIES`: Content suitable for family audiences. It is a subset of CONTENT_RATING_TIER_GENERAL. Only applicable to YouTube and Partners line items.' 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 - CONTENT_RATING_TIER_FAMILIES readOnly: true Dimensions: type: object description: Dimensions. properties: widthPixels: type: integer format: int32 description: The width in pixels. heightPixels: type: integer format: int32 description: The height in pixels. DisplayVideoSourceAd: type: object description: The ad sourced from a DV360 creative. properties: creativeId: type: string format: int64 description: The ID of the source creative. DoubleVerify: type: object description: Details of DoubleVerify settings. properties: fraudInvalidTraffic: $ref: '#/components/schemas/DoubleVerifyFraudInvalidTraffic' appStarRating: $ref: '#/components/schemas/DoubleVerifyAppStarRating' customSegmentId: type: string format: int64 description: 'The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic' displayViewability: $ref: '#/components/schemas/DoubleVerifyDisplayViewability' avoidedAgeRatings: type: array description: Avoid bidding on apps with the age rating. items: type: string 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 description: 'Allowed values — `AGE_RATING_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any age rating options.; `APP_AGE_RATE_UNKNOWN`: Apps with unknown age rating.; `APP_AGE_RATE_4_PLUS`: Apps rated for Everyone (4+).; `APP_AGE_RATE_9_PLUS`: Apps rated for Everyone (9+).; `APP_AGE_RATE_12_PLUS`: Apps rated for Teens (12+).; `APP_AGE_RATE_17_PLUS`: Apps rated for Mature (17+).; `APP_AGE_RATE_18_PLUS`: Apps rated for Adults Only (18+).' videoViewability: $ref: '#/components/schemas/DoubleVerifyVideoViewability' brandSafetyCategories: $ref: '#/components/schemas/DoubleVerifyBrandSafetyCategories' DoubleVerifyAppStarRating: type: object description: Details of DoubleVerify star ratings settings. properties: avoidedStarRating: type: string description: 'Avoid bidding on apps with the star ratings. Allowed values — `APP_STAR_RATE_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any app star rating options.; `APP_STAR_RATE_1_POINT_5_LESS`: Official Apps with rating < 1.5 Stars.; `APP_STAR_RATE_2_LESS`: Official Apps with rating < 2 Stars.; `APP_STAR_RATE_2_POINT_5_LESS`: Official Apps with rating < 2.5 Stars.; `APP_STAR_RATE_3_LESS`: Official Apps with rating < 3 Stars.; `APP_STAR_RATE_3_POINT_5_LESS`: Official Apps with rating < 3.5 Stars.; `APP_STAR_RATE_4_LESS`: Official Apps with rating < 4 Stars.; `APP_STAR_RATE_4_POINT_5_LESS`: Official Apps with rating < 4.5 Stars.' 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 avoidInsufficientStarRating: type: boolean description: Avoid bidding on apps with insufficient star ratings. DoubleVerifyBrandSafetyCategories: type: object description: Settings for brand safety controls. properties: avoidedMediumSeverityCategories: type: array description: Brand safety medium severity avoidance categories. items: type: string 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 description: 'Allowed values — `MEDIUM_SEVERITY_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any medium severity categories.; `AD_SERVERS`: Ad Servers.; `ADULT_CONTENT_SWIMSUIT`: Adult Content: Swimsuit.; `ALTERNATIVE_LIFESTYLES`: Controversial Subjects: Alternative Lifestyles.; `CELEBRITY_GOSSIP`: Controversial Subjects: Celebrity Gossip.; `GAMBLING`: Controversial Subjects: Gambling.; `OCCULT`: Controversial Subjects: Occult.; `SEX_EDUCATION`: Controversial Subjects: Sex Education.; `DISASTER_AVIATION`: Disaster: Aviation.; `DISASTER_MAN_MADE`: Disaster: Man-made.; `DISASTER_NATURAL`: Disaster: Natural.; `DISASTER_TERRORIST_EVENTS`: Disaster: Terrorist Events.; `DISASTER_VEHICLE`: Disaster: Vehicle.; `ALCOHOL`: Drugs/Alcohol/Controlled Substances: Alcohol.; `SMOKING`: Drugs/Alcohol/Controlled Substances: Smoking.; `NEGATIVE_NEWS_FINANCIAL`: Negative News: Financial.; `NON_ENGLISH`: Non-Std Content: Non-English.; `PARKING_PAGE`: Non-Std Content: Parking Page.; `UNMODERATED_UGC`: Unmoderated UGC: Forums, Images & Video.; `INFLAMMATORY_POLITICS_AND_NEWS`: Controversial Subjects: Inflammatory Politics and News.; `NEGATIVE_NEWS_PHARMACEUTICAL`: Negative News: Pharmaceutical.' avoidUnknownBrandSafetyCategory: type: boolean description: Unknown or unrateable. avoidedHighSeverityCategories: type: array description: Brand safety high severity avoidance categories. items: type: string enum: - HIGHER_SEVERITY_UNSPECIFIED - ADULT_CONTENT_PORNOGRAPHY - COPYRIGHT_INFRINGEMENT - SUBSTANCE_ABUSE - GRAPHIC_VIOLENCE_WEAPONS - HATE_PROFANITY - CRIMINAL_SKILLS - NUISANCE_INCENTIVIZED_MALWARE_CLUTTER description: 'Allowed values — `HIGHER_SEVERITY_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any high severity categories.; `ADULT_CONTENT_PORNOGRAPHY`: Adult Content: Pornography, Mature Topics & Nudity.; `COPYRIGHT_INFRINGEMENT`: Copyright Infringement.; `SUBSTANCE_ABUSE`: Drugs/Alcohol/Controlled Substances: Substance Abuse.; `GRAPHIC_VIOLENCE_WEAPONS`: Extreme Graphic/Explicit Violence/Weapons.; `HATE_PROFANITY`: Hate/Profanity.; `CRIMINAL_SKILLS`: Illegal Activities: Criminal Skills.; `NUISANCE_INCENTIVIZED_MALWARE_CLUTTER`: Incentivized/Malware/Clutter.' DoubleVerifyDisplayViewability: type: object description: Details of DoubleVerify display viewability settings. properties: iab: type: string description: 'Target web and app inventory to maximize IAB viewable rate. Allowed values — `IAB_VIEWED_RATE_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any IAB viewed rate options.; `IAB_VIEWED_RATE_80_PERCENT_HIGHER`: Target web and app inventory to maximize IAB viewable rate 80% or higher.; `IAB_VIEWED_RATE_75_PERCENT_HIGHER`: Target web and app inventory to maximize IAB viewable rate 75% or higher.; `IAB_VIEWED_RATE_70_PERCENT_HIGHER`: Target web and app inventory to maximize IAB viewable rate 70% or higher.; `IAB_VIEWED_RATE_65_PERCENT_HIGHER`: Target web and app inventory to maximize IAB viewable rate 65% or higher.; `IAB_VIEWED_RATE_60_PERCENT_HIGHER`: Target web and app inventory to maximize IAB viewable rate 60% or higher.; `IAB_VIEWED_RATE_55_PERCENT_HIGHER`: Target web and app inventory to maximize IAB viewable rate 55% or higher.; `IAB_VIEWED_RATE_50_PERCENT_HIGHER`: Target web and app inventory to maximize IAB viewable rate 50% or higher.; `IAB_VIEWED_RATE_40_PERCENT_HIGHER`: Target web and app inventory to maximize IAB viewable rate 40% or higher.; `IAB_VIEWED_RATE_30_PERCENT_HIGHER`: Target web and app inventory to maximize IAB viewable rate 30% or higher.' 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 viewableDuring: type: string description: 'Target web and app inventory to maximize 100% viewable duration. Allowed values — `AVERAGE_VIEW_DURATION_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any average view duration options.; `AVERAGE_VIEW_DURATION_5_SEC`: Target web and app inventory to maximize 100% viewable duration 5 seconds or more.; `AVERAGE_VIEW_DURATION_10_SEC`: Target web and app inventory to maximize 100% viewable duration 10 seconds or more.; `AVERAGE_VIEW_DURATION_15_SEC`: Target web and app inventory to maximize 100% viewable duration 15 seconds or more.' enum: - AVERAGE_VIEW_DURATION_UNSPECIFIED - AVERAGE_VIEW_DURATION_5_SEC - AVERAGE_VIEW_DURATION_10_SEC - AVERAGE_VIEW_DURATION_15_SEC DoubleVerifyFraudInvalidTraffic: type: object description: DoubleVerify Fraud & Invalid Traffic settings. properties: avoidedFraudOption: type: string description: 'Avoid Sites and Apps with historical Fraud & IVT. Allowed values — `FRAUD_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any fraud and invalid traffic options.; `AD_IMPRESSION_FRAUD_100`: 100% Fraud & IVT.; `AD_IMPRESSION_FRAUD_50`: 50% or Higher Fraud & IVT.; `AD_IMPRESSION_FRAUD_25`: 25% or Higher Fraud & IVT.; `AD_IMPRESSION_FRAUD_10`: 10% or Higher Fraud & IVT.; `AD_IMPRESSION_FRAUD_8`: 8% or Higher Fraud & IVT.; `AD_IMPRESSION_FRAUD_6`: 6% or Higher Fraud & IVT.; `AD_IMPRESSION_FRAUD_4`: 4% or Higher Fraud & IVT.; `AD_IMPRESSION_FRAUD_2`: 2% or Higher Fraud & 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 avoidInsufficientOption: type: boolean description: Insufficient Historical Fraud & IVT Stats. DoubleVerifyVideoViewability: type: object description: Details of DoubleVerify video viewability settings. properties: videoViewableRate: type: string description: 'Target web inventory to maximize fully viewable rate. Allowed values — `VIDEO_VIEWABLE_RATE_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any video viewable rate options.; `VIEWED_PERFORMANCE_40_PERCENT_HIGHER`: Target web inventory to maximize fully viewable rate 40% or higher.; `VIEWED_PERFORMANCE_35_PERCENT_HIGHER`: Target web inventory to maximize fully viewable rate 35% or higher.; `VIEWED_PERFORMANCE_30_PERCENT_HIGHER`: Target web inventory to maximize fully viewable rate 30% or higher.; `VIEWED_PERFORMANCE_25_PERCENT_HIGHER`: Target web inventory to maximize fully viewable rate 25% or higher.; `VIEWED_PERFORMANCE_20_PERCENT_HIGHER`: Target web inventory to maximize fully viewable rate 20% or higher.; `VIEWED_PERFORMANCE_10_PERCENT_HIGHER`: Target web inventory to maximize fully viewable rate 10% or higher.' 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 playerImpressionRate: type: string description: 'Target inventory to maximize impressions with 400x300 or greater player size. Allowed values — `PLAYER_SIZE_400X300_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any impressions options.; `PLAYER_SIZE_400X300_95`: Sites with 95%+ of impressions.; `PLAYER_SIZE_400X300_70`: Sites with 70%+ of impressions.; `PLAYER_SIZE_400X300_25`: Sites with 25%+ of impressions.; `PLAYER_SIZE_400X300_5`: Sites with 5%+ of impressions.' enum: - PLAYER_SIZE_400X300_UNSPECIFIED - PLAYER_SIZE_400X300_95 - PLAYER_SIZE_400X300_70 - PLAYER_SIZE_400X300_25 - PLAYER_SIZE_400X300_5 videoIab: type: string description: 'Target web inventory to maximize IAB viewable rate. Allowed values — `VIDEO_IAB_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any video IAB viewable rate options.; `IAB_VIEWABILITY_80_PERCENT_HIGHER`: Target web and app inventory to maximize IAB viewable rate 80% or higher.; `IAB_VIEWABILITY_75_PERCENT_HIGHER`: Target web and app inventory to maximize IAB viewable rate 75% or higher.; `IAB_VIEWABILITY_70_PERCENT_HIGHER`: Target web and app inventory to maximize IAB viewable rate 70% or higher.; `IAB_VIEWABILITY_65_PERCENT_HIHGER`: Target web and app inventory to maximize IAB viewable rate 65% or higher.; `IAB_VIEWABILITY_60_PERCENT_HIGHER`: Target web and app inventory to maximize IAB viewable rate 60% or higher.; `IAB_VIEWABILITY_55_PERCENT_HIHGER`: Target web and app inventory to maximize IAB viewable rate 55% or higher.; `IAB_VIEWABILITY_50_PERCENT_HIGHER`: Target web and app inventory to maximize IAB viewable rate 50% or higher.; `IAB_VIEWABILITY_40_PERCENT_HIHGER`: Target web and app inventory to maximize IAB viewable rate 40% or higher.; `IAB_VIEWABILITY_30_PERCENT_HIHGER`: Target web and app inventory to maximize IAB viewable rate 30% or higher.' 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 DuplicateLineItemRequest: type: object description: Request message for LineItemService.DuplicateLineItem. properties: containsEuPoliticalAds: type: string description: 'Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**. Allowed values — `EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN`: Unknown.; `CONTAINS_EU_POLITICAL_ADVERTISING`: Contains EU political advertising.; `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING`: Does not contain EU political advertising.' enum: - EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN - CONTAINS_EU_POLITICAL_ADVERTISING - DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING targetDisplayName: type: string description: The display name of the new line item. Must be UTF-8 encoded with a maximum size of 240 bytes. DuplicateLineItemResponse: type: object properties: duplicateLineItemId: type: string format: int64 description: The ID of the created line item. EditCustomerMatchMembersRequest: type: object description: Request message for FirstPartyAndPartnerAudienceService.EditCustomerMatchMembers. properties: removedContactInfoList: $ref: '#/components/schemas/ContactInfoList' addedMobileDeviceIdList: $ref: '#/components/schemas/MobileDeviceIdList' addedContactInfoList: $ref: '#/components/schemas/ContactInfoList' advertiserId: type: string format: int64 description: Required. The ID of the owner advertiser of the updated Customer Match FirstAndThirdPartyAudience. removedMobileDeviceIdList: $ref: '#/components/schemas/MobileDeviceIdList' EditCustomerMatchMembersResponse: type: object description: The response of FirstPartyAndPartnerAudienceService.EditCustomerMatchMembers. properties: firstPartyAndPartnerAudienceId: type: string format: int64 description: Required. The ID of the updated Customer Match FirstPartyAndPartnerAudience. EditGuaranteedOrderReadAccessorsRequest: type: object description: Request message for GuaranteedOrderService.EditGuaranteedOrderReadAccessors. properties: partnerId: type: string format: int64 description: Required. The partner context in which the change is being made. readAccessInherited: type: boolean description: Whether to give all advertisers of the read/write accessor partner read access to the guaranteed order. Only applicable if read_write_partner_id is set in the guaranteed order. addedAdvertisers: type: array description: The advertisers to add as read accessors to the guaranteed order. items: type: string format: int64 removedAdvertisers: type: array description: The advertisers to remove as read accessors to the guaranteed order. items: type: string format: int64 EditGuaranteedOrderReadAccessorsResponse: type: object properties: readAccessInherited: type: boolean description: Whether all advertisers of read_write_partner_id have read access to the guaranteed order. readAdvertiserIds: type: array description: The IDs of advertisers with read access to the guaranteed order. items: type: string format: int64 EditInventorySourceReadWriteAccessorsRequest: type: object description: Request message for InventorySourceService.EditInventorySourceReadWriteAccessors. properties: assignPartner: type: boolean description: Set the partner context as read/write accessor of the inventory source. This will remove all other current read/write advertiser accessors. advertisersUpdate: $ref: '#/components/schemas/EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate' partnerId: type: string format: int64 description: Required. The partner context by which the accessors change is being made. EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate: type: object description: Update to the list of advertisers with read/write access to the inventory source. properties: addedAdvertisers: type: array description: The advertisers to add. items: type: string format: int64 removedAdvertisers: type: array description: The advertisers to remove. items: type: string format: int64 Empty: type: object description: 'A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }' EnvironmentAssignedTargetingOptionDetails: type: object description: Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. properties: environment: type: string description: 'Required. The serving environment. Allowed values — `ENVIRONMENT_UNSPECIFIED`: Default value when environment is not specified in this version. This enum is a placeholder for default value and does not represent a real environment option.; `ENVIRONMENT_WEB_OPTIMIZED`: Target inventory displayed in browsers. This includes inventory that was designed for the device it was viewed on, such as mobile websites viewed on a mobile device. ENVIRONMENT_WEB_NOT_OPTIMIZED, if targeted, should be deleted prior to the deletion of this targeting option.; `ENVIRONMENT_WEB_NOT_OPTIMIZED`: Target inventory displayed in browsers. This includes inventory that was not designed for the device but viewed on it, such as websites optimized for desktop but viewed on a mobile device. ENVIRONMENT_WEB_OPTIMIZED should be targeted prior to the addition of this targeting option.; `ENVIRONMENT_APP`: Target inventory displayed in apps.' enum: - ENVIRONMENT_UNSPECIFIED - ENVIRONMENT_WEB_OPTIMIZED - ENVIRONMENT_WEB_NOT_OPTIMIZED - ENVIRONMENT_APP EnvironmentTargetingOptionDetails: type: object description: Represents a targetable environment. This will be populated in the environment_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. properties: environment: type: string description: 'Output only. The serving environment. Allowed values — `ENVIRONMENT_UNSPECIFIED`: Default value when environment is not specified in this version. This enum is a placeholder for default value and does not represent a real environment option.; `ENVIRONMENT_WEB_OPTIMIZED`: Target inventory displayed in browsers. This includes inventory that was designed for the device it was viewed on, such as mobile websites viewed on a mobile device. ENVIRONMENT_WEB_NOT_OPTIMIZED, if targeted, should be deleted prior to the deletion of this targeting option.; `ENVIRONMENT_WEB_NOT_OPTIMIZED`: Target inventory displayed in browsers. This includes inventory that was not designed for the device but viewed on it, such as websites optimized for desktop but viewed on a mobile device. ENVIRONMENT_WEB_OPTIMIZED should be targeted prior to the addition of this targeting option.; `ENVIRONMENT_APP`: Target inventory displayed in apps.' enum: - ENVIRONMENT_UNSPECIFIED - ENVIRONMENT_WEB_OPTIMIZED - ENVIRONMENT_WEB_NOT_OPTIMIZED - ENVIRONMENT_APP readOnly: true ExchangeAssignedTargetingOptionDetails: type: object description: Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. properties: exchange: type: string description: 'Required. The enum value for the exchange. Allowed values — `EXCHANGE_UNSPECIFIED`: Exchange is not specified or is unknown in this version.; `EXCHANGE_GOOGLE_AD_MANAGER`: Google Ad Manager.; `EXCHANGE_APPNEXUS`: AppNexus.; `EXCHANGE_BRIGHTROLL`: BrightRoll Exchange for Video from Yahoo!.; `EXCHANGE_ADFORM`: Adform.; `EXCHANGE_ADMETA`: Admeta.; `EXCHANGE_ADMIXER`: Admixer.; `EXCHANGE_ADSMOGO`: AdsMogo.; `EXCHANGE_ADSWIZZ`: AdsWizz.; `EXCHANGE_BIDSWITCH`: BidSwitch.; `EXCHANGE_BRIGHTROLL_DISPLAY`: BrightRoll Exchange for Display from Yahoo!.; `EXCHANGE_CADREON`: Cadreon.; `EXCHANGE_DAILYMOTION`: Dailymotion.; `EXCHANGE_FIVE`: Five.; `EXCHANGE_FLUCT`: Fluct.; `EXCHANGE_FREEWHEEL`: FreeWheel SSP.; `EXCHANGE_GENIEE`: Geniee.; `EXCHANGE_GUMGUM`: GumGum.; `EXCHANGE_IMOBILE`: i-mobile.; `EXCHANGE_IBILLBOARD`: iBILLBOARD.; `EXCHANGE_IMPROVE_DIGITAL`: Improve Digital.; `EXCHANGE_INDEX`: Index Exchange.; `EXCHANGE_KARGO`: Kargo.; `EXCHANGE_MICROAD`: MicroAd.; `EXCHANGE_MOPUB`: MoPub.; `EXCHANGE_NEND`: Nend.; `EXCHANGE_ONE_BY_AOL_DISPLAY`: ONE by AOL: Display Market Place.; `EXCHANGE_ONE_BY_AOL_MOBILE`: ONE by AOL: Mobile.; `EXCHANGE_ONE_BY_AOL_VIDEO`: ONE by AOL: Video.; `EXCHANGE_OOYALA`: Ooyala.; `EXCHANGE_OPENX`: OpenX.; `EXCHANGE_PERMODO`: Permodo.; `EXCHANGE_PLATFORMONE`: Platform One.; `EXCHANGE_PLATFORMID`: PlatformId.; `EXCHANGE_PUBMATIC`: PubMatic.; `EXCHANGE_PULSEPOINT`: PulsePoint.; `EXCHANGE_REVENUEMAX`: RevenueMax.; `EXCHANGE_RUBICON`: Rubicon.; `EXCHANGE_SMARTCLIP`: SmartClip.; `EXCHANGE_SMARTRTB`: SmartRTB+.; `EXCHANGE_SMARTSTREAMTV`: SmartstreamTv.; `EXCHANGE_SOVRN`: Sovrn.; `EXCHANGE_SPOTXCHANGE`: SpotXchange.; `EXCHANGE_STROER`: Ströer SSP.; `EXCHANGE_TEADSTV`: TeadsTv.; `EXCHANGE_TELARIA`: Telaria.; `EXCHANGE_TVN`: TVN.; `EXCHANGE_UNITED`: United.; `EXCHANGE_YIELDLAB`: Yieldlab.; `EXCHANGE_YIELDMO`: Yieldmo.; `EXCHANGE_UNRULYX`: UnrulyX.; `EXCHANGE_OPEN8`: Open8.; `EXCHANGE_TRITON`: Triton.; `EXCHANGE_TRIPLELIFT`: TripleLift.; `EXCHANGE_TABOOLA`: Taboola.; `EXCHANGE_INMOBI`: InMobi.; `EXCHANGE_SMAATO`: Smaato.; `EXCHANGE_AJA`: Aja.; `EXCHANGE_SUPERSHIP`: Supership.; `EXCHANGE_NEXSTAR_DIGITAL`: Nexstar Digital.; `EXCHANGE_WAZE`: Waze.; `EXCHANGE_SOUNDCAST`: SoundCast.; `EXCHANGE_SHARETHROUGH`: Sharethrough.; `EXCHANGE_FYBER`: Fyber.; `EXCHANGE_RED_FOR_PUBLISHERS`: Red For Publishers.; `EXCHANGE_MEDIANET`: Media.net.; `EXCHANGE_TAPJOY`: Tapjoy.; `EXCHANGE_VISTAR`: Vistar.; `EXCHANGE_DAX`: DAX.; `EXCHANGE_JCD`: JCD.; `EXCHANGE_PLACE_EXCHANGE`: Place Exchange.; `EXCHANGE_APPLOVIN`: AppLovin.; `EXCHANGE_CONNATIX`: Connatix.; `EXCHANGE_RESET_DIGITAL`: Reset Digital.; `EXCHANGE_HIVESTACK`: Hivestack.; `EXCHANGE_DRAX`: Drax.; `EXCHANGE_APPLOVIN_GBID`: AppLovin MAX.; `EXCHANGE_FYBER_GBID`: DT Fairbid.; `EXCHANGE_UNITY_GBID`: Unity LevelPlay.; `EXCHANGE_CHARTBOOST_GBID`: Chartboost Mediation.; `EXCHANGE_ADMOST_GBID`: AdMost.; `EXCHANGE_TOPON_GBID`: TopOn.; `EXCHANGE_NETFLIX`: Netflix.; `EXCHANGE_CORE`: Core.; `EXCHANGE_COMMERCE_GRID`: Commerce Grid.; `EXCHANGE_SPOTIFY`: Spotify.; `EXCHANGE_TUBI`: Tubi.; `EXCHANGE_SNAP`: Snap.; `EXCHANGE_CADENT`: Cadent.; `EXCHANGE_EXTE`: Exte.' 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_SUPERSHIP - EXCHANGE_NEXSTAR_DIGITAL - EXCHANGE_WAZE - EXCHANGE_SOUNDCAST - EXCHANGE_SHARETHROUGH - EXCHANGE_FYBER - EXCHANGE_RED_FOR_PUBLISHERS - EXCHANGE_MEDIANET - EXCHANGE_TAPJOY - EXCHANGE_VISTAR - EXCHANGE_DAX - EXCHANGE_JCD - EXCHANGE_PLACE_EXCHANGE - EXCHANGE_APPLOVIN - EXCHANGE_CONNATIX - EXCHANGE_RESET_DIGITAL - EXCHANGE_HIVESTACK - EXCHANGE_DRAX - EXCHANGE_APPLOVIN_GBID - EXCHANGE_FYBER_GBID - EXCHANGE_UNITY_GBID - EXCHANGE_CHARTBOOST_GBID - EXCHANGE_ADMOST_GBID - EXCHANGE_TOPON_GBID - EXCHANGE_NETFLIX - EXCHANGE_CORE - EXCHANGE_COMMERCE_GRID - EXCHANGE_SPOTIFY - EXCHANGE_TUBI - EXCHANGE_SNAP - EXCHANGE_CADENT - EXCHANGE_EXTE ExchangeConfig: type: object description: Settings that control which exchanges are enabled for a partner. properties: enabledExchanges: type: array description: All enabled exchanges in the partner. Duplicate enabled exchanges will be ignored. items: $ref: '#/components/schemas/ExchangeConfigEnabledExchange' ExchangeConfigEnabledExchange: type: object description: An enabled exchange in the partner. properties: seatId: type: string description: Output only. Seat ID of the enabled exchange. readOnly: true exchange: type: string description: 'The enabled exchange. Allowed values — `EXCHANGE_UNSPECIFIED`: Exchange is not specified or is unknown in this version.; `EXCHANGE_GOOGLE_AD_MANAGER`: Google Ad Manager.; `EXCHANGE_APPNEXUS`: AppNexus.; `EXCHANGE_BRIGHTROLL`: BrightRoll Exchange for Video from Yahoo!.; `EXCHANGE_ADFORM`: Adform.; `EXCHANGE_ADMETA`: Admeta.; `EXCHANGE_ADMIXER`: Admixer.; `EXCHANGE_ADSMOGO`: AdsMogo.; `EXCHANGE_ADSWIZZ`: AdsWizz.; `EXCHANGE_BIDSWITCH`: BidSwitch.; `EXCHANGE_BRIGHTROLL_DISPLAY`: BrightRoll Exchange for Display from Yahoo!.; `EXCHANGE_CADREON`: Cadreon.; `EXCHANGE_DAILYMOTION`: Dailymotion.; `EXCHANGE_FIVE`: Five.; `EXCHANGE_FLUCT`: Fluct.; `EXCHANGE_FREEWHEEL`: FreeWheel SSP.; `EXCHANGE_GENIEE`: Geniee.; `EXCHANGE_GUMGUM`: GumGum.; `EXCHANGE_IMOBILE`: i-mobile.; `EXCHANGE_IBILLBOARD`: iBILLBOARD.; `EXCHANGE_IMPROVE_DIGITAL`: Improve Digital.; `EXCHANGE_INDEX`: Index Exchange.; `EXCHANGE_KARGO`: Kargo.; `EXCHANGE_MICROAD`: MicroAd.; `EXCHANGE_MOPUB`: MoPub.; `EXCHANGE_NEND`: Nend.; `EXCHANGE_ONE_BY_AOL_DISPLAY`: ONE by AOL: Display Market Place.; `EXCHANGE_ONE_BY_AOL_MOBILE`: ONE by AOL: Mobile.; `EXCHANGE_ONE_BY_AOL_VIDEO`: ONE by AOL: Video.; `EXCHANGE_OOYALA`: Ooyala.; `EXCHANGE_OPENX`: OpenX.; `EXCHANGE_PERMODO`: Permodo.; `EXCHANGE_PLATFORMONE`: Platform One.; `EXCHANGE_PLATFORMID`: PlatformId.; `EXCHANGE_PUBMATIC`: PubMatic.; `EXCHANGE_PULSEPOINT`: PulsePoint.; `EXCHANGE_REVENUEMAX`: RevenueMax.; `EXCHANGE_RUBICON`: Rubicon.; `EXCHANGE_SMARTCLIP`: SmartClip.; `EXCHANGE_SMARTRTB`: SmartRTB+.; `EXCHANGE_SMARTSTREAMTV`: SmartstreamTv.; `EXCHANGE_SOVRN`: Sovrn.; `EXCHANGE_SPOTXCHANGE`: SpotXchange.; `EXCHANGE_STROER`: Ströer SSP.; `EXCHANGE_TEADSTV`: TeadsTv.; `EXCHANGE_TELARIA`: Telaria.; `EXCHANGE_TVN`: TVN.; `EXCHANGE_UNITED`: United.; `EXCHANGE_YIELDLAB`: Yieldlab.; `EXCHANGE_YIELDMO`: Yieldmo.; `EXCHANGE_UNRULYX`: UnrulyX.; `EXCHANGE_OPEN8`: Open8.; `EXCHANGE_TRITON`: Triton.; `EXCHANGE_TRIPLELIFT`: TripleLift.; `EXCHANGE_TABOOLA`: Taboola.; `EXCHANGE_INMOBI`: InMobi.; `EXCHANGE_SMAATO`: Smaato.; `EXCHANGE_AJA`: Aja.; `EXCHANGE_SUPERSHIP`: Supership.; `EXCHANGE_NEXSTAR_DIGITAL`: Nexstar Digital.; `EXCHANGE_WAZE`: Waze.; `EXCHANGE_SOUNDCAST`: SoundCast.; `EXCHANGE_SHARETHROUGH`: Sharethrough.; `EXCHANGE_FYBER`: Fyber.; `EXCHANGE_RED_FOR_PUBLISHERS`: Red For Publishers.; `EXCHANGE_MEDIANET`: Media.net.; `EXCHANGE_TAPJOY`: Tapjoy.; `EXCHANGE_VISTAR`: Vistar.; `EXCHANGE_DAX`: DAX.; `EXCHANGE_JCD`: JCD.; `EXCHANGE_PLACE_EXCHANGE`: Place Exchange.; `EXCHANGE_APPLOVIN`: AppLovin.; `EXCHANGE_CONNATIX`: Connatix.; `EXCHANGE_RESET_DIGITAL`: Reset Digital.; `EXCHANGE_HIVESTACK`: Hivestack.; `EXCHANGE_DRAX`: Drax.; `EXCHANGE_APPLOVIN_GBID`: AppLovin MAX.; `EXCHANGE_FYBER_GBID`: DT Fairbid.; `EXCHANGE_UNITY_GBID`: Unity LevelPlay.; `EXCHANGE_CHARTBOOST_GBID`: Chartboost Mediation.; `EXCHANGE_ADMOST_GBID`: AdMost.; `EXCHANGE_TOPON_GBID`: TopOn.; `EXCHANGE_NETFLIX`: Netflix.; `EXCHANGE_CORE`: Core.; `EXCHANGE_COMMERCE_GRID`: Commerce Grid.; `EXCHANGE_SPOTIFY`: Spotify.; `EXCHANGE_TUBI`: Tubi.; `EXCHANGE_SNAP`: Snap.; `EXCHANGE_CADENT`: Cadent.; `EXCHANGE_EXTE`: Exte.' 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_SUPERSHIP - EXCHANGE_NEXSTAR_DIGITAL - EXCHANGE_WAZE - EXCHANGE_SOUNDCAST - EXCHANGE_SHARETHROUGH - EXCHANGE_FYBER - EXCHANGE_RED_FOR_PUBLISHERS - EXCHANGE_MEDIANET - EXCHANGE_TAPJOY - EXCHANGE_VISTAR - EXCHANGE_DAX - EXCHANGE_JCD - EXCHANGE_PLACE_EXCHANGE - EXCHANGE_APPLOVIN - EXCHANGE_CONNATIX - EXCHANGE_RESET_DIGITAL - EXCHANGE_HIVESTACK - EXCHANGE_DRAX - EXCHANGE_APPLOVIN_GBID - EXCHANGE_FYBER_GBID - EXCHANGE_UNITY_GBID - EXCHANGE_CHARTBOOST_GBID - EXCHANGE_ADMOST_GBID - EXCHANGE_TOPON_GBID - EXCHANGE_NETFLIX - EXCHANGE_CORE - EXCHANGE_COMMERCE_GRID - EXCHANGE_SPOTIFY - EXCHANGE_TUBI - EXCHANGE_SNAP - EXCHANGE_CADENT - EXCHANGE_EXTE googleAdManagerAgencyId: type: string description: Output only. Agency ID of Google Ad Manager. The field is only relevant when Google Ad Manager is the enabled exchange. readOnly: true googleAdManagerBuyerNetworkId: type: string description: Output only. Network ID of Google Ad Manager. The field is only relevant when Google Ad Manager is the enabled exchange. readOnly: true ExchangeReviewStatus: type: object description: Exchange review status for the creative. properties: exchange: type: string description: 'The exchange reviewing the creative. Allowed values — `EXCHANGE_UNSPECIFIED`: Exchange is not specified or is unknown in this version.; `EXCHANGE_GOOGLE_AD_MANAGER`: Google Ad Manager.; `EXCHANGE_APPNEXUS`: AppNexus.; `EXCHANGE_BRIGHTROLL`: BrightRoll Exchange for Video from Yahoo!.; `EXCHANGE_ADFORM`: Adform.; `EXCHANGE_ADMETA`: Admeta.; `EXCHANGE_ADMIXER`: Admixer.; `EXCHANGE_ADSMOGO`: AdsMogo.; `EXCHANGE_ADSWIZZ`: AdsWizz.; `EXCHANGE_BIDSWITCH`: BidSwitch.; `EXCHANGE_BRIGHTROLL_DISPLAY`: BrightRoll Exchange for Display from Yahoo!.; `EXCHANGE_CADREON`: Cadreon.; `EXCHANGE_DAILYMOTION`: Dailymotion.; `EXCHANGE_FIVE`: Five.; `EXCHANGE_FLUCT`: Fluct.; `EXCHANGE_FREEWHEEL`: FreeWheel SSP.; `EXCHANGE_GENIEE`: Geniee.; `EXCHANGE_GUMGUM`: GumGum.; `EXCHANGE_IMOBILE`: i-mobile.; `EXCHANGE_IBILLBOARD`: iBILLBOARD.; `EXCHANGE_IMPROVE_DIGITAL`: Improve Digital.; `EXCHANGE_INDEX`: Index Exchange.; `EXCHANGE_KARGO`: Kargo.; `EXCHANGE_MICROAD`: MicroAd.; `EXCHANGE_MOPUB`: MoPub.; `EXCHANGE_NEND`: Nend.; `EXCHANGE_ONE_BY_AOL_DISPLAY`: ONE by AOL: Display Market Place.; `EXCHANGE_ONE_BY_AOL_MOBILE`: ONE by AOL: Mobile.; `EXCHANGE_ONE_BY_AOL_VIDEO`: ONE by AOL: Video.; `EXCHANGE_OOYALA`: Ooyala.; `EXCHANGE_OPENX`: OpenX.; `EXCHANGE_PERMODO`: Permodo.; `EXCHANGE_PLATFORMONE`: Platform One.; `EXCHANGE_PLATFORMID`: PlatformId.; `EXCHANGE_PUBMATIC`: PubMatic.; `EXCHANGE_PULSEPOINT`: PulsePoint.; `EXCHANGE_REVENUEMAX`: RevenueMax.; `EXCHANGE_RUBICON`: Rubicon.; `EXCHANGE_SMARTCLIP`: SmartClip.; `EXCHANGE_SMARTRTB`: SmartRTB+.; `EXCHANGE_SMARTSTREAMTV`: SmartstreamTv.; `EXCHANGE_SOVRN`: Sovrn.; `EXCHANGE_SPOTXCHANGE`: SpotXchange.; `EXCHANGE_STROER`: Ströer SSP.; `EXCHANGE_TEADSTV`: TeadsTv.; `EXCHANGE_TELARIA`: Telaria.; `EXCHANGE_TVN`: TVN.; `EXCHANGE_UNITED`: United.; `EXCHANGE_YIELDLAB`: Yieldlab.; `EXCHANGE_YIELDMO`: Yieldmo.; `EXCHANGE_UNRULYX`: UnrulyX.; `EXCHANGE_OPEN8`: Open8.; `EXCHANGE_TRITON`: Triton.; `EXCHANGE_TRIPLELIFT`: TripleLift.; `EXCHANGE_TABOOLA`: Taboola.; `EXCHANGE_INMOBI`: InMobi.; `EXCHANGE_SMAATO`: Smaato.; `EXCHANGE_AJA`: Aja.; `EXCHANGE_SUPERSHIP`: Supership.; `EXCHANGE_NEXSTAR_DIGITAL`: Nexstar Digital.; `EXCHANGE_WAZE`: Waze.; `EXCHANGE_SOUNDCAST`: SoundCast.; `EXCHANGE_SHARETHROUGH`: Sharethrough.; `EXCHANGE_FYBER`: Fyber.; `EXCHANGE_RED_FOR_PUBLISHERS`: Red For Publishers.; `EXCHANGE_MEDIANET`: Media.net.; `EXCHANGE_TAPJOY`: Tapjoy.; `EXCHANGE_VISTAR`: Vistar.; `EXCHANGE_DAX`: DAX.; `EXCHANGE_JCD`: JCD.; `EXCHANGE_PLACE_EXCHANGE`: Place Exchange.; `EXCHANGE_APPLOVIN`: AppLovin.; `EXCHANGE_CONNATIX`: Connatix.; `EXCHANGE_RESET_DIGITAL`: Reset Digital.; `EXCHANGE_HIVESTACK`: Hivestack.; `EXCHANGE_DRAX`: Drax.; `EXCHANGE_APPLOVIN_GBID`: AppLovin MAX.; `EXCHANGE_FYBER_GBID`: DT Fairbid.; `EXCHANGE_UNITY_GBID`: Unity LevelPlay.; `EXCHANGE_CHARTBOOST_GBID`: Chartboost Mediation.; `EXCHANGE_ADMOST_GBID`: AdMost.; `EXCHANGE_TOPON_GBID`: TopOn.; `EXCHANGE_NETFLIX`: Netflix.; `EXCHANGE_CORE`: Core.; `EXCHANGE_COMMERCE_GRID`: Commerce Grid.; `EXCHANGE_SPOTIFY`: Spotify.; `EXCHANGE_TUBI`: Tubi.; `EXCHANGE_SNAP`: Snap.; `EXCHANGE_CADENT`: Cadent.; `EXCHANGE_EXTE`: Exte.' 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_SUPERSHIP - EXCHANGE_NEXSTAR_DIGITAL - EXCHANGE_WAZE - EXCHANGE_SOUNDCAST - EXCHANGE_SHARETHROUGH - EXCHANGE_FYBER - EXCHANGE_RED_FOR_PUBLISHERS - EXCHANGE_MEDIANET - EXCHANGE_TAPJOY - EXCHANGE_VISTAR - EXCHANGE_DAX - EXCHANGE_JCD - EXCHANGE_PLACE_EXCHANGE - EXCHANGE_APPLOVIN - EXCHANGE_CONNATIX - EXCHANGE_RESET_DIGITAL - EXCHANGE_HIVESTACK - EXCHANGE_DRAX - EXCHANGE_APPLOVIN_GBID - EXCHANGE_FYBER_GBID - EXCHANGE_UNITY_GBID - EXCHANGE_CHARTBOOST_GBID - EXCHANGE_ADMOST_GBID - EXCHANGE_TOPON_GBID - EXCHANGE_NETFLIX - EXCHANGE_CORE - EXCHANGE_COMMERCE_GRID - EXCHANGE_SPOTIFY - EXCHANGE_TUBI - EXCHANGE_SNAP - EXCHANGE_CADENT - EXCHANGE_EXTE status: type: string description: 'Status of the exchange review. Allowed values — `REVIEW_STATUS_UNSPECIFIED`: Type value is not specified or is unknown in this version.; `REVIEW_STATUS_APPROVED`: The creative is approved.; `REVIEW_STATUS_REJECTED`: The creative is rejected.; `REVIEW_STATUS_PENDING`: The creative is pending review.' enum: - REVIEW_STATUS_UNSPECIFIED - REVIEW_STATUS_APPROVED - REVIEW_STATUS_REJECTED - REVIEW_STATUS_PENDING ExchangeTargetingOptionDetails: type: object description: Represents a targetable exchange. This will be populated in the exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. properties: exchange: type: string description: 'Output only. The type of exchange. Allowed values — `EXCHANGE_UNSPECIFIED`: Exchange is not specified or is unknown in this version.; `EXCHANGE_GOOGLE_AD_MANAGER`: Google Ad Manager.; `EXCHANGE_APPNEXUS`: AppNexus.; `EXCHANGE_BRIGHTROLL`: BrightRoll Exchange for Video from Yahoo!.; `EXCHANGE_ADFORM`: Adform.; `EXCHANGE_ADMETA`: Admeta.; `EXCHANGE_ADMIXER`: Admixer.; `EXCHANGE_ADSMOGO`: AdsMogo.; `EXCHANGE_ADSWIZZ`: AdsWizz.; `EXCHANGE_BIDSWITCH`: BidSwitch.; `EXCHANGE_BRIGHTROLL_DISPLAY`: BrightRoll Exchange for Display from Yahoo!.; `EXCHANGE_CADREON`: Cadreon.; `EXCHANGE_DAILYMOTION`: Dailymotion.; `EXCHANGE_FIVE`: Five.; `EXCHANGE_FLUCT`: Fluct.; `EXCHANGE_FREEWHEEL`: FreeWheel SSP.; `EXCHANGE_GENIEE`: Geniee.; `EXCHANGE_GUMGUM`: GumGum.; `EXCHANGE_IMOBILE`: i-mobile.; `EXCHANGE_IBILLBOARD`: iBILLBOARD.; `EXCHANGE_IMPROVE_DIGITAL`: Improve Digital.; `EXCHANGE_INDEX`: Index Exchange.; `EXCHANGE_KARGO`: Kargo.; `EXCHANGE_MICROAD`: MicroAd.; `EXCHANGE_MOPUB`: MoPub.; `EXCHANGE_NEND`: Nend.; `EXCHANGE_ONE_BY_AOL_DISPLAY`: ONE by AOL: Display Market Place.; `EXCHANGE_ONE_BY_AOL_MOBILE`: ONE by AOL: Mobile.; `EXCHANGE_ONE_BY_AOL_VIDEO`: ONE by AOL: Video.; `EXCHANGE_OOYALA`: Ooyala.; `EXCHANGE_OPENX`: OpenX.; `EXCHANGE_PERMODO`: Permodo.; `EXCHANGE_PLATFORMONE`: Platform One.; `EXCHANGE_PLATFORMID`: PlatformId.; `EXCHANGE_PUBMATIC`: PubMatic.; `EXCHANGE_PULSEPOINT`: PulsePoint.; `EXCHANGE_REVENUEMAX`: RevenueMax.; `EXCHANGE_RUBICON`: Rubicon.; `EXCHANGE_SMARTCLIP`: SmartClip.; `EXCHANGE_SMARTRTB`: SmartRTB+.; `EXCHANGE_SMARTSTREAMTV`: SmartstreamTv.; `EXCHANGE_SOVRN`: Sovrn.; `EXCHANGE_SPOTXCHANGE`: SpotXchange.; `EXCHANGE_STROER`: Ströer SSP.; `EXCHANGE_TEADSTV`: TeadsTv.; `EXCHANGE_TELARIA`: Telaria.; `EXCHANGE_TVN`: TVN.; `EXCHANGE_UNITED`: United.; `EXCHANGE_YIELDLAB`: Yieldlab.; `EXCHANGE_YIELDMO`: Yieldmo.; `EXCHANGE_UNRULYX`: UnrulyX.; `EXCHANGE_OPEN8`: Open8.; `EXCHANGE_TRITON`: Triton.; `EXCHANGE_TRIPLELIFT`: TripleLift.; `EXCHANGE_TABOOLA`: Taboola.; `EXCHANGE_INMOBI`: InMobi.; `EXCHANGE_SMAATO`: Smaato.; `EXCHANGE_AJA`: Aja.; `EXCHANGE_SUPERSHIP`: Supership.; `EXCHANGE_NEXSTAR_DIGITAL`: Nexstar Digital.; `EXCHANGE_WAZE`: Waze.; `EXCHANGE_SOUNDCAST`: SoundCast.; `EXCHANGE_SHARETHROUGH`: Sharethrough.; `EXCHANGE_FYBER`: Fyber.; `EXCHANGE_RED_FOR_PUBLISHERS`: Red For Publishers.; `EXCHANGE_MEDIANET`: Media.net.; `EXCHANGE_TAPJOY`: Tapjoy.; `EXCHANGE_VISTAR`: Vistar.; `EXCHANGE_DAX`: DAX.; `EXCHANGE_JCD`: JCD.; `EXCHANGE_PLACE_EXCHANGE`: Place Exchange.; `EXCHANGE_APPLOVIN`: AppLovin.; `EXCHANGE_CONNATIX`: Connatix.; `EXCHANGE_RESET_DIGITAL`: Reset Digital.; `EXCHANGE_HIVESTACK`: Hivestack.; `EXCHANGE_DRAX`: Drax.; `EXCHANGE_APPLOVIN_GBID`: AppLovin MAX.; `EXCHANGE_FYBER_GBID`: DT Fairbid.; `EXCHANGE_UNITY_GBID`: Unity LevelPlay.; `EXCHANGE_CHARTBOOST_GBID`: Chartboost Mediation.; `EXCHANGE_ADMOST_GBID`: AdMost.; `EXCHANGE_TOPON_GBID`: TopOn.; `EXCHANGE_NETFLIX`: Netflix.; `EXCHANGE_CORE`: Core.; `EXCHANGE_COMMERCE_GRID`: Commerce Grid.; `EXCHANGE_SPOTIFY`: Spotify.; `EXCHANGE_TUBI`: Tubi.; `EXCHANGE_SNAP`: Snap.; `EXCHANGE_CADENT`: Cadent.; `EXCHANGE_EXTE`: Exte.' 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_SUPERSHIP - EXCHANGE_NEXSTAR_DIGITAL - EXCHANGE_WAZE - EXCHANGE_SOUNDCAST - EXCHANGE_SHARETHROUGH - EXCHANGE_FYBER - EXCHANGE_RED_FOR_PUBLISHERS - EXCHANGE_MEDIANET - EXCHANGE_TAPJOY - EXCHANGE_VISTAR - EXCHANGE_DAX - EXCHANGE_JCD - EXCHANGE_PLACE_EXCHANGE - EXCHANGE_APPLOVIN - EXCHANGE_CONNATIX - EXCHANGE_RESET_DIGITAL - EXCHANGE_HIVESTACK - EXCHANGE_DRAX - EXCHANGE_APPLOVIN_GBID - EXCHANGE_FYBER_GBID - EXCHANGE_UNITY_GBID - EXCHANGE_CHARTBOOST_GBID - EXCHANGE_ADMOST_GBID - EXCHANGE_TOPON_GBID - EXCHANGE_NETFLIX - EXCHANGE_CORE - EXCHANGE_COMMERCE_GRID - EXCHANGE_SPOTIFY - EXCHANGE_TUBI - EXCHANGE_SNAP - EXCHANGE_CADENT - EXCHANGE_EXTE readOnly: true ExitEvent: type: object description: Exit event of the creative. properties: name: type: string description: Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. type: type: string description: 'Required. The type of the exit event. Allowed values — `EXIT_EVENT_TYPE_UNSPECIFIED`: Exit event type is not specified or is unknown in this version.; `EXIT_EVENT_TYPE_DEFAULT`: The exit event is the default one.; `EXIT_EVENT_TYPE_BACKUP`: The exit event is a backup exit event. There could be multiple backup exit events in a creative.' enum: - EXIT_EVENT_TYPE_UNSPECIFIED - EXIT_EVENT_TYPE_DEFAULT - EXIT_EVENT_TYPE_BACKUP url: type: string description: 'Required. The click through URL of the exit event. This is required when type is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP`' reportingName: type: string description: Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. FirstPartyAndPartnerAudience: type: object description: Describes a first or partner audience list used for targeting. First party audiences are created via usage of client data. Partner audiences are provided by Third Party data providers and can only be licensed to customers. properties: displayAudienceSize: type: string format: int64 description: Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request. readOnly: true displayMobileAppAudienceSize: type: string format: int64 description: Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request. readOnly: true displayDesktopAudienceSize: type: string format: int64 description: Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request. readOnly: true audienceSource: type: string description: 'Output only. The source of the audience. Allowed values — `AUDIENCE_SOURCE_UNSPECIFIED`: Default value when audience source is not specified or is unknown.; `DISPLAY_VIDEO_360`: Originated from Display & Video 360.; `CAMPAIGN_MANAGER`: Originated from Campaign Manager 360.; `AD_MANAGER`: Originated from Google Ad Manager.; `SEARCH_ADS_360`: Originated from Search Ads 360.; `YOUTUBE`: Originated from Youtube.; `ADS_DATA_HUB`: Originated from Ads Data Hub.' enum: - AUDIENCE_SOURCE_UNSPECIFIED - DISPLAY_VIDEO_360 - CAMPAIGN_MANAGER - AD_MANAGER - SEARCH_ADS_360 - YOUTUBE - ADS_DATA_HUB readOnly: true appId: type: string description: Optional. The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID` firstPartyAndPartnerAudienceId: type: string format: int64 description: Identifier. The unique ID of the first party and partner audience. Assigned by the system. displayName: type: string description: Optional. The display name of the first party and partner audience. membershipDurationDays: type: string format: int64 description: 'Optional. The duration in days that an entry remains in the audience after the qualifying event. The set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`' audienceType: type: string description: 'Immutable. The type of the audience. Allowed values — `AUDIENCE_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown.; `CUSTOMER_MATCH_CONTACT_INFO`: Audience was generated through matching customers to known contact information.; `CUSTOMER_MATCH_DEVICE_ID`: Audience was generated through matching customers to known Mobile device IDs.; `CUSTOMER_MATCH_USER_ID`: Audience was generated through matching customers to known User IDs.; `ACTIVITY_BASED`: Deprecated: Audience was created based on campaign activity.; `FREQUENCY_CAP`: Deprecated: Audience was created based on excluding the number of impressions they were served.; `TAG_BASED`: Audience was created based on custom variables attached to pixel.; `YOUTUBE_USERS`: Audience was created based on past interactions with videos, YouTube ads, or YouTube channel.; `THIRD_PARTY`: Audience has been licensed for use from a third party.; `COMMERCE`: Audience provided by commerce partners for a fee.; `LINEAR`: Audience for Linear TV content.; `AGENCY`: Audience provided by an agency.' enum: - AUDIENCE_TYPE_UNSPECIFIED - CUSTOMER_MATCH_CONTACT_INFO - CUSTOMER_MATCH_DEVICE_ID - CUSTOMER_MATCH_USER_ID - ACTIVITY_BASED - FREQUENCY_CAP - TAG_BASED - YOUTUBE_USERS - THIRD_PARTY - COMMERCE - LINEAR - AGENCY gmailAudienceSize: type: string format: int64 description: Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request. readOnly: true displayMobileWebAudienceSize: type: string format: int64 description: Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request. readOnly: true name: type: string description: Output only. The resource name of the first party and partner audience. readOnly: true firstPartyAndPartnerAudienceType: type: string description: 'Output only. Whether the audience is a first party and partner audience. Allowed values — `FIRST_PARTY_AND_PARTNER_AUDIENCE_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown.; `TYPE_FIRST_PARTY`: Audience that is created via usage of client data.; `TYPE_PARTNER`: Audience that is provided by Third Party data providers.' enum: - FIRST_PARTY_AND_PARTNER_AUDIENCE_TYPE_UNSPECIFIED - TYPE_FIRST_PARTY - TYPE_PARTNER readOnly: true contactInfoList: $ref: '#/components/schemas/ContactInfoList' activeDisplayAudienceSize: type: string format: int64 description: Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request. readOnly: true description: type: string description: Optional. The user-provided description of the audience. Only applicable to first party audiences. youtubeAudienceSize: type: string format: int64 description: Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request. readOnly: true mobileDeviceIdList: $ref: '#/components/schemas/MobileDeviceIdList' FirstPartyAndPartnerAudienceGroup: type: object description: Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. properties: settings: type: array description: Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed. items: $ref: '#/components/schemas/FirstPartyAndPartnerAudienceTargetingSetting' FirstPartyAndPartnerAudienceTargetingSetting: type: object description: Details of first party and partner audience targeting setting. properties: recency: type: string description: 'Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. Allowed values — `RECENCY_NO_LIMIT`: No limit of recency.; `RECENCY_1_MINUTE`: Recency is 1 minute.; `RECENCY_5_MINUTES`: Recency is 5 minutes.; `RECENCY_10_MINUTES`: Recency is 10 minutes.; `RECENCY_15_MINUTES`: Recency is 15 minutes.; `RECENCY_30_MINUTES`: Recency is 30 minutes.; `RECENCY_1_HOUR`: Recency is 1 hour.; `RECENCY_2_HOURS`: Recency is 2 hours.; `RECENCY_3_HOURS`: Recency is 3 hours.; `RECENCY_6_HOURS`: Recency is 6 hours.; `RECENCY_12_HOURS`: Recency is 12 hours.; `RECENCY_1_DAY`: Recency is 1 day.; `RECENCY_2_DAYS`: Recency is 2 days.; `RECENCY_3_DAYS`: Recency is 3 days.; `RECENCY_5_DAYS`: Recency is 5 days.; `RECENCY_7_DAYS`: Recency is 7 days.; `RECENCY_10_DAYS`: Recency is 10 days.; `RECENCY_14_DAYS`: Recency is 14 days.; `RECENCY_15_DAYS`: Recency is 15 days.; `RECENCY_21_DAYS`: Recency is 21 days.; `RECENCY_28_DAYS`: Recency is 28 days.; `RECENCY_30_DAYS`: Recency is 30 days.; `RECENCY_40_DAYS`: Recency is 40 days.; `RECENCY_45_DAYS`: Recency is 45 days.; `RECENCY_60_DAYS`: Recency is 60 days.; `RECENCY_90_DAYS`: Recency is 90 days.; `RECENCY_120_DAYS`: Recency is 120 days.; `RECENCY_180_DAYS`: Recency is 180 days.; `RECENCY_270_DAYS`: Recency is 270 days.; `RECENCY_365_DAYS`: Recency is 365 days.' 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_45_DAYS - RECENCY_60_DAYS - RECENCY_90_DAYS - RECENCY_120_DAYS - RECENCY_180_DAYS - RECENCY_270_DAYS - RECENCY_365_DAYS firstPartyAndPartnerAudienceId: type: string format: int64 description: Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id. FixedBidStrategy: type: object description: A strategy that uses a fixed bidding price. properties: bidAmountMicros: type: string format: int64 description: The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. FloodlightActivity: type: object description: A single Floodlight activity. properties: name: type: string description: Output only. The resource name of the Floodlight activity. readOnly: true advertiserIds: type: array description: Output only. IDs of the advertisers that have access to the parent Floodlight group. Only advertisers under the provided partner ID will be listed in this field. readOnly: true items: type: string format: int64 servingStatus: type: string description: 'Optional. Whether the Floodlight activity is served. Allowed values — `FLOODLIGHT_ACTIVITY_SERVING_STATUS_UNSPECIFIED`: Type value is not specified or is unknown in this version.; `FLOODLIGHT_ACTIVITY_SERVING_STATUS_ENABLED`: Enabled.; `FLOODLIGHT_ACTIVITY_SERVING_STATUS_DISABLED`: Disabled.' enum: - FLOODLIGHT_ACTIVITY_SERVING_STATUS_UNSPECIFIED - FLOODLIGHT_ACTIVITY_SERVING_STATUS_ENABLED - FLOODLIGHT_ACTIVITY_SERVING_STATUS_DISABLED floodlightActivityId: type: string format: int64 description: Output only. The unique ID of the Floodlight activity. Assigned by the system. readOnly: true displayName: type: string description: Required. The display name of the Floodlight activity. sslRequired: type: boolean description: Output only. Whether tags are required to be compliant. readOnly: true floodlightGroupId: type: string format: int64 description: Required. Immutable. The ID of the parent Floodlight group. remarketingConfigs: type: array description: Output only. A list of configuration objects designating whether remarketing for this Floodlight Activity is enabled and available for a specifc advertiser. If enabled, this Floodlight Activity generates a remarketing user list that is able to be used in targeting under the advertiser. readOnly: true items: $ref: '#/components/schemas/RemarketingConfig' FloodlightGroup: type: object description: A single Floodlight group. properties: floodlightGroupId: type: string format: int64 description: Output only. The unique ID of the Floodlight group. Assigned by the system. readOnly: true lookbackWindow: $ref: '#/components/schemas/LookbackWindow' webTagType: type: string description: 'Required. The web tag type enabled for the Floodlight group. Allowed values — `WEB_TAG_TYPE_UNSPECIFIED`: Type value is not specified or is unknown in this version.; `WEB_TAG_TYPE_NONE`: No tag type.; `WEB_TAG_TYPE_IMAGE`: Image tag.; `WEB_TAG_TYPE_DYNAMIC`: Dynamic tag.' enum: - WEB_TAG_TYPE_UNSPECIFIED - WEB_TAG_TYPE_NONE - WEB_TAG_TYPE_IMAGE - WEB_TAG_TYPE_DYNAMIC customVariables: type: object description: 'User-defined custom variables owned by the Floodlight group. Use custom Floodlight variables to create reporting data that is tailored to your unique business needs. Custom Floodlight variables use the keys `U1=`, `U2=`, and so on, and can take any values that you choose to pass to them. You can use them to track virtually any type of data that you collect about your customers, such as the genre of movie that a customer purchases, the country to which the item is shipped, and so on. Custom Floodlight variables may not be used to pass any data that could be used or recognized as personally identifiable information (PII). Example: `custom_variables { fields { "U1": value { number_value: 123.4 }, "U2": value { string_value: "MyVariable2" }, "U3": value { string_value: "MyVariable3" } } }` Acceptable values for keys are "U1" through "U100", inclusive. String values must be less than 64 characters long, and cannot contain the following characters: `"<>`.' additionalProperties: description: Properties of the object. displayName: type: string description: Required. The display name of the Floodlight group. name: type: string description: Output only. The resource name of the Floodlight group. readOnly: true activeViewConfig: $ref: '#/components/schemas/ActiveViewVideoViewabilityMetricConfig' FrequencyCap: type: object description: Settings that control the number of times a user may be shown with the same ad during a given time period. properties: unlimited: type: boolean description: Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. timeUnit: type: string description: 'The time unit in which the frequency cap will be applied. Required when unlimited is `false`. Allowed values — `TIME_UNIT_UNSPECIFIED`: Time unit value is not specified or is unknown in this version.; `TIME_UNIT_LIFETIME`: The frequency cap will be applied to the whole life time of the line item.; `TIME_UNIT_MONTHS`: The frequency cap will be applied to a number of months.; `TIME_UNIT_WEEKS`: The frequency cap will be applied to a number of weeks.; `TIME_UNIT_DAYS`: The frequency cap will be applied to a number of days.; `TIME_UNIT_HOURS`: The frequency cap will be applied to a number of hours.; `TIME_UNIT_MINUTES`: The frequency cap will be applied to a number of minutes.' enum: - TIME_UNIT_UNSPECIFIED - TIME_UNIT_LIFETIME - TIME_UNIT_MONTHS - TIME_UNIT_WEEKS - TIME_UNIT_DAYS - TIME_UNIT_HOURS - TIME_UNIT_MINUTES timeUnitCount: type: integer format: int32 description: 'The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_MONTHS` - must be 1 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59' maxViews: type: integer format: int32 description: Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. maxImpressions: type: integer format: int32 description: The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. GenderAssignedTargetingOptionDetails: type: object description: Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. properties: gender: type: string description: 'Required. The gender of the audience. Allowed values — `GENDER_UNSPECIFIED`: Default value when gender is not specified in this version. This enum is a place holder for default value and does not represent a real gender option.; `GENDER_MALE`: The audience gender is male.; `GENDER_FEMALE`: The audience gender is female.; `GENDER_UNKNOWN`: The audience gender is unknown.' enum: - GENDER_UNSPECIFIED - GENDER_MALE - GENDER_FEMALE - GENDER_UNKNOWN GenderTargetingOptionDetails: type: object description: Represents a targetable gender. This will be populated in the gender_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. properties: gender: type: string description: 'Output only. The gender of an audience. Allowed values — `GENDER_UNSPECIFIED`: Default value when gender is not specified in this version. This enum is a place holder for default value and does not represent a real gender option.; `GENDER_MALE`: The audience gender is male.; `GENDER_FEMALE`: The audience gender is female.; `GENDER_UNKNOWN`: The audience gender is unknown.' enum: - GENDER_UNSPECIFIED - GENDER_MALE - GENDER_FEMALE - GENDER_UNKNOWN readOnly: true GenerateReachForecastRequest: type: object description: Request message for ReachForecastService.GenerateReachForecast. properties: campaignDuration: $ref: '#/components/schemas/CampaignDuration' currencyCode: type: string description: Required. The currency code for the plan in ISO 4217 format. plannedProducts: type: array description: Required. The list of line items to include in the forecast. items: $ref: '#/components/schemas/PlannedProduct' targeting: $ref: '#/components/schemas/Targeting' minEffectiveFrequency: type: integer format: int32 description: Optional. The minimum effective frequency for the reported reach metrics. This is the smallest number of times a customer must be exposed to the ad for it to be considered effective. This setting only impacts reporting. Must be between 1 and 10, inclusive. If not specified, a default of 1 is applied. GenerateReachForecastResponse: type: object description: Response message for ReachForecastService.GenerateReachForecast. properties: onTargetAudienceMetrics: $ref: '#/components/schemas/OnTargetAudienceMetrics' reachCurve: $ref: '#/components/schemas/ReachCurve' GeoRegionAssignedTargetingOptionDetails: type: object description: Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. properties: negative: type: boolean description: Indicates if this option is being negatively targeted. displayName: type: string description: Output only. The display name of the geographic region (e.g., "Ontario, Canada"). readOnly: true targetingOptionId: type: string description: Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`. geoRegionType: type: string description: 'Output only. The type of geographic region targeting. Allowed values — `GEO_REGION_TYPE_UNKNOWN`: The geographic region type is unknown.; `GEO_REGION_TYPE_OTHER`: The geographic region type is other.; `GEO_REGION_TYPE_COUNTRY`: The geographic region is a country.; `GEO_REGION_TYPE_REGION`: The geographic region type is region.; `GEO_REGION_TYPE_TERRITORY`: The geographic region is a territory.; `GEO_REGION_TYPE_PROVINCE`: The geographic region is a province.; `GEO_REGION_TYPE_STATE`: The geographic region is a state.; `GEO_REGION_TYPE_PREFECTURE`: The geographic region is a prefecture.; `GEO_REGION_TYPE_GOVERNORATE`: The geographic region is a governorate.; `GEO_REGION_TYPE_CANTON`: The geographic region is a canton.; `GEO_REGION_TYPE_UNION_TERRITORY`: The geographic region is a union territory.; `GEO_REGION_TYPE_AUTONOMOUS_COMMUNITY`: The geographic region is an autonomous community.; `GEO_REGION_TYPE_DMA_REGION`: The geographic region is a designated market area (DMA) region.; `GEO_REGION_TYPE_METRO`: The geographic region type is metro.; `GEO_REGION_TYPE_CONGRESSIONAL_DISTRICT`: The geographic region is a congressional district.; `GEO_REGION_TYPE_COUNTY`: The geographic region is a county.; `GEO_REGION_TYPE_MUNICIPALITY`: The geographic region is a municipality.; `GEO_REGION_TYPE_CITY`: The geographic region is a city.; `GEO_REGION_TYPE_POSTAL_CODE`: The geographic region targeting type is postal code.; `GEO_REGION_TYPE_DEPARTMENT`: The geographic region targeting type is department.; `GEO_REGION_TYPE_AIRPORT`: The geographic region is an airport.; `GEO_REGION_TYPE_TV_REGION`: The geographic region is a TV region.; `GEO_REGION_TYPE_OKRUG`: The geographic region is an okrug.; `GEO_REGION_TYPE_BOROUGH`: The geographic region is a borough.; `GEO_REGION_TYPE_CITY_REGION`: The geographic region is a city region.; `GEO_REGION_TYPE_ARRONDISSEMENT`: The geographic region is an arrondissement.; `GEO_REGION_TYPE_NEIGHBORHOOD`: The geographic region is a neighborhood.; `GEO_REGION_TYPE_UNIVERSITY`: The geographic region is a university.; `GEO_REGION_TYPE_DISTRICT`: The geographic region is a district.; `GEO_REGION_TYPE_NATIONAL_PARK`: The geographic region is a national park.; `GEO_REGION_TYPE_BARRIO`: The geographic region is a barrio.; `GEO_REGION_TYPE_SUB_WARD`: The geographic region is a sub ward.; `GEO_REGION_TYPE_MUNICIPALITY_DISTRICT`: The geographic region is a municipality district.; `GEO_REGION_TYPE_SUB_DISTRICT`: The geographic region is a sub district.; `GEO_REGION_TYPE_QUARTER`: The geographic region is a quarter.; `GEO_REGION_TYPE_DIVISION`: The geographic region is a division.; `GEO_REGION_TYPE_COMMUNE`: The geographic region is a commune.; `GEO_REGION_TYPE_COLLOQUIAL_AREA`: The geographic region is a colloquial area.; `GEO_REGION_TYPE_POST_TOWN`: The geographic region is a post town.; `GEO_REGION_TYPE_WARD`: The geographic region is a ward.; `GEO_REGION_TYPE_TOWN`: The geographic region is a town.; `GEO_REGION_TYPE_VILLAGE`: The geographic region is a village.; `GEO_REGION_TYPE_CITY_DISTRICT`: The geographic region is a city district.; `GEO_REGION_TYPE_SUBURB`: The geographic region is a suburb.; `GEO_REGION_TYPE_HAMLET`: The geographic region is a hamlet.; `GEO_REGION_TYPE_MUNICIPAL_DISTRICT`: The geographic region is a municipal district.; `GEO_REGION_TYPE_COMMUNITY`: The geographic region is a community.; `GEO_REGION_TYPE_TOWNSHIP`: The geographic region is a township.; `GEO_REGION_TYPE_URBAN_DISTRICT`: The geographic region is an urban district.; `GEO_REGION_TYPE_RESIDENTIAL_AREA`: The geographic region is a residential area.; `GEO_REGION_TYPE_INDEPENDENT_CITY`: The geographic region is an independent city.; `GEO_REGION_TYPE_SECTOR`: The geographic region is a sector.; `GEO_REGION_TYPE_AREA`: The geographic region is an area.; `GEO_REGION_TYPE_ESTATE`: The geographic region is an estate.; `GEO_REGION_TYPE_PARISH`: The geographic region is a parish.; `GEO_REGION_TYPE_SETTLEMENT`: The geographic region is a settlement.; `GEO_REGION_TYPE_ZONE`: The geographic region is a zone.; `GEO_REGION_TYPE_COLONY`: The geographic region is a colony.; `GEO_REGION_TYPE_INDUSTRIAL_AREA`: The geographic region is an industrial area.; `GEO_REGION_TYPE_PROVINCIAL_CITY`: The geographic region is a provincial city.; `GEO_REGION_TYPE_RURAL_DISTRICT`: The geographic region is a rural district.' 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 - GEO_REGION_TYPE_NATIONAL_PARK - GEO_REGION_TYPE_BARRIO - GEO_REGION_TYPE_SUB_WARD - GEO_REGION_TYPE_MUNICIPALITY_DISTRICT - GEO_REGION_TYPE_SUB_DISTRICT - GEO_REGION_TYPE_QUARTER - GEO_REGION_TYPE_DIVISION - GEO_REGION_TYPE_COMMUNE - GEO_REGION_TYPE_COLLOQUIAL_AREA - GEO_REGION_TYPE_POST_TOWN - GEO_REGION_TYPE_WARD - GEO_REGION_TYPE_TOWN - GEO_REGION_TYPE_VILLAGE - GEO_REGION_TYPE_CITY_DISTRICT - GEO_REGION_TYPE_SUBURB - GEO_REGION_TYPE_HAMLET - GEO_REGION_TYPE_MUNICIPAL_DISTRICT - GEO_REGION_TYPE_COMMUNITY - GEO_REGION_TYPE_TOWNSHIP - GEO_REGION_TYPE_URBAN_DISTRICT - GEO_REGION_TYPE_RESIDENTIAL_AREA - GEO_REGION_TYPE_INDEPENDENT_CITY - GEO_REGION_TYPE_SECTOR - GEO_REGION_TYPE_AREA - GEO_REGION_TYPE_ESTATE - GEO_REGION_TYPE_PARISH - GEO_REGION_TYPE_SETTLEMENT - GEO_REGION_TYPE_ZONE - GEO_REGION_TYPE_COLONY - GEO_REGION_TYPE_INDUSTRIAL_AREA - GEO_REGION_TYPE_PROVINCIAL_CITY - GEO_REGION_TYPE_RURAL_DISTRICT readOnly: true GeoRegionSearchTerms: type: object description: Search terms for geo region targeting options. properties: geoRegionQuery: type: string description: The search query for the desired geo region. The query can be a prefix, e.g. "New Yor", "Seattle", "USA", etc. GeoRegionTargetingOptionDetails: type: object description: Represents a targetable geographic region. This will be populated in the geo_region_details field when targeting_type is `TARGETING_TYPE_GEO_REGION`. properties: displayName: type: string description: Output only. The display name of the geographic region (e.g., "Ontario, Canada"). readOnly: true geoRegionType: type: string description: 'Output only. The type of geographic region targeting. Allowed values — `GEO_REGION_TYPE_UNKNOWN`: The geographic region type is unknown.; `GEO_REGION_TYPE_OTHER`: The geographic region type is other.; `GEO_REGION_TYPE_COUNTRY`: The geographic region is a country.; `GEO_REGION_TYPE_REGION`: The geographic region type is region.; `GEO_REGION_TYPE_TERRITORY`: The geographic region is a territory.; `GEO_REGION_TYPE_PROVINCE`: The geographic region is a province.; `GEO_REGION_TYPE_STATE`: The geographic region is a state.; `GEO_REGION_TYPE_PREFECTURE`: The geographic region is a prefecture.; `GEO_REGION_TYPE_GOVERNORATE`: The geographic region is a governorate.; `GEO_REGION_TYPE_CANTON`: The geographic region is a canton.; `GEO_REGION_TYPE_UNION_TERRITORY`: The geographic region is a union territory.; `GEO_REGION_TYPE_AUTONOMOUS_COMMUNITY`: The geographic region is an autonomous community.; `GEO_REGION_TYPE_DMA_REGION`: The geographic region is a designated market area (DMA) region.; `GEO_REGION_TYPE_METRO`: The geographic region type is metro.; `GEO_REGION_TYPE_CONGRESSIONAL_DISTRICT`: The geographic region is a congressional district.; `GEO_REGION_TYPE_COUNTY`: The geographic region is a county.; `GEO_REGION_TYPE_MUNICIPALITY`: The geographic region is a municipality.; `GEO_REGION_TYPE_CITY`: The geographic region is a city.; `GEO_REGION_TYPE_POSTAL_CODE`: The geographic region targeting type is postal code.; `GEO_REGION_TYPE_DEPARTMENT`: The geographic region targeting type is department.; `GEO_REGION_TYPE_AIRPORT`: The geographic region is an airport.; `GEO_REGION_TYPE_TV_REGION`: The geographic region is a TV region.; `GEO_REGION_TYPE_OKRUG`: The geographic region is an okrug.; `GEO_REGION_TYPE_BOROUGH`: The geographic region is a borough.; `GEO_REGION_TYPE_CITY_REGION`: The geographic region is a city region.; `GEO_REGION_TYPE_ARRONDISSEMENT`: The geographic region is an arrondissement.; `GEO_REGION_TYPE_NEIGHBORHOOD`: The geographic region is a neighborhood.; `GEO_REGION_TYPE_UNIVERSITY`: The geographic region is a university.; `GEO_REGION_TYPE_DISTRICT`: The geographic region is a district.; `GEO_REGION_TYPE_NATIONAL_PARK`: The geographic region is a national park.; `GEO_REGION_TYPE_BARRIO`: The geographic region is a barrio.; `GEO_REGION_TYPE_SUB_WARD`: The geographic region is a sub ward.; `GEO_REGION_TYPE_MUNICIPALITY_DISTRICT`: The geographic region is a municipality district.; `GEO_REGION_TYPE_SUB_DISTRICT`: The geographic region is a sub district.; `GEO_REGION_TYPE_QUARTER`: The geographic region is a quarter.; `GEO_REGION_TYPE_DIVISION`: The geographic region is a division.; `GEO_REGION_TYPE_COMMUNE`: The geographic region is a commune.; `GEO_REGION_TYPE_COLLOQUIAL_AREA`: The geographic region is a colloquial area.; `GEO_REGION_TYPE_POST_TOWN`: The geographic region is a post town.; `GEO_REGION_TYPE_WARD`: The geographic region is a ward.; `GEO_REGION_TYPE_TOWN`: The geographic region is a town.; `GEO_REGION_TYPE_VILLAGE`: The geographic region is a village.; `GEO_REGION_TYPE_CITY_DISTRICT`: The geographic region is a city district.; `GEO_REGION_TYPE_SUBURB`: The geographic region is a suburb.; `GEO_REGION_TYPE_HAMLET`: The geographic region is a hamlet.; `GEO_REGION_TYPE_MUNICIPAL_DISTRICT`: The geographic region is a municipal district.; `GEO_REGION_TYPE_COMMUNITY`: The geographic region is a community.; `GEO_REGION_TYPE_TOWNSHIP`: The geographic region is a township.; `GEO_REGION_TYPE_URBAN_DISTRICT`: The geographic region is an urban district.; `GEO_REGION_TYPE_RESIDENTIAL_AREA`: The geographic region is a residential area.; `GEO_REGION_TYPE_INDEPENDENT_CITY`: The geographic region is an independent city.; `GEO_REGION_TYPE_SECTOR`: The geographic region is a sector.; `GEO_REGION_TYPE_AREA`: The geographic region is an area.; `GEO_REGION_TYPE_ESTATE`: The geographic region is an estate.; `GEO_REGION_TYPE_PARISH`: The geographic region is a parish.; `GEO_REGION_TYPE_SETTLEMENT`: The geographic region is a settlement.; `GEO_REGION_TYPE_ZONE`: The geographic region is a zone.; `GEO_REGION_TYPE_COLONY`: The geographic region is a colony.; `GEO_REGION_TYPE_INDUSTRIAL_AREA`: The geographic region is an industrial area.; `GEO_REGION_TYPE_PROVINCIAL_CITY`: The geographic region is a provincial city.; `GEO_REGION_TYPE_RURAL_DISTRICT`: The geographic region is a rural district.' 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 - GEO_REGION_TYPE_NATIONAL_PARK - GEO_REGION_TYPE_BARRIO - GEO_REGION_TYPE_SUB_WARD - GEO_REGION_TYPE_MUNICIPALITY_DISTRICT - GEO_REGION_TYPE_SUB_DISTRICT - GEO_REGION_TYPE_QUARTER - GEO_REGION_TYPE_DIVISION - GEO_REGION_TYPE_COMMUNE - GEO_REGION_TYPE_COLLOQUIAL_AREA - GEO_REGION_TYPE_POST_TOWN - GEO_REGION_TYPE_WARD - GEO_REGION_TYPE_TOWN - GEO_REGION_TYPE_VILLAGE - GEO_REGION_TYPE_CITY_DISTRICT - GEO_REGION_TYPE_SUBURB - GEO_REGION_TYPE_HAMLET - GEO_REGION_TYPE_MUNICIPAL_DISTRICT - GEO_REGION_TYPE_COMMUNITY - GEO_REGION_TYPE_TOWNSHIP - GEO_REGION_TYPE_URBAN_DISTRICT - GEO_REGION_TYPE_RESIDENTIAL_AREA - GEO_REGION_TYPE_INDEPENDENT_CITY - GEO_REGION_TYPE_SECTOR - GEO_REGION_TYPE_AREA - GEO_REGION_TYPE_ESTATE - GEO_REGION_TYPE_PARISH - GEO_REGION_TYPE_SETTLEMENT - GEO_REGION_TYPE_ZONE - GEO_REGION_TYPE_COLONY - GEO_REGION_TYPE_INDUSTRIAL_AREA - GEO_REGION_TYPE_PROVINCIAL_CITY - GEO_REGION_TYPE_RURAL_DISTRICT readOnly: true GoogleAudience: type: object description: Describes a Google audience resource. Includes Google audience lists. properties: googleAudienceId: type: string format: int64 description: Output only. The unique ID of the Google audience. Assigned by the system. readOnly: true name: type: string description: Output only. The resource name of the google audience. readOnly: true displayName: type: string description: Output only. The display name of the Google audience. . readOnly: true googleAudienceType: type: string description: 'Output only. The type of Google audience. . Allowed values — `GOOGLE_AUDIENCE_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown.; `GOOGLE_AUDIENCE_TYPE_AFFINITY`: Affinity type Google audience.; `GOOGLE_AUDIENCE_TYPE_IN_MARKET`: In-Market type Google audience.; `GOOGLE_AUDIENCE_TYPE_INSTALLED_APPS`: Installed-Apps type Google audience.; `GOOGLE_AUDIENCE_TYPE_NEW_MOBILE_DEVICES`: New-Mobile-Devices type Google audience.; `GOOGLE_AUDIENCE_TYPE_LIFE_EVENT`: Life-Event type Google audience.; `GOOGLE_AUDIENCE_TYPE_EXTENDED_DEMOGRAPHIC`: Extended-Demographic type Google audience.' 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 - GOOGLE_AUDIENCE_TYPE_LIFE_EVENT - GOOGLE_AUDIENCE_TYPE_EXTENDED_DEMOGRAPHIC readOnly: true GoogleAudienceGroup: type: object description: Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. properties: settings: type: array description: Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. items: $ref: '#/components/schemas/GoogleAudienceTargetingSetting' GoogleAudienceTargetingSetting: type: object description: Details of Google audience targeting setting. properties: googleAudienceId: type: string format: int64 description: Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. GoogleBytestreamMedia: type: object description: Media resource. properties: resourceName: type: string description: Name of the media resource. GuaranteedOrder: type: object description: A guaranteed order. Guaranteed orders are parent entity of guaranteed inventory sources. When creating a guaranteed inventory source, a guaranteed order ID must be assigned to the inventory source. properties: defaultCampaignId: type: string format: int64 description: The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser. readWritePartnerId: type: string format: int64 description: The partner with read/write access to the guaranteed order. readAdvertiserIds: type: array description: The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id. items: type: string format: int64 displayName: type: string description: Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes. publisherName: type: string description: Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes. name: type: string description: Output only. The resource name of the guaranteed order. readOnly: true legacyGuaranteedOrderId: type: string description: Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI. readOnly: true updateTime: type: string format: google-datetime description: Output only. The timestamp when the guaranteed order was last updated. Assigned by the system. readOnly: true exchange: type: string description: 'Required. Immutable. The exchange where the guaranteed order originated. Allowed values — `EXCHANGE_UNSPECIFIED`: Exchange is not specified or is unknown in this version.; `EXCHANGE_GOOGLE_AD_MANAGER`: Google Ad Manager.; `EXCHANGE_APPNEXUS`: AppNexus.; `EXCHANGE_BRIGHTROLL`: BrightRoll Exchange for Video from Yahoo!.; `EXCHANGE_ADFORM`: Adform.; `EXCHANGE_ADMETA`: Admeta.; `EXCHANGE_ADMIXER`: Admixer.; `EXCHANGE_ADSMOGO`: AdsMogo.; `EXCHANGE_ADSWIZZ`: AdsWizz.; `EXCHANGE_BIDSWITCH`: BidSwitch.; `EXCHANGE_BRIGHTROLL_DISPLAY`: BrightRoll Exchange for Display from Yahoo!.; `EXCHANGE_CADREON`: Cadreon.; `EXCHANGE_DAILYMOTION`: Dailymotion.; `EXCHANGE_FIVE`: Five.; `EXCHANGE_FLUCT`: Fluct.; `EXCHANGE_FREEWHEEL`: FreeWheel SSP.; `EXCHANGE_GENIEE`: Geniee.; `EXCHANGE_GUMGUM`: GumGum.; `EXCHANGE_IMOBILE`: i-mobile.; `EXCHANGE_IBILLBOARD`: iBILLBOARD.; `EXCHANGE_IMPROVE_DIGITAL`: Improve Digital.; `EXCHANGE_INDEX`: Index Exchange.; `EXCHANGE_KARGO`: Kargo.; `EXCHANGE_MICROAD`: MicroAd.; `EXCHANGE_MOPUB`: MoPub.; `EXCHANGE_NEND`: Nend.; `EXCHANGE_ONE_BY_AOL_DISPLAY`: ONE by AOL: Display Market Place.; `EXCHANGE_ONE_BY_AOL_MOBILE`: ONE by AOL: Mobile.; `EXCHANGE_ONE_BY_AOL_VIDEO`: ONE by AOL: Video.; `EXCHANGE_OOYALA`: Ooyala.; `EXCHANGE_OPENX`: OpenX.; `EXCHANGE_PERMODO`: Permodo.; `EXCHANGE_PLATFORMONE`: Platform One.; `EXCHANGE_PLATFORMID`: PlatformId.; `EXCHANGE_PUBMATIC`: PubMatic.; `EXCHANGE_PULSEPOINT`: PulsePoint.; `EXCHANGE_REVENUEMAX`: RevenueMax.; `EXCHANGE_RUBICON`: Rubicon.; `EXCHANGE_SMARTCLIP`: SmartClip.; `EXCHANGE_SMARTRTB`: SmartRTB+.; `EXCHANGE_SMARTSTREAMTV`: SmartstreamTv.; `EXCHANGE_SOVRN`: Sovrn.; `EXCHANGE_SPOTXCHANGE`: SpotXchange.; `EXCHANGE_STROER`: Ströer SSP.; `EXCHANGE_TEADSTV`: TeadsTv.; `EXCHANGE_TELARIA`: Telaria.; `EXCHANGE_TVN`: TVN.; `EXCHANGE_UNITED`: United.; `EXCHANGE_YIELDLAB`: Yieldlab.; `EXCHANGE_YIELDMO`: Yieldmo.; `EXCHANGE_UNRULYX`: UnrulyX.; `EXCHANGE_OPEN8`: Open8.; `EXCHANGE_TRITON`: Triton.; `EXCHANGE_TRIPLELIFT`: TripleLift.; `EXCHANGE_TABOOLA`: Taboola.; `EXCHANGE_INMOBI`: InMobi.; `EXCHANGE_SMAATO`: Smaato.; `EXCHANGE_AJA`: Aja.; `EXCHANGE_SUPERSHIP`: Supership.; `EXCHANGE_NEXSTAR_DIGITAL`: Nexstar Digital.; `EXCHANGE_WAZE`: Waze.; `EXCHANGE_SOUNDCAST`: SoundCast.; `EXCHANGE_SHARETHROUGH`: Sharethrough.; `EXCHANGE_FYBER`: Fyber.; `EXCHANGE_RED_FOR_PUBLISHERS`: Red For Publishers.; `EXCHANGE_MEDIANET`: Media.net.; `EXCHANGE_TAPJOY`: Tapjoy.; `EXCHANGE_VISTAR`: Vistar.; `EXCHANGE_DAX`: DAX.; `EXCHANGE_JCD`: JCD.; `EXCHANGE_PLACE_EXCHANGE`: Place Exchange.; `EXCHANGE_APPLOVIN`: AppLovin.; `EXCHANGE_CONNATIX`: Connatix.; `EXCHANGE_RESET_DIGITAL`: Reset Digital.; `EXCHANGE_HIVESTACK`: Hivestack.; `EXCHANGE_DRAX`: Drax.; `EXCHANGE_APPLOVIN_GBID`: AppLovin MAX.; `EXCHANGE_FYBER_GBID`: DT Fairbid.; `EXCHANGE_UNITY_GBID`: Unity LevelPlay.; `EXCHANGE_CHARTBOOST_GBID`: Chartboost Mediation.; `EXCHANGE_ADMOST_GBID`: AdMost.; `EXCHANGE_TOPON_GBID`: TopOn.; `EXCHANGE_NETFLIX`: Netflix.; `EXCHANGE_CORE`: Core.; `EXCHANGE_COMMERCE_GRID`: Commerce Grid.; `EXCHANGE_SPOTIFY`: Spotify.; `EXCHANGE_TUBI`: Tubi.; `EXCHANGE_SNAP`: Snap.; `EXCHANGE_CADENT`: Cadent.; `EXCHANGE_EXTE`: Exte.' 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_SUPERSHIP - EXCHANGE_NEXSTAR_DIGITAL - EXCHANGE_WAZE - EXCHANGE_SOUNDCAST - EXCHANGE_SHARETHROUGH - EXCHANGE_FYBER - EXCHANGE_RED_FOR_PUBLISHERS - EXCHANGE_MEDIANET - EXCHANGE_TAPJOY - EXCHANGE_VISTAR - EXCHANGE_DAX - EXCHANGE_JCD - EXCHANGE_PLACE_EXCHANGE - EXCHANGE_APPLOVIN - EXCHANGE_CONNATIX - EXCHANGE_RESET_DIGITAL - EXCHANGE_HIVESTACK - EXCHANGE_DRAX - EXCHANGE_APPLOVIN_GBID - EXCHANGE_FYBER_GBID - EXCHANGE_UNITY_GBID - EXCHANGE_CHARTBOOST_GBID - EXCHANGE_ADMOST_GBID - EXCHANGE_TOPON_GBID - EXCHANGE_NETFLIX - EXCHANGE_CORE - EXCHANGE_COMMERCE_GRID - EXCHANGE_SPOTIFY - EXCHANGE_TUBI - EXCHANGE_SNAP - EXCHANGE_CADENT - EXCHANGE_EXTE readWriteAdvertiserId: type: string format: int64 description: The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order. readAccessInherited: type: boolean description: Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids. guaranteedOrderId: type: string description: Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`. readOnly: true status: $ref: '#/components/schemas/GuaranteedOrderStatus' defaultAdvertiserId: type: string format: int64 description: Output only. The ID of default advertiser of the guaranteed order. The default advertiser is either the read_write_advertiser_id or, if that is not set, the first advertiser listed in read_advertiser_ids. Otherwise, there is no default advertiser. readOnly: true GuaranteedOrderStatus: type: object description: The status settings of the guaranteed order. properties: entityPauseReason: type: string description: The user-provided reason for pausing this guaranteed order. Must be UTF-8 encoded with a maximum length of 100 bytes. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`. entityStatus: type: string description: 'Whether or not the guaranteed order is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`. Allowed values — `ENTITY_STATUS_UNSPECIFIED`: Default value when status is not specified or is unknown in this version.; `ENTITY_STATUS_ACTIVE`: The entity is enabled to bid and spend budget.; `ENTITY_STATUS_ARCHIVED`: The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.; `ENTITY_STATUS_DRAFT`: The entity is under draft. Bidding and budget spending are disabled.; `ENTITY_STATUS_PAUSED`: Bidding and budget spending are paused for the entity.; `ENTITY_STATUS_SCHEDULED_FOR_DELETION`: The entity is scheduled for deletion.' enum: - ENTITY_STATUS_UNSPECIFIED - ENTITY_STATUS_ACTIVE - ENTITY_STATUS_ARCHIVED - ENTITY_STATUS_DRAFT - ENTITY_STATUS_PAUSED - ENTITY_STATUS_SCHEDULED_FOR_DELETION configStatus: type: string description: 'Output only. The configuration status of the guaranteed order. Acceptable values are `PENDING` and `COMPLETED`. A guaranteed order must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. Currently the configuration action can only be performed via UI. Allowed values — `GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED`: The approval status is not specified or is unknown in this version.; `PENDING`: The beginning state of a guaranteed order. The guaranteed order in this state needs to be configured before it can serve.; `COMPLETED`: The state after the buyer configures a guaranteed order.' enum: - GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED - PENDING - COMPLETED readOnly: true HouseholdIncomeAssignedTargetingOptionDetails: type: object description: Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. properties: householdIncome: type: string description: 'Required. The household income of the audience. Allowed values — `HOUSEHOLD_INCOME_UNSPECIFIED`: Default value when household income is not specified in this version. This enum is a placeholder for default value and does not represent a real household income option.; `HOUSEHOLD_INCOME_UNKNOWN`: The household income of the audience is unknown.; `HOUSEHOLD_INCOME_LOWER_50_PERCENT`: The audience is in the lower 50% of U.S. household incomes.; `HOUSEHOLD_INCOME_TOP_41_TO_50_PERCENT`: The audience is in the top 41-50% of U.S. household incomes.; `HOUSEHOLD_INCOME_TOP_31_TO_40_PERCENT`: The audience is in the top 31-40% of U.S. household incomes.; `HOUSEHOLD_INCOME_TOP_21_TO_30_PERCENT`: The audience is in the top 21-30% of U.S. household incomes.; `HOUSEHOLD_INCOME_TOP_11_TO_20_PERCENT`: The audience is in the top 11-20% of U.S. household incomes.; `HOUSEHOLD_INCOME_TOP_10_PERCENT`: The audience is in the top 10% of U.S. household incomes.' 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 HouseholdIncomeTargetingOptionDetails: type: object description: Represents a targetable household income. This will be populated in the household_income_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. properties: householdIncome: type: string description: 'Output only. The household income of an audience. Allowed values — `HOUSEHOLD_INCOME_UNSPECIFIED`: Default value when household income is not specified in this version. This enum is a placeholder for default value and does not represent a real household income option.; `HOUSEHOLD_INCOME_UNKNOWN`: The household income of the audience is unknown.; `HOUSEHOLD_INCOME_LOWER_50_PERCENT`: The audience is in the lower 50% of U.S. household incomes.; `HOUSEHOLD_INCOME_TOP_41_TO_50_PERCENT`: The audience is in the top 41-50% of U.S. household incomes.; `HOUSEHOLD_INCOME_TOP_31_TO_40_PERCENT`: The audience is in the top 31-40% of U.S. household incomes.; `HOUSEHOLD_INCOME_TOP_21_TO_30_PERCENT`: The audience is in the top 21-30% of U.S. household incomes.; `HOUSEHOLD_INCOME_TOP_11_TO_20_PERCENT`: The audience is in the top 11-20% of U.S. household incomes.; `HOUSEHOLD_INCOME_TOP_10_PERCENT`: The audience is in the top 10% of U.S. household incomes.' 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 readOnly: true IdFilter: type: object description: A filtering option that filters entities by their entity IDs. properties: mediaProductIds: type: array description: Media Products to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. items: type: string format: int64 lineItemIds: type: array description: Line Items to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. items: type: string format: int64 adGroupIds: type: array description: YouTube Ad Groups to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. items: type: string format: int64 lineItemQaIds: type: array description: Optional. Line Items, by ID, to download in QA format. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. items: type: string format: int64 campaignIds: type: array description: Campaigns to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. items: type: string format: int64 adGroupAdIds: type: array description: YouTube Ads to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. items: type: string format: int64 adGroupQaIds: type: array description: Optional. YouTube Ad Groups, by ID, to download in QA format. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. items: type: string format: int64 insertionOrderIds: type: array description: Insertion Orders to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. items: type: string format: int64 ImageAsset: type: object description: Meta data of an image asset. properties: fileSize: type: string format: int64 description: Output only. File size of the image asset in bytes. readOnly: true assetId: type: string format: int64 description: Required. The unique ID of the asset. fullSize: $ref: '#/components/schemas/Dimensions' mimeType: type: string description: Output only. MIME type of the image asset. readOnly: true InStreamAd: type: object description: Details for an in-stream ad. properties: commonInStreamAttribute: $ref: '#/components/schemas/CommonInStreamAttribute' customParameters: type: object description: The custom parameters and accompanying values to add to the tracking URL. additionalProperties: type: string InsertionOrder: type: object description: A single insertion order. properties: partnerCosts: type: array description: Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. items: $ref: '#/components/schemas/PartnerCost' budget: $ref: '#/components/schemas/InsertionOrderBudget' reservationType: type: string description: 'Output only. The reservation type of the insertion order. Allowed values — `RESERVATION_TYPE_UNSPECIFIED`: Reservation type value is not specified or is unknown in this version.; `RESERVATION_TYPE_NOT_GUARANTEED`: Not created through a guaranteed inventory source.; `RESERVATION_TYPE_PROGRAMMATIC_GUARANTEED`: Created through a programmatic guaranteed inventory source.; `RESERVATION_TYPE_TAG_GUARANTEED`: Created through a tag guaranteed inventory source.; `RESERVATION_TYPE_PETRA_VIRAL`: Created through a Petra inventory source. Only applicable to YouTube and Partners line items.; `RESERVATION_TYPE_INSTANT_RESERVE`: Created with an instant quote. Only applicable to YouTube and partners line items.' enum: - RESERVATION_TYPE_UNSPECIFIED - RESERVATION_TYPE_NOT_GUARANTEED - RESERVATION_TYPE_PROGRAMMATIC_GUARANTEED - RESERVATION_TYPE_TAG_GUARANTEED - RESERVATION_TYPE_PETRA_VIRAL - RESERVATION_TYPE_INSTANT_RESERVE readOnly: true advertiserId: type: string format: int64 description: Output only. The unique ID of the advertiser the insertion order belongs to. readOnly: true integrationDetails: $ref: '#/components/schemas/IntegrationDetails' campaignId: type: string format: int64 description: Required. Immutable. The unique ID of the campaign that the insertion order belongs to. insertionOrderType: type: string description: 'Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. Allowed values — `INSERTION_ORDER_TYPE_UNSPECIFIED`: Insertion order type is not specified or is unknown.; `RTB`: Real-time bidding.; `OVER_THE_TOP`: Over-the-top.' enum: - INSERTION_ORDER_TYPE_UNSPECIFIED - RTB - OVER_THE_TOP name: type: string description: Output only. The resource name of the insertion order. readOnly: true frequencyCap: $ref: '#/components/schemas/FrequencyCap' displayName: type: string description: Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes. kpi: $ref: '#/components/schemas/Kpi' insertionOrderId: type: string format: int64 description: Output only. The unique ID of the insertion order. Assigned by the system. readOnly: true optimizationObjective: type: string description: 'Optional. Required. The optimization objective of the insertion order. Allowed values — `OPTIMIZATION_OBJECTIVE_UNSPECIFIED`: Type value is not specified or is unknown in this version.; `CONVERSION`: Prioritize impressions that increase sales and conversions.; `CLICK`: Prioritize impressions that increase website traffic, apps, app stores.; `BRAND_AWARENESS`: Prioritize impressions of specific quality.; `CUSTOM`: Objective is defined by the assigned custom bidding algorithm.; `NO_OBJECTIVE`: Objective is not defined. Any KPI or bidding strategy can be used.' enum: - OPTIMIZATION_OBJECTIVE_UNSPECIFIED - CONVERSION - CLICK - BRAND_AWARENESS - CUSTOM - NO_OBJECTIVE entityStatus: type: string description: 'Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active. Allowed values — `ENTITY_STATUS_UNSPECIFIED`: Default value when status is not specified or is unknown in this version.; `ENTITY_STATUS_ACTIVE`: The entity is enabled to bid and spend budget.; `ENTITY_STATUS_ARCHIVED`: The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.; `ENTITY_STATUS_DRAFT`: The entity is under draft. Bidding and budget spending are disabled.; `ENTITY_STATUS_PAUSED`: Bidding and budget spending are paused for the entity.; `ENTITY_STATUS_SCHEDULED_FOR_DELETION`: The entity is scheduled for deletion.' enum: - ENTITY_STATUS_UNSPECIFIED - ENTITY_STATUS_ACTIVE - ENTITY_STATUS_ARCHIVED - ENTITY_STATUS_DRAFT - ENTITY_STATUS_PAUSED - ENTITY_STATUS_SCHEDULED_FOR_DELETION pacing: $ref: '#/components/schemas/Pacing' updateTime: type: string format: google-datetime description: Output only. The timestamp when the insertion order was last updated. Assigned by the system. readOnly: true bidStrategy: $ref: '#/components/schemas/BiddingStrategy' InsertionOrderBudget: type: object description: Settings that control how insertion order budget is allocated. properties: budgetUnit: type: string description: 'Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. Allowed values — `BUDGET_UNIT_UNSPECIFIED`: Type value is not specified or is unknown in this version.; `BUDGET_UNIT_CURRENCY`: Budgeting in currency amounts.; `BUDGET_UNIT_IMPRESSIONS`: Budgeting in impression amounts.' enum: - BUDGET_UNIT_UNSPECIFIED - BUDGET_UNIT_CURRENCY - BUDGET_UNIT_IMPRESSIONS automationType: type: string description: 'Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. Allowed values — `INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED`: Insertion order automation option is not specified or is unknown in this version.; `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET`: Automatic budget allocation. Allow the system to automatically shift budget to owning line items to optimize performance defined by kpi. No automation on bid settings.; `INSERTION_ORDER_AUTOMATION_TYPE_NONE`: No automation of bid or budget on insertion order level. Bid and budget must be manually configured at the line item level.; `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`: Allow the system to automatically adjust bids and shift budget to owning line items to optimize performance defined by bid_strategy.' enum: - INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED - INSERTION_ORDER_AUTOMATION_TYPE_BUDGET - INSERTION_ORDER_AUTOMATION_TYPE_NONE - INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET budgetSegments: type: array description: Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running. items: $ref: '#/components/schemas/InsertionOrderBudgetSegment' InsertionOrderBudgetSegment: type: object description: Settings that control the budget of a single budget segment. properties: campaignBudgetId: type: string format: int64 description: Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of. budgetAmountMicros: type: string format: int64 description: Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. description: type: string description: Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. dateRange: $ref: '#/components/schemas/DateRange' IntegralAdScience: type: object description: Details of Integral Ad Science settings. properties: excludeUnrateable: type: boolean description: Brand Safety - **Unrateable**. excludedGamblingRisk: type: string description: 'Brand Safety - **Gambling**. Allowed values — `GAMBLING_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any gambling options.; `GAMBLING_HR`: Gambling - Exclude High Risk.; `GAMBLING_HMR`: Gambling - Exclude High and Moderate Risk.' enum: - GAMBLING_UNSPECIFIED - GAMBLING_HR - GAMBLING_HMR qualitySyncCustomSegmentId: type: array description: Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive. items: type: string format: int64 excludedHateSpeechRisk: type: string description: 'Brand Safety - **Hate speech**. Allowed values — `HATE_SPEECH_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any hate speech options.; `HATE_SPEECH_HR`: Hate Speech - Exclude High Risk.; `HATE_SPEECH_HMR`: Hate Speech - Exclude High and Moderate Risk.' enum: - HATE_SPEECH_UNSPECIFIED - HATE_SPEECH_HR - HATE_SPEECH_HMR displayViewability: type: string description: 'Display Viewability section (applicable to display line items only). Allowed values — `PERFORMANCE_VIEWABILITY_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any display viewability options.; `PERFORMANCE_VIEWABILITY_40`: Target 40% Viewability or Higher.; `PERFORMANCE_VIEWABILITY_50`: Target 50% Viewability or Higher.; `PERFORMANCE_VIEWABILITY_60`: Target 60% Viewability or Higher.; `PERFORMANCE_VIEWABILITY_70`: Target 70% Viewability or Higher.' enum: - PERFORMANCE_VIEWABILITY_UNSPECIFIED - PERFORMANCE_VIEWABILITY_40 - PERFORMANCE_VIEWABILITY_50 - PERFORMANCE_VIEWABILITY_60 - PERFORMANCE_VIEWABILITY_70 excludedAdFraudRisk: type: string description: 'Ad Fraud settings. Allowed values — `SUSPICIOUS_ACTIVITY_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any ad fraud prevention options.; `SUSPICIOUS_ACTIVITY_HR`: Ad Fraud - Exclude High Risk.; `SUSPICIOUS_ACTIVITY_HMR`: Ad Fraud - Exclude High and Moderate Risk.; `SUSPICIOUS_ACTIVITY_FD`: Ad Fraud - Exclude Fraudulent Device.' enum: - SUSPICIOUS_ACTIVITY_UNSPECIFIED - SUSPICIOUS_ACTIVITY_HR - SUSPICIOUS_ACTIVITY_HMR - SUSPICIOUS_ACTIVITY_FD customSegmentId: type: array description: The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. items: type: string format: int64 excludedOffensiveLanguageRisk: type: string description: 'Brand Safety - **Offensive language**. Allowed values — `OFFENSIVE_LANGUAGE_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any language options.; `OFFENSIVE_LANGUAGE_HR`: Offensive Language - Exclude High Risk.; `OFFENSIVE_LANGUAGE_HMR`: Offensive Language - Exclude High and Moderate Risk.' enum: - OFFENSIVE_LANGUAGE_UNSPECIFIED - OFFENSIVE_LANGUAGE_HR - OFFENSIVE_LANGUAGE_HMR traqScoreOption: type: string description: 'True advertising quality (applicable to Display line items only). Allowed values — `TRAQ_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any true advertising quality scores.; `TRAQ_250`: TRAQ score 250-1000.; `TRAQ_500`: TRAQ score 500-1000.; `TRAQ_600`: TRAQ score 600-1000.; `TRAQ_700`: TRAQ score 700-1000.; `TRAQ_750`: TRAQ score 750-1000.; `TRAQ_875`: TRAQ score 875-1000.; `TRAQ_1000`: TRAQ score 1000.' enum: - TRAQ_UNSPECIFIED - TRAQ_250 - TRAQ_500 - TRAQ_600 - TRAQ_700 - TRAQ_750 - TRAQ_875 - TRAQ_1000 excludedAlcoholRisk: type: string description: 'Brand Safety - **Alcohol**. Allowed values — `ALCOHOL_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any alcohol options.; `ALCOHOL_HR`: Alcohol - Exclude High Risk.; `ALCOHOL_HMR`: Alcohol - Exclude High and Moderate Risk.' enum: - ALCOHOL_UNSPECIFIED - ALCOHOL_HR - ALCOHOL_HMR excludedIllegalDownloadsRisk: type: string description: 'Brand Safety - **Illegal downloads**. Allowed values — `ILLEGAL_DOWNLOADS_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any illegal downloads options.; `ILLEGAL_DOWNLOADS_HR`: Illegal Downloads - Exclude High Risk.; `ILLEGAL_DOWNLOADS_HMR`: Illegal Downloads - Exclude High and Moderate Risk.' enum: - ILLEGAL_DOWNLOADS_UNSPECIFIED - ILLEGAL_DOWNLOADS_HR - ILLEGAL_DOWNLOADS_HMR videoViewability: type: string description: 'Video Viewability Section (applicable to video line items only). Allowed values — `VIDEO_VIEWABILITY_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any video viewability options.; `VIDEO_VIEWABILITY_40`: 40%+ in view (IAB video viewability standard).; `VIDEO_VIEWABILITY_50`: 50%+ in view (IAB video viewability standard).; `VIDEO_VIEWABILITY_60`: 60%+ in view (IAB video viewability standard).; `VIDEO_VIEWABILITY_70`: 70%+ in view (IAB video viewability standard).' enum: - VIDEO_VIEWABILITY_UNSPECIFIED - VIDEO_VIEWABILITY_40 - VIDEO_VIEWABILITY_50 - VIDEO_VIEWABILITY_60 - VIDEO_VIEWABILITY_70 excludedAdultRisk: type: string description: 'Brand Safety - **Adult content**. Allowed values — `ADULT_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any adult options.; `ADULT_HR`: Adult - Exclude High Risk.; `ADULT_HMR`: Adult - Exclude High and Moderate Risk.' enum: - ADULT_UNSPECIFIED - ADULT_HR - ADULT_HMR excludedDrugsRisk: type: string description: 'Brand Safety - **Drugs**. Allowed values — `DRUGS_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any drugs options.; `DRUGS_HR`: Drugs - Exclude High Risk.; `DRUGS_HMR`: Drugs - Exclude High and Moderate Risk.' enum: - DRUGS_UNSPECIFIED - DRUGS_HR - DRUGS_HMR excludedViolenceRisk: type: string description: 'Brand Safety - **Violence**. Allowed values — `VIOLENCE_UNSPECIFIED`: This enum is only a placeholder and it doesn''t specify any violence options.; `VIOLENCE_HR`: Violence - Exclude High Risk.; `VIOLENCE_HMR`: Violence - Exclude High and Moderate Risk.' enum: - VIOLENCE_UNSPECIFIED - VIOLENCE_HR - VIOLENCE_HMR IntegrationDetails: type: object description: Integration details of an entry. properties: integrationCode: type: string description: An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters. details: type: string description: Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters. InventorySource: type: object description: An inventory source. properties: creativeConfigs: type: array description: The creative requirements of the inventory source. Not applicable for auction packages. items: $ref: '#/components/schemas/CreativeConfig' readPartnerIds: type: array description: Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source. readOnly: true items: type: string format: int64 commitment: type: string description: 'Whether the inventory source has a guaranteed or non-guaranteed delivery. Allowed values — `INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED`: The commitment is not specified or is unknown in this version.; `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`: The commitment is guaranteed delivery.; `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`: The commitment is non-guaranteed delivery.' enum: - INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED - INVENTORY_SOURCE_COMMITMENT_GUARANTEED - INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED dealId: type: string description: The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges. status: $ref: '#/components/schemas/InventorySourceStatus' inventorySourceType: type: string description: 'Denotes the type of the inventory source. Allowed values — `INVENTORY_SOURCE_TYPE_UNSPECIFIED`: The inventory source type is not specified or is unknown in this version.; `INVENTORY_SOURCE_TYPE_PRIVATE`: Private inventory source.; `INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE`: Auction package.' enum: - INVENTORY_SOURCE_TYPE_UNSPECIFIED - INVENTORY_SOURCE_TYPE_PRIVATE - INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE inventorySourceId: type: string format: int64 description: Output only. The unique ID of the inventory source. Assigned by the system. readOnly: true inventorySourceProductType: type: string description: 'Output only. The product type of the inventory source, denoting the way through which it sells inventory. Allowed values — `INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED`: The product type is not specified or is unknown in this version. Modifying inventory sources of this product type are not supported via API.; `PREFERRED_DEAL`: The inventory source sells inventory through Preferred Deal.; `PRIVATE_AUCTION`: The inventory source sells inventory through Private Auction.; `PROGRAMMATIC_GUARANTEED`: The inventory source sells inventory through Programmatic Guaranteed.; `TAG_GUARANTEED`: The inventory source sells inventory through Tag Guaranteed.; `YOUTUBE_RESERVE`: The inventory source sells inventory through YouTube Reserve.; `INSTANT_RESERVE`: The inventory source sells inventory through Instant Reserve. Modifying inventory sources of this product type are not supported via API.; `GUARANTEED_PACKAGE`: The inventory source sells inventory through Guaranteed Package. Modifying inventory sources of this product type are not supported via API.; `PROGRAMMATIC_TV`: The inventory source sells inventory through Programmtic TV. Modifying inventory sources of this product type are not supported via API.; `AUCTION_PACKAGE`: The inventory source sells inventory through Auction Package. Modifying inventory sources of this product type are not supported via API.' enum: - INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED - PREFERRED_DEAL - PRIVATE_AUCTION - PROGRAMMATIC_GUARANTEED - TAG_GUARANTEED - YOUTUBE_RESERVE - INSTANT_RESERVE - GUARANTEED_PACKAGE - PROGRAMMATIC_TV - AUCTION_PACKAGE readOnly: true guaranteedOrderId: type: string description: Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`. updateTime: type: string format: google-datetime description: Output only. The timestamp when the inventory source was last updated. Assigned by the system. readOnly: true exchange: type: string description: 'The exchange to which the inventory source belongs. Allowed values — `EXCHANGE_UNSPECIFIED`: Exchange is not specified or is unknown in this version.; `EXCHANGE_GOOGLE_AD_MANAGER`: Google Ad Manager.; `EXCHANGE_APPNEXUS`: AppNexus.; `EXCHANGE_BRIGHTROLL`: BrightRoll Exchange for Video from Yahoo!.; `EXCHANGE_ADFORM`: Adform.; `EXCHANGE_ADMETA`: Admeta.; `EXCHANGE_ADMIXER`: Admixer.; `EXCHANGE_ADSMOGO`: AdsMogo.; `EXCHANGE_ADSWIZZ`: AdsWizz.; `EXCHANGE_BIDSWITCH`: BidSwitch.; `EXCHANGE_BRIGHTROLL_DISPLAY`: BrightRoll Exchange for Display from Yahoo!.; `EXCHANGE_CADREON`: Cadreon.; `EXCHANGE_DAILYMOTION`: Dailymotion.; `EXCHANGE_FIVE`: Five.; `EXCHANGE_FLUCT`: Fluct.; `EXCHANGE_FREEWHEEL`: FreeWheel SSP.; `EXCHANGE_GENIEE`: Geniee.; `EXCHANGE_GUMGUM`: GumGum.; `EXCHANGE_IMOBILE`: i-mobile.; `EXCHANGE_IBILLBOARD`: iBILLBOARD.; `EXCHANGE_IMPROVE_DIGITAL`: Improve Digital.; `EXCHANGE_INDEX`: Index Exchange.; `EXCHANGE_KARGO`: Kargo.; `EXCHANGE_MICROAD`: MicroAd.; `EXCHANGE_MOPUB`: MoPub.; `EXCHANGE_NEND`: Nend.; `EXCHANGE_ONE_BY_AOL_DISPLAY`: ONE by AOL: Display Market Place.; `EXCHANGE_ONE_BY_AOL_MOBILE`: ONE by AOL: Mobile.; `EXCHANGE_ONE_BY_AOL_VIDEO`: ONE by AOL: Video.; `EXCHANGE_OOYALA`: Ooyala.; `EXCHANGE_OPENX`: OpenX.; `EXCHANGE_PERMODO`: Permodo.; `EXCHANGE_PLATFORMONE`: Platform One.; `EXCHANGE_PLATFORMID`: PlatformId.; `EXCHANGE_PUBMATIC`: PubMatic.; `EXCHANGE_PULSEPOINT`: PulsePoint.; `EXCHANGE_REVENUEMAX`: RevenueMax.; `EXCHANGE_RUBICON`: Rubicon.; `EXCHANGE_SMARTCLIP`: SmartClip.; `EXCHANGE_SMARTRTB`: SmartRTB+.; `EXCHANGE_SMARTSTREAMTV`: SmartstreamTv.; `EXCHANGE_SOVRN`: Sovrn.; `EXCHANGE_SPOTXCHANGE`: SpotXchange.; `EXCHANGE_STROER`: Ströer SSP.; `EXCHANGE_TEADSTV`: TeadsTv.; `EXCHANGE_TELARIA`: Telaria.; `EXCHANGE_TVN`: TVN.; `EXCHANGE_UNITED`: United.; `EXCHANGE_YIELDLAB`: Yieldlab.; `EXCHANGE_YIELDMO`: Yieldmo.; `EXCHANGE_UNRULYX`: UnrulyX.; `EXCHANGE_OPEN8`: Open8.; `EXCHANGE_TRITON`: Triton.; `EXCHANGE_TRIPLELIFT`: TripleLift.; `EXCHANGE_TABOOLA`: Taboola.; `EXCHANGE_INMOBI`: InMobi.; `EXCHANGE_SMAATO`: Smaato.; `EXCHANGE_AJA`: Aja.; `EXCHANGE_SUPERSHIP`: Supership.; `EXCHANGE_NEXSTAR_DIGITAL`: Nexstar Digital.; `EXCHANGE_WAZE`: Waze.; `EXCHANGE_SOUNDCAST`: SoundCast.; `EXCHANGE_SHARETHROUGH`: Sharethrough.; `EXCHANGE_FYBER`: Fyber.; `EXCHANGE_RED_FOR_PUBLISHERS`: Red For Publishers.; `EXCHANGE_MEDIANET`: Media.net.; `EXCHANGE_TAPJOY`: Tapjoy.; `EXCHANGE_VISTAR`: Vistar.; `EXCHANGE_DAX`: DAX.; `EXCHANGE_JCD`: JCD.; `EXCHANGE_PLACE_EXCHANGE`: Place Exchange.; `EXCHANGE_APPLOVIN`: AppLovin.; `EXCHANGE_CONNATIX`: Connatix.; `EXCHANGE_RESET_DIGITAL`: Reset Digital.; `EXCHANGE_HIVESTACK`: Hivestack.; `EXCHANGE_DRAX`: Drax.; `EXCHANGE_APPLOVIN_GBID`: AppLovin MAX.; `EXCHANGE_FYBER_GBID`: DT Fairbid.; `EXCHANGE_UNITY_GBID`: Unity LevelPlay.; `EXCHANGE_CHARTBOOST_GBID`: Chartboost Mediation.; `EXCHANGE_ADMOST_GBID`: AdMost.; `EXCHANGE_TOPON_GBID`: TopOn.; `EXCHANGE_NETFLIX`: Netflix.; `EXCHANGE_CORE`: Core.; `EXCHANGE_COMMERCE_GRID`: Commerce Grid.; `EXCHANGE_SPOTIFY`: Spotify.; `EXCHANGE_TUBI`: Tubi.; `EXCHANGE_SNAP`: Snap.; `EXCHANGE_CADENT`: Cadent.; `EXCHANGE_EXTE`: Exte.' 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_SUPERSHIP - EXCHANGE_NEXSTAR_DIGITAL - EXCHANGE_WAZE - EXCHANGE_SOUNDCAST - EXCHANGE_SHARETHROUGH - EXCHANGE_FYBER - EXCHANGE_RED_FOR_PUBLISHERS - EXCHANGE_MEDIANET - EXCHANGE_TAPJOY - EXCHANGE_VISTAR - EXCHANGE_DAX - EXCHANGE_JCD - EXCHANGE_PLACE_EXCHANGE - EXCHANGE_APPLOVIN - EXCHANGE_CONNATIX - EXCHANGE_RESET_DIGITAL - EXCHANGE_HIVESTACK - EXCHANGE_DRAX - EXCHANGE_APPLOVIN_GBID - EXCHANGE_FYBER_GBID - EXCHANGE_UNITY_GBID - EXCHANGE_CHARTBOOST_GBID - EXCHANGE_ADMOST_GBID - EXCHANGE_TOPON_GBID - EXCHANGE_NETFLIX - EXCHANGE_CORE - EXCHANGE_COMMERCE_GRID - EXCHANGE_SPOTIFY - EXCHANGE_TUBI - EXCHANGE_SNAP - EXCHANGE_CADENT - EXCHANGE_EXTE rateDetails: $ref: '#/components/schemas/RateDetails' publisherName: type: string description: The publisher/seller name of the inventory source. name: type: string description: Output only. The resource name of the inventory source. readOnly: true displayName: type: string description: The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes. readWriteAccessors: $ref: '#/components/schemas/InventorySourceAccessors' timeRange: $ref: '#/components/schemas/TimeRange' deliveryMethod: type: string description: 'The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. Allowed values — `INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED`: The delivery method is not specified or is unknown in this version.; `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`: The delivery method is programmatic.; `INVENTORY_SOURCE_DELIVERY_METHOD_TAG`: The delivery method is tag.' enum: - INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED - INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC - INVENTORY_SOURCE_DELIVERY_METHOD_TAG readAdvertiserIds: type: array description: Output only. The IDs of advertisers with read-only access to the inventory source. readOnly: true items: type: string format: int64 InventorySourceAccessors: type: object description: The partner or advertisers with access to the inventory source. properties: advertisers: $ref: '#/components/schemas/InventorySourceAccessorsAdvertiserAccessors' partner: $ref: '#/components/schemas/InventorySourceAccessorsPartnerAccessor' InventorySourceAccessorsAdvertiserAccessors: type: object description: The advertisers with access to the inventory source. properties: advertiserIds: type: array description: The IDs of the advertisers. items: type: string format: int64 InventorySourceAccessorsPartnerAccessor: type: object description: The partner with access to the inventory source. properties: partnerId: type: string format: int64 description: The ID of the partner. InventorySourceAssignedTargetingOptionDetails: type: object description: Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. properties: inventorySourceId: type: string format: int64 description: Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource. InventorySourceDisplayCreativeConfig: type: object description: The configuration for display creatives. properties: creativeSize: $ref: '#/components/schemas/Dimensions' InventorySourceFilter: type: object description: A filtering option for filtering on Inventory Source entities. properties: inventorySourceIds: type: array description: Inventory Sources to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Leave empty to download all Inventory Sources for the selected Advertiser or Partner. items: type: string format: int64 InventorySourceGroup: type: object description: A collection of targetable inventory sources. properties: name: type: string description: Output only. The resource name of the inventory source group. readOnly: true inventorySourceGroupId: type: string format: int64 description: Output only. The unique ID of the inventory source group. Assigned by the system. readOnly: true displayName: type: string description: Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes. InventorySourceGroupAssignedTargetingOptionDetails: type: object description: Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. properties: inventorySourceGroupId: type: string format: int64 description: Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. InventorySourceStatus: type: object description: The status related settings of the inventory source. properties: entityPauseReason: type: string description: The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`. sellerStatus: type: string description: 'Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`. Allowed values — `ENTITY_STATUS_UNSPECIFIED`: Default value when status is not specified or is unknown in this version.; `ENTITY_STATUS_ACTIVE`: The entity is enabled to bid and spend budget.; `ENTITY_STATUS_ARCHIVED`: The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.; `ENTITY_STATUS_DRAFT`: The entity is under draft. Bidding and budget spending are disabled.; `ENTITY_STATUS_PAUSED`: Bidding and budget spending are paused for the entity.; `ENTITY_STATUS_SCHEDULED_FOR_DELETION`: The entity is scheduled for deletion.' enum: - ENTITY_STATUS_UNSPECIFIED - ENTITY_STATUS_ACTIVE - ENTITY_STATUS_ARCHIVED - ENTITY_STATUS_DRAFT - ENTITY_STATUS_PAUSED - ENTITY_STATUS_SCHEDULED_FOR_DELETION readOnly: true sellerPauseReason: type: string description: Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`. readOnly: true entityStatus: type: string description: 'Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`. Allowed values — `ENTITY_STATUS_UNSPECIFIED`: Default value when status is not specified or is unknown in this version.; `ENTITY_STATUS_ACTIVE`: The entity is enabled to bid and spend budget.; `ENTITY_STATUS_ARCHIVED`: The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.; `ENTITY_STATUS_DRAFT`: The entity is under draft. Bidding and budget spending are disabled.; `ENTITY_STATUS_PAUSED`: Bidding and budget spending are paused for the entity.; `ENTITY_STATUS_SCHEDULED_FOR_DELETION`: The entity is scheduled for deletion.' enum: - ENTITY_STATUS_UNSPECIFIED - ENTITY_STATUS_ACTIVE - ENTITY_STATUS_ARCHIVED - ENTITY_STATUS_DRAFT - ENTITY_STATUS_PAUSED - ENTITY_STATUS_SCHEDULED_FOR_DELETION configStatus: type: string description: 'Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. Allowed values — `INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED`: The approval status is not specified or is unknown in this version.; `INVENTORY_SOURCE_CONFIG_STATUS_PENDING`: The beginning state of a guaranteed inventory source. The inventory source in this state needs to be configured.; `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`: The state after the buyer configures a guaranteed inventory source.' enum: - INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED - INVENTORY_SOURCE_CONFIG_STATUS_PENDING - INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED readOnly: true InventorySourceVideoCreativeConfig: type: object description: The configuration for video creatives. properties: duration: type: string format: google-duration description: The duration requirements for the video creatives that can be assigned to the inventory source. Invoice: type: object description: A single invoice. properties: dueDate: $ref: '#/components/schemas/Date' invoiceId: type: string description: The unique ID of the invoice. correctedInvoiceId: type: string description: The ID of the original invoice being adjusted by this invoice, if applicable. May appear on the invoice PDF as `Reference invoice number`. If replaced_invoice_ids is set, this field will be empty. totalTaxAmountMicros: type: string format: int64 description: The sum of all taxes in invoice, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar. purchaseOrderNumber: type: string description: Purchase order number associated with the invoice. invoiceType: type: string description: 'The type of invoice document. Allowed values — `INVOICE_TYPE_UNSPECIFIED`: Not specified or is unknown in this version.; `INVOICE_TYPE_CREDIT`: The invoice has a negative amount.; `INVOICE_TYPE_INVOICE`: The invoice has a positive amount.' enum: - INVOICE_TYPE_UNSPECIFIED - INVOICE_TYPE_CREDIT - INVOICE_TYPE_INVOICE issueDate: $ref: '#/components/schemas/Date' budgetSummaries: type: array description: The list of summarized information for each budget associated with this invoice. This field will only be set if the invoice detail level of the corresponding billing profile was set to "Budget level PO". items: $ref: '#/components/schemas/BudgetSummary' paymentsAccountId: type: string description: The ID of the payments account the invoice belongs to. Appears on the invoice PDF as `Billing Account Number`. subtotalAmountMicros: type: string format: int64 description: The pre-tax subtotal amount, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar. budgetInvoiceGroupingId: type: string description: The budget grouping ID for this invoice. This field will only be set if the invoice level of the corresponding billing profile was set to "Budget invoice grouping ID". nonBudgetMicros: type: string format: int64 description: The total amount of costs or adjustments not tied to a particular budget, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar. name: type: string description: The resource name of the invoice. displayName: type: string description: The display name of the invoice. currencyCode: type: string description: The currency used in the invoice in ISO 4217 format. pdfUrl: type: string description: 'The URL to download a PDF copy of the invoice. This URL is user specific and requires a valid OAuth 2.0 access token to access. The access token must be provided in an `Authorization: Bearer` HTTP header and be authorized for one of the following scopes: * `https://www.googleapis.com/auth/display-video-mediaplanning` * `https://www.googleapis.com/auth/display-video` The URL will be valid for 7 days after retrieval of this invoice object or until this invoice is retrieved again.' paymentsProfileId: type: string description: The ID of the payments profile the invoice belongs to. Appears on the invoice PDF as `Billing ID`. totalAmountMicros: type: string format: int64 description: The invoice total amount, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar. serviceDateRange: $ref: '#/components/schemas/DateRange' replacedInvoiceIds: type: array description: The ID(s) of any originally issued invoice that is being cancelled by this invoice, if applicable. Multiple invoices may be listed if those invoices are being consolidated into a single invoice. May appear on invoice PDF as `Replaced invoice numbers`. If corrected_invoice_id is set, this field will be empty. items: type: string KeywordAssignedTargetingOptionDetails: type: object description: Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. properties: exemptedPolicyNames: type: array description: Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. items: type: string keyword: type: string description: Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. negative: type: boolean description: Indicates if this option is being negatively targeted. Kpi: type: object description: Settings that control the key performance indicator, or KPI, of an insertion order. properties: kpiAlgorithmId: type: string format: int64 description: Optional. Custom Bidding Algorithm ID associated with KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. This field is ignored if the proper KPI is not selected. kpiString: type: string description: A KPI string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when kpi_type is `KPI_TYPE_OTHER`. kpiType: type: string description: 'Required. The type of KPI. Allowed values — `KPI_TYPE_UNSPECIFIED`: KPI type is not specified or is unknown in this version.; `KPI_TYPE_CPM`: The KPI is CPM (cost per mille).; `KPI_TYPE_CPC`: The KPI is CPC (cost per click).; `KPI_TYPE_CPA`: The KPI is CPA (cost per action).; `KPI_TYPE_CTR`: The KPI is CTR (click-through rate) percentage.; `KPI_TYPE_VIEWABILITY`: The KPI is Viewability percentage.; `KPI_TYPE_CPIAVC`: The KPI is CPIAVC (cost per impression audible and visible at completion).; `KPI_TYPE_CPE`: The KPI is CPE (cost per engagement).; `KPI_TYPE_CPV`: The KPI is set in CPV (cost per view).; `KPI_TYPE_CLICK_CVR`: The KPI is click conversion rate (conversions per click) percentage.; `KPI_TYPE_IMPRESSION_CVR`: The KPI is impression conversion rate (conversions per impression) percentage.; `KPI_TYPE_VCPM`: The KPI is VCPM (cost per thousand viewable impressions).; `KPI_TYPE_VTR`: The KPI is YouTube view rate (YouTube views per impression) percentage.; `KPI_TYPE_AUDIO_COMPLETION_RATE`: The KPI is audio completion rate (complete audio listens per impression) percentage.; `KPI_TYPE_VIDEO_COMPLETION_RATE`: The KPI is video completion rate (complete video views per impression) percentage.; `KPI_TYPE_CPCL`: The KPI is set in CPCL (cost per complete audio listen).; `KPI_TYPE_CPCV`: The KPI is set in CPCV (cost per complete video view).; `KPI_TYPE_TOS10`: The KPI is set in rate of time on screen 10+ seconds (Percentage of measurable, non-skippable impressions that were on the screen for at least 10 seconds).; `KPI_TYPE_MAXIMIZE_PACING`: The KPI is set to maximize brand impact while prioritizing spending the full budget.; `KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST`: The KPI is set in custom impression value divided by cost.; `KPI_TYPE_OTHER`: The KPI is some other value.' enum: - KPI_TYPE_UNSPECIFIED - KPI_TYPE_CPM - KPI_TYPE_CPC - KPI_TYPE_CPA - KPI_TYPE_CTR - KPI_TYPE_VIEWABILITY - KPI_TYPE_CPIAVC - KPI_TYPE_CPE - KPI_TYPE_CPV - KPI_TYPE_CLICK_CVR - KPI_TYPE_IMPRESSION_CVR - KPI_TYPE_VCPM - KPI_TYPE_VTR - KPI_TYPE_AUDIO_COMPLETION_RATE - KPI_TYPE_VIDEO_COMPLETION_RATE - KPI_TYPE_CPCL - KPI_TYPE_CPCV - KPI_TYPE_TOS10 - KPI_TYPE_MAXIMIZE_PACING - KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST - KPI_TYPE_OTHER kpiPercentageMicros: type: string format: int64 description: 'The decimal representation of the goal percentage in micros. Applicable when kpi_type is one of: * `KPI_TYPE_CTR` * `KPI_TYPE_VIEWABILITY` * `KPI_TYPE_CLICK_CVR` * `KPI_TYPE_IMPRESSION_CVR` * `KPI_TYPE_VTR` * `KPI_TYPE_AUDIO_COMPLETION_RATE` * `KPI_TYPE_VIDEO_COMPLETION_RATE` For example: 70000 represents 7% (decimal 0.07).' kpiAmountMicros: type: string format: int64 description: 'The goal amount, in micros of the advertiser''s currency. Applicable when kpi_type is one of: * `KPI_TYPE_CPM` * `KPI_TYPE_CPC` * `KPI_TYPE_CPA` * `KPI_TYPE_CPIAVC` * `KPI_TYPE_VCPM` For example: 1500000 represents 1.5 standard units of the currency.' LanguageAssignedTargetingOptionDetails: type: object description: Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. properties: negative: type: boolean description: Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field. displayName: type: string description: Output only. The display name of the language (e.g., "French"). readOnly: true targetingOptionId: type: string description: Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`. LanguageTargetingOptionDetails: type: object description: Represents a targetable language. This will be populated in the language_details field when targeting_type is `TARGETING_TYPE_LANGUAGE`. properties: displayName: type: string description: Output only. The display name of the language (e.g., "French"). readOnly: true LineItem: type: object description: A single line item. properties: pacing: $ref: '#/components/schemas/Pacing' excludeNewExchanges: type: boolean description: Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. entityStatus: type: string description: 'Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item''s parent insertion order is not active, the line item can''t spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. Allowed values — `ENTITY_STATUS_UNSPECIFIED`: Default value when status is not specified or is unknown in this version.; `ENTITY_STATUS_ACTIVE`: The entity is enabled to bid and spend budget.; `ENTITY_STATUS_ARCHIVED`: The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.; `ENTITY_STATUS_DRAFT`: The entity is under draft. Bidding and budget spending are disabled.; `ENTITY_STATUS_PAUSED`: Bidding and budget spending are paused for the entity.; `ENTITY_STATUS_SCHEDULED_FOR_DELETION`: The entity is scheduled for deletion.' enum: - ENTITY_STATUS_UNSPECIFIED - ENTITY_STATUS_ACTIVE - ENTITY_STATUS_ARCHIVED - ENTITY_STATUS_DRAFT - ENTITY_STATUS_PAUSED - ENTITY_STATUS_SCHEDULED_FOR_DELETION targetingExpansion: $ref: '#/components/schemas/TargetingExpansionConfig' bidStrategy: $ref: '#/components/schemas/BiddingStrategy' containsEuPoliticalAds: type: string description: 'Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**. Allowed values — `EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN`: Unknown.; `CONTAINS_EU_POLITICAL_ADVERTISING`: Contains EU political advertising.; `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING`: Does not contain EU political advertising.' enum: - EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN - CONTAINS_EU_POLITICAL_ADVERTISING - DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING integrationDetails: $ref: '#/components/schemas/IntegrationDetails' campaignId: type: string format: int64 description: Output only. The unique ID of the campaign that the line item belongs to. readOnly: true creativeIds: type: array description: The IDs of the creatives associated with the line item. items: type: string format: int64 flight: $ref: '#/components/schemas/LineItemFlight' warningMessages: type: array description: Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. readOnly: true items: type: string enum: - LINE_ITEM_WARNING_MESSAGE_UNSPECIFIED - INVALID_FLIGHT_DATES - EXPIRED - PENDING_FLIGHT - ALL_PARTNER_ENABLED_EXCHANGES_NEGATIVELY_TARGETED - INVALID_INVENTORY_SOURCE - APP_INVENTORY_INVALID_SITE_TARGETING - APP_INVENTORY_INVALID_AUDIENCE_LISTS - NO_VALID_CREATIVE - PARENT_INSERTION_ORDER_PAUSED - PARENT_INSERTION_ORDER_EXPIRED description: 'Allowed values — `LINE_ITEM_WARNING_MESSAGE_UNSPECIFIED`: Not specified or is unknown.; `INVALID_FLIGHT_DATES`: This line item has invalid flight dates. The line item will not run.; `EXPIRED`: This line item''s end date is in the past.; `PENDING_FLIGHT`: This line item will begin running in the future.; `ALL_PARTNER_ENABLED_EXCHANGES_NEGATIVELY_TARGETED`: All partner enabled exchanges are negatively targeted. The line item will not run.; `INVALID_INVENTORY_SOURCE`: No active inventory sources are being targeted. The line item will not run.; `APP_INVENTORY_INVALID_SITE_TARGETING`: This line item''s Apps & URLs targeting doesn''t include any mobile apps. This line item''s type requires you to include mobile apps in your channel, sitelist, or apps targeting. The line item will not run.; `APP_INVENTORY_INVALID_AUDIENCE_LISTS`: This line item isn''t targeting any mobile users. This line item''s type requires you to target a user list with mobile users. The line item will not run.; `NO_VALID_CREATIVE`: This line item does not contain any valid creative. The line item will not run.; `PARENT_INSERTION_ORDER_PAUSED`: The insertion order of this line item is paused. The line item will not run.; `PARENT_INSERTION_ORDER_EXPIRED`: The insertion order of this line item has its end date set in the past. The line item will not run.' lineItemType: type: string description: 'Required. Immutable. The type of the line item. Allowed values — `LINE_ITEM_TYPE_UNSPECIFIED`: Type value is not specified or is unknown in this version. Line items of this type and their targeting cannot be created or updated using the API.; `LINE_ITEM_TYPE_DISPLAY_DEFAULT`: Image, HTML5, native, or rich media ads.; `LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL`: Display ads that drive installs of an app.; `LINE_ITEM_TYPE_VIDEO_DEFAULT`: Video ads sold on a CPM basis for a variety of environments.; `LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL`: Video ads that drive installs of an app.; `LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY`: Display ads served on mobile app inventory. Line items of this type and their targeting cannot be created or updated using the API.; `LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INVENTORY`: Video ads served on mobile app inventory. Line items of this type and their targeting cannot be created or updated using the API.; `LINE_ITEM_TYPE_AUDIO_DEFAULT`: RTB Audio ads sold for a variety of environments.; `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP`: Over-the-top ads present in OTT insertion orders. This type is only applicable to line items with an insertion order of insertion_order_type `OVER_THE_TOP`.; `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTION`: YouTube video ads that promote conversions. Line items of this type and their targeting cannot be created or updated using the API.; `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE`: YouTube video ads (up to 15 seconds) that cannot be skipped. Line items of this type and their targeting cannot be created or updated using the API.; `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE`: YouTube video ads that show a story in a particular sequence using a mix of formats. Line items of this type and their targeting cannot be created or updated using the API.; `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIO`: YouTube audio ads. Line items of this type and their targeting cannot be created or updated using the API.; `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH`: YouTube video ads that optimize reaching more unique users at lower cost. May include bumper ads, skippable in-stream ads, or a mix of types. Line items of this type and their targeting cannot be created or updated using the API.; `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE`: Default YouTube video ads. Line items of this type and their targeting cannot be created or updated using the API.; `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP`: Connected TV youTube video ads (up to 15 seconds) that cannot be skipped. Line items of this type and their targeting cannot be created or updated using the API.; `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP`: Connected TV youTube video ads that optimize reaching more unique users at lower cost. May include bumper ads, skippable in-stream ads, or a mix of types. Line items of this type and their targeting cannot be created or updated using the API.; `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP`: Connected TV default YouTube video ads. Only include in-stream ad-format. Line items of this type and their targeting cannot be created or updated using the API.; `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_TARGET_FREQUENCY`: The goal of this line item type is to show the YouTube ads target number of times to the same person in a certain period of time. Line items of this type and their targeting cannot be created or updated using the API.; `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIEW`: YouTube video ads that aim to get more views with a variety of ad formats. Line items of this type and their targeting cannot be created or updated using the API.; `LINE_ITEM_TYPE_DISPLAY_OUT_OF_HOME`: Display ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.; `LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME`: Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.; `LINE_ITEM_TYPE_DEMAND_GEN`: Demand Gen ads.' 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 - LINE_ITEM_TYPE_AUDIO_DEFAULT - LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP - LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTION - LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE - LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE - LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIO - LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH - LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE - LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP - LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP - LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP - LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_TARGET_FREQUENCY - LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIEW - LINE_ITEM_TYPE_DISPLAY_OUT_OF_HOME - LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME - LINE_ITEM_TYPE_DEMAND_GEN partnerCosts: type: array description: The partner costs associated with the line item. If absent or empty in CreateLineItem method, the newly created line item will inherit partner costs from its parent insertion order. items: $ref: '#/components/schemas/PartnerCost' budget: $ref: '#/components/schemas/LineItemBudget' reservationType: type: string description: 'Output only. The reservation type of the line item. Allowed values — `RESERVATION_TYPE_UNSPECIFIED`: Reservation type value is not specified or is unknown in this version.; `RESERVATION_TYPE_NOT_GUARANTEED`: Not created through a guaranteed inventory source.; `RESERVATION_TYPE_PROGRAMMATIC_GUARANTEED`: Created through a programmatic guaranteed inventory source.; `RESERVATION_TYPE_TAG_GUARANTEED`: Created through a tag guaranteed inventory source.; `RESERVATION_TYPE_PETRA_VIRAL`: Created through a Petra inventory source. Only applicable to YouTube and Partners line items.; `RESERVATION_TYPE_INSTANT_RESERVE`: Created with an instant quote. Only applicable to YouTube and partners line items.' enum: - RESERVATION_TYPE_UNSPECIFIED - RESERVATION_TYPE_NOT_GUARANTEED - RESERVATION_TYPE_PROGRAMMATIC_GUARANTEED - RESERVATION_TYPE_TAG_GUARANTEED - RESERVATION_TYPE_PETRA_VIRAL - RESERVATION_TYPE_INSTANT_RESERVE readOnly: true name: type: string description: Output only. The resource name of the line item. readOnly: true lineItemId: type: string format: int64 description: Output only. The unique ID of the line item. Assigned by the system. readOnly: true displayName: type: string description: Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. youtubeAndPartnersSettings: $ref: '#/components/schemas/YoutubeAndPartnersSettings' updateTime: type: string format: google-datetime description: Output only. The timestamp when the line item was last updated. Assigned by the system. readOnly: true conversionCounting: $ref: '#/components/schemas/ConversionCountingConfig' partnerRevenueModel: $ref: '#/components/schemas/PartnerRevenueModel' demandGenSettings: $ref: '#/components/schemas/DemandGenSettings' optimizeFixedBidding: type: boolean description: Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`. advertiserId: type: string format: int64 description: Output only. The unique ID of the advertiser the line item belongs to. readOnly: true insertionOrderId: type: string format: int64 description: Required. Immutable. The unique ID of the insertion order that the line item belongs to. frequencyCap: $ref: '#/components/schemas/FrequencyCap' mobileApp: $ref: '#/components/schemas/MobileApp' LineItemAssignedTargetingOption: type: object description: Wrapper object associating an assigned_targeting_option resource and the line item it is assigned to. properties: lineItemId: type: string format: int64 description: The ID of the line item the assigned targeting option is assigned to. assignedTargetingOption: $ref: '#/components/schemas/AssignedTargetingOption' LineItemBudget: type: object description: Settings that control how budget is allocated. properties: maxAmount: type: string format: int64 description: 'The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser''s currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.' budgetAllocationType: type: string description: 'Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items. Allowed values — `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED`: Type value is not specified or is unknown in this version.; `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`: Automatic budget allocation is enabled for the line item.; `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`: A fixed max budget amount is allocated for the line item.; `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`: No budget limit is applied to the line item.' 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 budgetUnit: type: string description: 'Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. Allowed values — `BUDGET_UNIT_UNSPECIFIED`: Type value is not specified or is unknown in this version.; `BUDGET_UNIT_CURRENCY`: Budgeting in currency amounts.; `BUDGET_UNIT_IMPRESSIONS`: Budgeting in impression amounts.' enum: - BUDGET_UNIT_UNSPECIFIED - BUDGET_UNIT_CURRENCY - BUDGET_UNIT_IMPRESSIONS readOnly: true LineItemFlight: type: object description: Settings that control the active duration of a line item. properties: flightDateType: type: string description: 'Required. The type of the line item''s flight dates. Allowed values — `LINE_ITEM_FLIGHT_DATE_TYPE_UNSPECIFIED`: Type value is not specified or is unknown in this version.; `LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED`: The line item''s flight dates are inherited from its parent insertion order.; `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`: The line item uses its own custom flight dates.' enum: - LINE_ITEM_FLIGHT_DATE_TYPE_UNSPECIFIED - LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED - LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM dateRange: $ref: '#/components/schemas/DateRange' ListAdAssetsResponse: type: object description: A response message for ListAdAssets. properties: nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdAssets` method to retrieve the next page of results. adAssets: type: array description: The list of ad assets. The list will only contain assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`. This list will be absent if empty. items: $ref: '#/components/schemas/AdAsset' ListAdGroupAdsResponse: type: object properties: nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdGroupAds` method to retrieve the next page of results. adGroupAds: type: array description: The list of ads. This list will be absent if empty. items: $ref: '#/components/schemas/AdGroupAd' ListAdGroupAssignedTargetingOptionsResponse: type: object description: Response message for ListAdGroupAssignedTargetingOptions. properties: assignedTargetingOptions: type: array description: The list of assigned targeting options. This list will be absent if empty. items: $ref: '#/components/schemas/AssignedTargetingOption' nextPageToken: type: string description: A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListAdGroupAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more AssignedTargetingOption resources to return. ListAdGroupsResponse: type: object properties: adGroups: type: array description: The list of ad groups. This list will be absent if empty. items: $ref: '#/components/schemas/AdGroup' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdGroups` method to retrieve the next page of results. ListAdvertiserAssignedTargetingOptionsResponse: type: object description: Response message for ListAdvertiserAssignedTargetingOptions. properties: assignedTargetingOptions: type: array description: The list of assigned targeting options. This list will be absent if empty. items: $ref: '#/components/schemas/AssignedTargetingOption' nextPageToken: type: string description: A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListAdvertiserAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return. ListAdvertisersResponse: type: object properties: advertisers: type: array description: The list of advertisers. This list will be absent if empty. items: $ref: '#/components/schemas/Advertiser' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdvertisers` method to retrieve the next page of results. ListAssignedInventorySourcesResponse: type: object description: Response message for AssignedInventorySourceService.ListAssignedInventorySources. properties: assignedInventorySources: type: array description: The list of assigned inventory sources. This list will be absent if empty. items: $ref: '#/components/schemas/AssignedInventorySource' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAssignedInventorySources` method to retrieve the next page of results. ListAssignedLocationsResponse: type: object description: Response message for AssignedLocationService.ListAssignedLocations. properties: assignedLocations: type: array description: The list of assigned locations. This list will be absent if empty. items: $ref: '#/components/schemas/AssignedLocation' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAssignedLocations` method to retrieve the next page of results. ListCampaignsResponse: type: object properties: campaigns: type: array description: The list of campaigns. This list will be absent if empty. items: $ref: '#/components/schemas/Campaign' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCampaigns` method to retrieve the next page of results. ListChannelsResponse: type: object properties: channels: type: array description: The list of channels. This list will be absent if empty. items: $ref: '#/components/schemas/Channel' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListChannels` method to retrieve the next page of results. ListCombinedAudiencesResponse: type: object properties: combinedAudiences: type: array description: The list of combined audiences. This list will be absent if empty. items: $ref: '#/components/schemas/CombinedAudience' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCombinedAudiences` method to retrieve the next page of results. ListCreativesResponse: type: object properties: creatives: type: array description: The list of creatives. This list will be absent if empty. items: $ref: '#/components/schemas/Creative' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCreativesRequest` method to retrieve the next page of results. If this field is null, it means this is the last page. ListCustomBiddingAlgorithmRulesResponse: type: object properties: customBiddingRules: type: array description: The list of CustomBiddingAlgorithmRules resources. This list will be absent if empty. items: $ref: '#/components/schemas/CustomBiddingAlgorithmRules' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomBiddingAlgorithmRulesRequest` method to retrieve the next page of results. If this field is null, it means this is the last page. ListCustomBiddingAlgorithmsResponse: type: object properties: customBiddingAlgorithms: type: array description: The list of custom bidding algorithms. This list will be absent if empty. items: $ref: '#/components/schemas/CustomBiddingAlgorithm' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomBiddingAlgorithmsRequest` method to retrieve the next page of results. If this field is null, it means this is the last page. ListCustomBiddingScriptsResponse: type: object properties: customBiddingScripts: type: array description: The list of custom bidding scripts. This list will be absent if empty. items: $ref: '#/components/schemas/CustomBiddingScript' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomBiddingScriptsRequest` method to retrieve the next page of results. If this field is null, it means this is the last page. ListCustomListsResponse: type: object properties: customLists: type: array description: The list of custom lists. This list will be absent if empty. items: $ref: '#/components/schemas/CustomList' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomLists` method to retrieve the next page of results. ListFirstPartyAndPartnerAudiencesResponse: type: object properties: firstPartyAndPartnerAudiences: type: array description: The list of first party and partner audiences. Audience size properties will not be included. This list will be absent if empty. items: $ref: '#/components/schemas/FirstPartyAndPartnerAudience' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListFirstPartyAndPartnerAudiences` method to retrieve the next page of results. ListFloodlightActivitiesResponse: type: object properties: floodlightActivities: type: array description: The list of Floodlight activities. This list will be absent if empty. items: $ref: '#/components/schemas/FloodlightActivity' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListFloodlightActivities` method to retrieve the next page of results. ListGoogleAudiencesResponse: type: object properties: googleAudiences: type: array description: The list of Google audiences. This list will be absent if empty. items: $ref: '#/components/schemas/GoogleAudience' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListGoogleAudiences` method to retrieve the next page of results. ListGuaranteedOrdersResponse: type: object properties: nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListGuaranteedOrders` method to retrieve the next page of results. guaranteedOrders: type: array description: The list of guaranteed orders. This list will be absent if empty. items: $ref: '#/components/schemas/GuaranteedOrder' ListInsertionOrdersResponse: type: object properties: nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInsertionOrders` method to retrieve the next page of results. insertionOrders: type: array description: The list of insertion orders. This list will be absent if empty. items: $ref: '#/components/schemas/InsertionOrder' ListInventorySourceGroupsResponse: type: object description: Response message for InventorySourceGroupService.ListInventorySourceGroups. properties: inventorySourceGroups: type: array description: The list of inventory source groups. This list will be absent if empty. items: $ref: '#/components/schemas/InventorySourceGroup' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInventorySourceGroups` method to retrieve the next page of results. ListInventorySourcesResponse: type: object properties: nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInventorySources` method to retrieve the next page of results. inventorySources: type: array description: The list of inventory sources. This list will be absent if empty. items: $ref: '#/components/schemas/InventorySource' ListInvoicesResponse: type: object properties: invoices: type: array description: The list of invoices. This list will be absent if empty. items: $ref: '#/components/schemas/Invoice' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInvoices` method to retrieve the next page of results. This token will be absent if there are no more invoices to return. ListLineItemAssignedTargetingOptionsResponse: type: object description: Response message for ListLineItemAssignedTargetingOptions. properties: assignedTargetingOptions: type: array description: The list of assigned targeting options. This list will be absent if empty. items: $ref: '#/components/schemas/AssignedTargetingOption' nextPageToken: type: string description: A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListLineItemAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return. ListLineItemsResponse: type: object properties: lineItems: type: array description: The list of line items. This list will be absent if empty. items: $ref: '#/components/schemas/LineItem' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListLineItems` method to retrieve the next page of results. ListLocationListsResponse: type: object properties: locationLists: type: array description: The list of location lists. This list will be absent if empty. items: $ref: '#/components/schemas/LocationList' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListLocationLists` method to retrieve the next page of results. ListNegativeKeywordListsResponse: type: object description: Response message for NegativeKeywordListService.ListNegativeKeywordLists. properties: negativeKeywordLists: type: array description: The list of negative keyword lists. This list will be absent if empty. items: $ref: '#/components/schemas/NegativeKeywordList' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListNegativeKeywordLists` method to retrieve the next page of results. ListNegativeKeywordsResponse: type: object description: Response message for NegativeKeywordService.ListNegativeKeywords. properties: negativeKeywords: type: array description: The list of negative keywords. This list will be absent if empty. items: $ref: '#/components/schemas/NegativeKeyword' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListNegativeKeywords` method to retrieve the next page of results. ListPartnerAssignedTargetingOptionsResponse: type: object properties: assignedTargetingOptions: type: array description: The list of assigned targeting options. This list will be absent if empty. items: $ref: '#/components/schemas/AssignedTargetingOption' nextPageToken: type: string description: A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListPartnerAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return. ListPartnersResponse: type: object properties: partners: type: array description: The list of partners. This list will be absent if empty. items: $ref: '#/components/schemas/Partner' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListPartners` method to retrieve the next page of results. ListSitesResponse: type: object description: Response message for SiteService.ListSites. properties: sites: type: array description: The list of sites. This list will be absent if empty. items: $ref: '#/components/schemas/Site' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListSites` method to retrieve the next page of results. ListTargetingOptionsResponse: type: object description: Response message for ListTargetingOptions. properties: targetingOptions: type: array description: The list of targeting options. This list will be absent if empty. items: $ref: '#/components/schemas/TargetingOption' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListTargetingOptions` method to retrieve the next page of results. ListUsersResponse: type: object properties: users: type: array description: The list of users. This list will be absent if empty. items: $ref: '#/components/schemas/User' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListUsers` method to retrieve the next page of results. This token will be absent if there are no more results to return. ListYoutubeAssetAssociationsResponse: type: object description: Response message for YoutubeAssetAssociationService.ListYoutubeAssetAssociations. properties: youtubeAssetAssociations: type: array description: The list of asset associations. This list will be absent if empty. items: $ref: '#/components/schemas/YoutubeAssetAssociation' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListYoutubeAssetAssociations` method to retrieve the next page of results. LocationList: type: object description: A list of locations used for targeting. properties: displayName: type: string description: Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes. name: type: string description: Output only. The resource name of the location list. readOnly: true locationType: type: string description: 'Required. Immutable. The type of location. All locations in the list will share this type. Allowed values — `TARGETING_LOCATION_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown.; `TARGETING_LOCATION_TYPE_PROXIMITY`: The type for proximity geo location.; `TARGETING_LOCATION_TYPE_REGIONAL`: The type for regional geo location.' enum: - TARGETING_LOCATION_TYPE_UNSPECIFIED - TARGETING_LOCATION_TYPE_PROXIMITY - TARGETING_LOCATION_TYPE_REGIONAL locationListId: type: string format: int64 description: Output only. The unique ID of the location list. Assigned by the system. readOnly: true advertiserId: type: string format: int64 description: Required. Immutable. The unique ID of the advertiser the location list belongs to. LookbackWindow: type: object description: Specifies how many days into the past to look when determining whether to record a conversion. properties: clickDays: type: integer format: int32 description: Lookback window, in days, from the last time a given user clicked on one of your ads. impressionDays: type: integer format: int32 description: Lookback window, in days, from the last time a given user viewed one of your ads. LookupInvoiceCurrencyResponse: type: object properties: currencyCode: type: string description: Currency used by the advertiser in ISO 4217 format. MastheadAd: type: object description: Details for a Masthead Ad. properties: videoAspectRatio: type: string description: 'The aspect ratio of the autoplaying YouTube video on the Masthead. Allowed values — `VIDEO_ASPECT_RATIO_UNSPECIFIED`: Not specified or unknown.; `VIDEO_ASPECT_RATIO_WIDESCREEN`: The video is stretched and the top and bottom are cropped.; `VIDEO_ASPECT_RATIO_FIXED_16_9`: The video uses a fixed 16:9 aspect ratio.' enum: - VIDEO_ASPECT_RATIO_UNSPECIFIED - VIDEO_ASPECT_RATIO_WIDESCREEN - VIDEO_ASPECT_RATIO_FIXED_16_9 callToActionButtonLabel: type: string description: The text on the call-to-action button. callToActionFinalUrl: type: string description: The destination URL for the call-to-action button. companionYoutubeVideos: type: array description: The videos that appear next to the Masthead Ad on desktop. Can be no more than two. items: $ref: '#/components/schemas/YoutubeVideoDetails' video: $ref: '#/components/schemas/YoutubeVideoDetails' autoplayVideoStartMillisecond: type: string format: int64 description: The amount of time in milliseconds after which the video will start to play. description: type: string description: The description of the ad. callToActionTrackingUrl: type: string description: The tracking URL for the call-to-action button. autoplayVideoDuration: type: string format: google-duration description: The duration of time the video will autoplay. showChannelArt: type: boolean description: Whether to show a background or banner that appears at the top of a YouTube page. headline: type: string description: The headline of the ad. MaximizeSpendBidStrategy: type: object description: A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. properties: raiseBidForDeals: type: boolean description: Whether the strategy takes deal floor prices into account. customBiddingAlgorithmId: type: string format: int64 description: The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. maxAverageCpmBidAmountMicros: type: string format: int64 description: The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. performanceGoalType: type: string description: 'Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. Allowed values — `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_UNSPECIFIED`: Type value is not specified or is unknown in this version.; `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`: Cost per action.; `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`: Cost per click.; `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`: Viewable CPM.; `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`: Custom bidding algorithm.; `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA`: Completed inview and audible views.; `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN`: Inview time over 10 secs views.; `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED`: Viewable impressions.; `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH`: Maximize reach.' 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_CUSTOM_ALGO - BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA - BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN - BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED - BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH MeasurementConfig: type: object description: Measurement settings of a partner. properties: dv360ToCmCostReportingEnabled: type: boolean description: Whether or not to report DV360 cost to CM360. dv360ToCmDataSharingEnabled: type: boolean description: Whether or not to include DV360 data in CM360 data transfer reports. MobileApp: type: object description: A mobile app promoted by a mobile app install line item. properties: platform: type: string description: 'Output only. The app platform. Allowed values — `PLATFORM_UNSPECIFIED`: Platform is not specified.; `IOS`: iOS platform.; `ANDROID`: Android platform.' enum: - PLATFORM_UNSPECIFIED - IOS - ANDROID readOnly: true publisher: type: string description: Output only. The app publisher. readOnly: true displayName: type: string description: Output only. The app name. readOnly: true appId: type: string description: Required. The ID of the app provided by the platform store. Android apps are identified by the bundle ID used by Android's Play store, such as `com.google.android.gm`. iOS apps are identified by a nine-digit app ID used by Apple's App store, such as `422689480`. MobileDeviceIdList: type: object description: Wrapper message for a list of mobile device IDs defining Customer Match audience members. properties: mobileDeviceIds: type: array description: Optional. A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000. items: type: string consent: $ref: '#/components/schemas/Consent' Money: type: object description: Represents an amount of money with its currency type. properties: currencyCode: type: string description: The three-letter currency code defined in ISO 4217. units: type: string format: int64 description: The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. nanos: type: integer format: int32 description: Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. NativeContentPositionAssignedTargetingOptionDetails: type: object description: Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. properties: contentPosition: type: string description: 'Required. The content position. Allowed values — `NATIVE_CONTENT_POSITION_UNSPECIFIED`: Native content position is not specified in this version. This enum is a place holder for a default value and does not represent a real native content position.; `NATIVE_CONTENT_POSITION_UNKNOWN`: The native content position is unknown.; `NATIVE_CONTENT_POSITION_IN_ARTICLE`: Native content position is in-article, i.e., ads appear between the paragraphs of pages.; `NATIVE_CONTENT_POSITION_IN_FEED`: Native content position is in-feed, i.e., ads appear in a scrollable stream of content. A feed is typically editorial (e.g. a list of articles or news) or listings (e.g. a list of products or services).; `NATIVE_CONTENT_POSITION_PERIPHERAL`: Native content position is peripheral, i.e., ads appear outside of core content on pages, such as the right- or left-hand side of the page.; `NATIVE_CONTENT_POSITION_RECOMMENDATION`: Native content position is recommendation, i.e., ads appear in sections for recommended content.' enum: - NATIVE_CONTENT_POSITION_UNSPECIFIED - NATIVE_CONTENT_POSITION_UNKNOWN - NATIVE_CONTENT_POSITION_IN_ARTICLE - NATIVE_CONTENT_POSITION_IN_FEED - NATIVE_CONTENT_POSITION_PERIPHERAL - NATIVE_CONTENT_POSITION_RECOMMENDATION NativeContentPositionTargetingOptionDetails: type: object description: Represents a targetable native content position. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. properties: contentPosition: type: string description: 'Output only. The content position. Allowed values — `NATIVE_CONTENT_POSITION_UNSPECIFIED`: Native content position is not specified in this version. This enum is a place holder for a default value and does not represent a real native content position.; `NATIVE_CONTENT_POSITION_UNKNOWN`: The native content position is unknown.; `NATIVE_CONTENT_POSITION_IN_ARTICLE`: Native content position is in-article, i.e., ads appear between the paragraphs of pages.; `NATIVE_CONTENT_POSITION_IN_FEED`: Native content position is in-feed, i.e., ads appear in a scrollable stream of content. A feed is typically editorial (e.g. a list of articles or news) or listings (e.g. a list of products or services).; `NATIVE_CONTENT_POSITION_PERIPHERAL`: Native content position is peripheral, i.e., ads appear outside of core content on pages, such as the right- or left-hand side of the page.; `NATIVE_CONTENT_POSITION_RECOMMENDATION`: Native content position is recommendation, i.e., ads appear in sections for recommended content.' enum: - NATIVE_CONTENT_POSITION_UNSPECIFIED - NATIVE_CONTENT_POSITION_UNKNOWN - NATIVE_CONTENT_POSITION_IN_ARTICLE - NATIVE_CONTENT_POSITION_IN_FEED - NATIVE_CONTENT_POSITION_PERIPHERAL - NATIVE_CONTENT_POSITION_RECOMMENDATION readOnly: true NegativeKeyword: type: object description: A negatively targeted keyword that belongs to a negative keyword list. properties: keywordValue: type: string description: Required. Immutable. The negatively targeted keyword, for example `car insurance`. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. Valid characters are restricted to ASCII characters only. The only URL-escaping permitted is for representing whitespace between words. Leading or trailing whitespace is ignored. name: type: string description: Output only. The resource name of the negative keyword. readOnly: true NegativeKeywordList: type: object description: A list of negative keywords used for targeting. properties: name: type: string description: Output only. The resource name of the negative keyword list. readOnly: true displayName: type: string description: Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes. negativeKeywordListId: type: string format: int64 description: Output only. The unique ID of the negative keyword list. Assigned by the system. readOnly: true advertiserId: type: string format: int64 description: Output only. The unique ID of the advertiser the negative keyword list belongs to. readOnly: true targetedLineItemCount: type: string format: int64 description: Output only. Number of line items that are directly targeting this negative keyword list. readOnly: true NegativeKeywordListAssignedTargetingOptionDetails: type: object description: Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. properties: negativeKeywordListId: type: string format: int64 description: Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource. NonSkippableAd: type: object description: Details for a non-skippable ad. properties: commonInStreamAttribute: $ref: '#/components/schemas/CommonInStreamAttribute' customParameters: type: object description: The custom parameters and accompanying values to add to the tracking URL. additionalProperties: type: string ObaIcon: type: object description: OBA Icon for a Creative properties: resourceMimeType: type: string description: Optional. The MIME type of the OBA icon resource. position: type: string description: 'Optional. The position of the OBA icon on the creative. Allowed values — `OBA_ICON_POSITION_UNSPECIFIED`: The OBA icon position is not specified.; `OBA_ICON_POSITION_UPPER_RIGHT`: At the upper right side of the creative.; `OBA_ICON_POSITION_UPPER_LEFT`: At the upper left side of the creative.; `OBA_ICON_POSITION_LOWER_RIGHT`: At the lower right side of the creative.; `OBA_ICON_POSITION_LOWER_LEFT`: At the lower left side of 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 landingPageUrl: type: string description: 'Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`' dimensions: $ref: '#/components/schemas/Dimensions' clickTrackingUrl: type: string description: 'Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`' resourceUrl: type: string description: Optional. The URL of the OBA icon resource. viewTrackingUrl: type: string description: 'Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`' program: type: string description: 'Optional. The program of the OBA icon. For example: “AdChoices”.' OmidAssignedTargetingOptionDetails: type: object description: Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. properties: omid: type: string description: 'Required. The type of Open Measurement enabled inventory. Allowed values — `OMID_UNSPECIFIED`: Default value when omid targeting is not specified in this version.; `OMID_FOR_MOBILE_DISPLAY_ADS`: Open Measurement enabled mobile display inventory.' enum: - OMID_UNSPECIFIED - OMID_FOR_MOBILE_DISPLAY_ADS OmidTargetingOptionDetails: type: object description: Represents a targetable Open Measurement enabled inventory type. This will be populated in the omid_details field when targeting_type is `TARGETING_TYPE_OMID`. properties: omid: type: string description: 'Output only. The type of Open Measurement enabled inventory. Allowed values — `OMID_UNSPECIFIED`: Default value when omid targeting is not specified in this version.; `OMID_FOR_MOBILE_DISPLAY_ADS`: Open Measurement enabled mobile display inventory.' enum: - OMID_UNSPECIFIED - OMID_FOR_MOBILE_DISPLAY_ADS readOnly: true OnScreenPositionAssignedTargetingOptionDetails: type: object description: On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. properties: targetingOptionId: type: string description: Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. adType: type: string description: 'Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. Allowed values — `AD_TYPE_UNSPECIFIED`: Ad type is not specified or is unknown in this version.; `AD_TYPE_DISPLAY`: Display creatives, e.g. image and HTML5.; `AD_TYPE_VIDEO`: Video creatives, e.g. video ads that play during streaming content in video players.; `AD_TYPE_AUDIO`: Audio creatives, e.g. audio ads that play during audio content.' enum: - AD_TYPE_UNSPECIFIED - AD_TYPE_DISPLAY - AD_TYPE_VIDEO - AD_TYPE_AUDIO readOnly: true onScreenPosition: type: string description: 'Output only. The on screen position. Allowed values — `ON_SCREEN_POSITION_UNSPECIFIED`: On screen position is not specified in this version. This enum is a place holder for a default value and does not represent a real on screen position.; `ON_SCREEN_POSITION_UNKNOWN`: The ad position is unknown on the screen.; `ON_SCREEN_POSITION_ABOVE_THE_FOLD`: The ad is located above the fold.; `ON_SCREEN_POSITION_BELOW_THE_FOLD`: The ad is located below the fold.' enum: - ON_SCREEN_POSITION_UNSPECIFIED - ON_SCREEN_POSITION_UNKNOWN - ON_SCREEN_POSITION_ABOVE_THE_FOLD - ON_SCREEN_POSITION_BELOW_THE_FOLD readOnly: true OnScreenPositionTargetingOptionDetails: type: object description: Represents a targetable on screen position, which could be used by display and video ads. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. properties: onScreenPosition: type: string description: 'Output only. The on screen position. Allowed values — `ON_SCREEN_POSITION_UNSPECIFIED`: On screen position is not specified in this version. This enum is a place holder for a default value and does not represent a real on screen position.; `ON_SCREEN_POSITION_UNKNOWN`: The ad position is unknown on the screen.; `ON_SCREEN_POSITION_ABOVE_THE_FOLD`: The ad is located above the fold.; `ON_SCREEN_POSITION_BELOW_THE_FOLD`: The ad is located below the fold.' enum: - ON_SCREEN_POSITION_UNSPECIFIED - ON_SCREEN_POSITION_UNKNOWN - ON_SCREEN_POSITION_ABOVE_THE_FOLD - ON_SCREEN_POSITION_BELOW_THE_FOLD readOnly: true OnTargetAudienceMetrics: type: object description: Estimated audience sizes for a targeted geography. properties: youtubeAudienceSize: type: string format: int64 description: Estimated size of the YouTube audience. censusAudienceSize: type: string format: int64 description: Size of the audience based on the census data of the targeted geography. OperatingSystemAssignedTargetingOptionDetails: type: object description: Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. properties: displayName: type: string description: Output only. The display name of the operating system. readOnly: true targetingOptionId: type: string description: Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. negative: type: boolean description: Indicates if this option is being negatively targeted. OperatingSystemTargetingOptionDetails: type: object description: Represents a targetable operating system. This will be populated in the operating_system_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. properties: displayName: type: string description: Output only. The display name of the operating system. readOnly: true Operation: type: object description: This resource represents a long-running operation that is the result of a network API call. properties: name: type: string description: The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. done: type: boolean description: If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. error: $ref: '#/components/schemas/Status' response: type: object description: The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. additionalProperties: description: Properties of the object. Contains field @type with type URL. metadata: type: object description: Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. additionalProperties: description: Properties of the object. Contains field @type with type URL. Pacing: type: object description: Settings that control the rate at which a budget is spent. properties: dailyMaxMicros: type: string format: int64 description: 'Maximum currency amount to spend every day in micros of advertiser''s currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency''s billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.' pacingPeriod: type: string description: 'Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`. Allowed values — `PACING_PERIOD_UNSPECIFIED`: Period value is not specified or is unknown in this version.; `PACING_PERIOD_DAILY`: The pacing setting will be applied on daily basis.; `PACING_PERIOD_FLIGHT`: The pacing setting will be applied to the whole flight duration.' enum: - PACING_PERIOD_UNSPECIFIED - PACING_PERIOD_DAILY - PACING_PERIOD_FLIGHT dailyMaxImpressions: type: string format: int64 description: Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. pacingType: type: string description: 'Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders. Allowed values — `PACING_TYPE_UNSPECIFIED`: Pacing mode value is not specified or is unknown in this version.; `PACING_TYPE_AHEAD`: Only applicable to `PACING_PERIOD_FLIGHT` pacing period. Ahead pacing attempts to spend faster than evenly, to make sure the entire budget is spent by the end of the flight.; `PACING_TYPE_ASAP`: Spend all of pacing budget amount as quick as possible.; `PACING_TYPE_EVEN`: Spend a consistent budget amount every period of time.' enum: - PACING_TYPE_UNSPECIFIED - PACING_TYPE_AHEAD - PACING_TYPE_ASAP - PACING_TYPE_EVEN ParentEntityFilter: type: object description: A filtering option that filters on selected file types belonging to a chosen set of filter entities. properties: fileType: type: array description: Required. File types that will be returned. items: type: string 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 - FILE_TYPE_LINE_ITEM_QA - FILE_TYPE_AD_GROUP_QA description: 'Allowed values — `FILE_TYPE_UNSPECIFIED`: Default value when type is unspecified or is unknown in this version.; `FILE_TYPE_CAMPAIGN`: Campaign.; `FILE_TYPE_MEDIA_PRODUCT`: Media Product.; `FILE_TYPE_INSERTION_ORDER`: Insertion Order.; `FILE_TYPE_LINE_ITEM`: Line Item.; `FILE_TYPE_AD_GROUP`: YouTube Ad Group.; `FILE_TYPE_AD`: YouTube Ad.; `FILE_TYPE_LINE_ITEM_QA`: Line Item - QA format.; `FILE_TYPE_AD_GROUP_QA`: YouTube Ad Group - QA format.' filterIds: type: array description: The IDs of the specified filter type. This is used to filter entities to fetch. If filter type is not `FILTER_TYPE_NONE`, at least one ID must be specified. items: type: string format: int64 filterType: type: string description: 'Required. Filter type used to filter fetched entities. Allowed values — `FILTER_TYPE_UNSPECIFIED`: Default value when type is unspecified or is unknown in this version.; `FILTER_TYPE_NONE`: If selected, no filter will be applied to the download. Can only be used if an Advertiser is specified in CreateSdfDownloadTaskRequest.; `FILTER_TYPE_ADVERTISER_ID`: Advertiser ID. If selected, all filter IDs must be Advertiser IDs that belong to the Partner specified in CreateSdfDownloadTaskRequest.; `FILTER_TYPE_CAMPAIGN_ID`: Campaign ID. If selected, all filter IDs must be Campaign IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest.; `FILTER_TYPE_MEDIA_PRODUCT_ID`: Media Product ID. If selected, all filter IDs must be Media Product IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Can only be used for downloading `FILE_TYPE_MEDIA_PRODUCT`.; `FILTER_TYPE_INSERTION_ORDER_ID`: Insertion Order ID. If selected, all filter IDs must be Insertion Order IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Can only be used for downloading `FILE_TYPE_INSERTION_ORDER`, `FILE_TYPE_LINE_ITEM`, `FILE_TYPE_LINE_ITEM_QA`, `FILE_TYPE_AD_GROUP`, `FILE_TYPE_AD_GROUP_QA`, and `FILE_TYPE_AD`.; `FILTER_TYPE_LINE_ITEM_ID`: Line Item ID. If selected, all filter IDs must be Line Item IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Can only be used for downloading `FILE_TYPE_LINE_ITEM`, `FILE_TYPE_LINE_ITEM_QA`,`FILE_TYPE_AD_GROUP`, `FILE_TYPE_AD_GROUP_QA`, and `FILE_TYPE_AD`.' 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 ParentalStatusAssignedTargetingOptionDetails: type: object description: Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. properties: parentalStatus: type: string description: 'Required. The parental status of the audience. Allowed values — `PARENTAL_STATUS_UNSPECIFIED`: Default value when parental status is not specified in this version. This enum is a place holder for default value and does not represent a real parental status option.; `PARENTAL_STATUS_PARENT`: The audience is a parent.; `PARENTAL_STATUS_NOT_A_PARENT`: The audience is not a parent.; `PARENTAL_STATUS_UNKNOWN`: The parental status of the audience is unknown.' enum: - PARENTAL_STATUS_UNSPECIFIED - PARENTAL_STATUS_PARENT - PARENTAL_STATUS_NOT_A_PARENT - PARENTAL_STATUS_UNKNOWN ParentalStatusTargetingOptionDetails: type: object description: Represents a targetable parental status. This will be populated in the parental_status_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. properties: parentalStatus: type: string description: 'Output only. The parental status of an audience. Allowed values — `PARENTAL_STATUS_UNSPECIFIED`: Default value when parental status is not specified in this version. This enum is a place holder for default value and does not represent a real parental status option.; `PARENTAL_STATUS_PARENT`: The audience is a parent.; `PARENTAL_STATUS_NOT_A_PARENT`: The audience is not a parent.; `PARENTAL_STATUS_UNKNOWN`: The parental status of the audience is unknown.' enum: - PARENTAL_STATUS_UNSPECIFIED - PARENTAL_STATUS_PARENT - PARENTAL_STATUS_NOT_A_PARENT - PARENTAL_STATUS_UNKNOWN readOnly: true Partner: type: object description: A single partner in Display & Video 360 (DV360). properties: exchangeConfig: $ref: '#/components/schemas/ExchangeConfig' name: type: string description: Output only. The resource name of the partner. readOnly: true displayName: type: string description: The display name of the partner. Must be UTF-8 encoded with a maximum size of 240 bytes. dataAccessConfig: $ref: '#/components/schemas/PartnerDataAccessConfig' entityStatus: type: string description: 'Output only. The status of the partner. Allowed values — `ENTITY_STATUS_UNSPECIFIED`: Default value when status is not specified or is unknown in this version.; `ENTITY_STATUS_ACTIVE`: The entity is enabled to bid and spend budget.; `ENTITY_STATUS_ARCHIVED`: The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.; `ENTITY_STATUS_DRAFT`: The entity is under draft. Bidding and budget spending are disabled.; `ENTITY_STATUS_PAUSED`: Bidding and budget spending are paused for the entity.; `ENTITY_STATUS_SCHEDULED_FOR_DELETION`: The entity is scheduled for deletion.' enum: - ENTITY_STATUS_UNSPECIFIED - ENTITY_STATUS_ACTIVE - ENTITY_STATUS_ARCHIVED - ENTITY_STATUS_DRAFT - ENTITY_STATUS_PAUSED - ENTITY_STATUS_SCHEDULED_FOR_DELETION readOnly: true partnerId: type: string format: int64 description: Output only. The unique ID of the partner. Assigned by the system. readOnly: true billingConfig: $ref: '#/components/schemas/PartnerBillingConfig' generalConfig: $ref: '#/components/schemas/PartnerGeneralConfig' updateTime: type: string format: google-datetime description: Output only. The timestamp when the partner was last updated. Assigned by the system. readOnly: true adServerConfig: $ref: '#/components/schemas/PartnerAdServerConfig' PartnerAdServerConfig: type: object description: Ad server related settings of a partner. properties: measurementConfig: $ref: '#/components/schemas/MeasurementConfig' PartnerBillingConfig: type: object description: Billing related settings of a partner. properties: billingProfileId: type: string format: int64 description: The ID of a partner default billing profile. PartnerCost: type: object description: Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service. properties: feeType: type: string description: 'Required. The fee type for this partner cost. Allowed values — `PARTNER_COST_FEE_TYPE_UNSPECIFIED`: Value is not specified or is unknown in this version.; `PARTNER_COST_FEE_TYPE_CPM_FEE`: The partner cost is a fixed CPM fee. Not applicable when the partner cost cost_type is one of: * `PARTNER_COST_TYPE_MEDIA_COST_DATA` * `PARTNER_COST_TYPE_DV360_FEE`.; `PARTNER_COST_FEE_TYPE_MEDIA_FEE`: The partner cost is a percentage surcharge based on the media cost. Not applicable when the partner cost_type is one of: * `PARTNER_COST_TYPE_SHOP_LOCAL` * `PARTNER_COST_TYPE_TRUST_METRICS` * `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE_VIDEO` * `PARTNER_COST_TYPE_MOAT_VIDEO`.' enum: - PARTNER_COST_FEE_TYPE_UNSPECIFIED - PARTNER_COST_FEE_TYPE_CPM_FEE - PARTNER_COST_FEE_TYPE_MEDIA_FEE feePercentageMillis: type: string format: int64 description: 'The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.' costType: type: string description: 'Required. The type of the partner cost. Allowed values — `PARTNER_COST_TYPE_UNSPECIFIED`: Type value is not specified or is unknown in this version.; `PARTNER_COST_TYPE_ADLOOX`: The cost is charged for using Scope3 (previously known as Adloox). Billed by the partner.; `PARTNER_COST_TYPE_ADLOOX_PREBID`: The cost is charged for using Scope3 (previously known as Adloox) Pre-Bid. Billed through DV360.; `PARTNER_COST_TYPE_ADSAFE`: The cost is charged for using AdSafe. Billed by the partner.; `PARTNER_COST_TYPE_ADXPOSE`: The cost is charged for using AdExpose. Billed by the partner.; `PARTNER_COST_TYPE_AGGREGATE_KNOWLEDGE`: The cost is charged for using Aggregate Knowledge. Billed by the partner.; `PARTNER_COST_TYPE_AGENCY_TRADING_DESK`: The cost is charged for using an Agency Trading Desk. Billed by the partner.; `PARTNER_COST_TYPE_DV360_FEE`: The cost is charged for using DV360. Billed through DV360.; `PARTNER_COST_TYPE_COMSCORE_VCE`: The cost is charged for using comScore vCE. Billed through DV360.; `PARTNER_COST_TYPE_DATA_MANAGEMENT_PLATFORM`: The cost is charged for using a Data Management Platform. Billed by the partner.; `PARTNER_COST_TYPE_DEFAULT`: The default cost type. Billed by the partner.; `PARTNER_COST_TYPE_DOUBLE_VERIFY`: The cost is charged for using DoubleVerify. Billed by the partner.; `PARTNER_COST_TYPE_DOUBLE_VERIFY_PREBID`: The cost is charged for using DoubleVerify Pre-Bid. Billed through DV360.; `PARTNER_COST_TYPE_EVIDON`: The cost is charged for using Evidon. Billed by the partner.; `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE_VIDEO`: The cost is charged for using Integral Ad Science Video. Billed by the partner.; `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE_PREBID`: The cost is charged for using Integral Ad Science Pre-Bid. Billed through DV360.; `PARTNER_COST_TYPE_MEDIA_COST_DATA`: The cost is charged for using media cost data. Billed by the partner.; `PARTNER_COST_TYPE_MOAT_VIDEO`: The cost is charged for using MOAT Video. Billed by the partner.; `PARTNER_COST_TYPE_NIELSEN_DAR`: The cost is charged for using Nielsen Digital Ad Ratings. Billed through DV360.; `PARTNER_COST_TYPE_SHOP_LOCAL`: The cost is charged for using ShopLocal. Billed by the partner.; `PARTNER_COST_TYPE_TERACENT`: The cost is charged for using Teracent. Billed by the partner.; `PARTNER_COST_TYPE_THIRD_PARTY_AD_SERVER`: The cost is charged for using a third-party ad server. Billed by the partner.; `PARTNER_COST_TYPE_TRUST_METRICS`: The cost is charged for using TrustMetrics. Billed by the partner.; `PARTNER_COST_TYPE_VIZU`: The cost is charged for using Vizu. Billed by the partner.; `PARTNER_COST_TYPE_CUSTOM_FEE_1`: The cost is charged as custom fee 1. Billed by the partner.; `PARTNER_COST_TYPE_CUSTOM_FEE_2`: The cost is charged as custom fee 2. Billed by the partner.; `PARTNER_COST_TYPE_CUSTOM_FEE_3`: The cost is charged as custom fee 3. Billed by the partner.; `PARTNER_COST_TYPE_CUSTOM_FEE_4`: The cost is charged as custom fee 4. Billed by the partner.; `PARTNER_COST_TYPE_CUSTOM_FEE_5`: The cost is charged as custom fee 5. Billed by the partner.; `PARTNER_COST_TYPE_SCIBIDS_FEE`: The cost is charged for using Scibids. Billed through DV360. This type is currently only available to certain customers. Other customers attempting to use this type will receive an error.' 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_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 - PARTNER_COST_TYPE_SCIBIDS_FEE feeAmount: type: string format: int64 description: The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000. invoiceType: type: string description: 'The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types. Allowed values — `PARTNER_COST_INVOICE_TYPE_UNSPECIFIED`: Type value is not specified or is unknown in this version.; `PARTNER_COST_INVOICE_TYPE_DV360`: Partner cost is billed through DV360.; `PARTNER_COST_INVOICE_TYPE_PARTNER`: Partner cost is billed by the partner.' enum: - PARTNER_COST_INVOICE_TYPE_UNSPECIFIED - PARTNER_COST_INVOICE_TYPE_DV360 - PARTNER_COST_INVOICE_TYPE_PARTNER PartnerDataAccessConfig: type: object description: Settings that control how partner related data may be accessed. properties: sdfConfig: $ref: '#/components/schemas/SdfConfig' PartnerGeneralConfig: type: object description: General settings of a partner. properties: timeZone: type: string description: 'Immutable. The standard TZ database name of the partner''s time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones' currencyCode: type: string description: Immutable. Partner's currency in ISO 4217 format. PartnerRevenueModel: type: object description: Settings that control how partner revenue is calculated. properties: markupType: type: string description: 'Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items. Allowed values — `PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED`: Type value is not specified or is unknown in this version.; `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`: Calculate the partner revenue based on a fixed CPM.; `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`: Calculate the partner revenue based on a percentage surcharge of its media cost.; `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`: Calculate the partner revenue based on a percentage surcharge of its total media cost, which includes all partner costs and data costs.' 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 markupAmount: type: string format: int64 description: Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). PerformanceGoal: type: object description: Settings that control the performance goal of a campaign. properties: performanceGoalAmountMicros: type: string format: int64 description: 'The goal amount, in micros of the advertiser''s currency. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` * `PERFORMANCE_GOAL_TYPE_VCPM` For example 1500000 represents 1.5 standard units of the currency.' performanceGoalPercentageMicros: type: string format: int64 description: 'The decimal representation of the goal percentage in micros. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` * `PERFORMANCE_GOAL_TYPE_CLICK_CVR` * `PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR` * `PERFORMANCE_GOAL_TYPE_VTR` * `PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE` * `PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE` For example, 70000 represents 7% (decimal 0.07).' performanceGoalString: type: string description: A key performance indicator (KPI) string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when performance_goal_type is set to `PERFORMANCE_GOAL_TYPE_OTHER`. performanceGoalType: type: string description: 'Required. The type of the performance goal. Allowed values — `PERFORMANCE_GOAL_TYPE_UNSPECIFIED`: Performance goal type is not specified or is unknown in this version.; `PERFORMANCE_GOAL_TYPE_CPM`: The performance goal is set in CPM (cost per mille).; `PERFORMANCE_GOAL_TYPE_CPC`: The performance goal is set in CPC (cost per click).; `PERFORMANCE_GOAL_TYPE_CPA`: The performance goal is set in CPA (cost per action).; `PERFORMANCE_GOAL_TYPE_CTR`: The performance goal is set in CTR (click-through rate) percentage.; `PERFORMANCE_GOAL_TYPE_VIEWABILITY`: The performance goal is set in Viewability percentage.; `PERFORMANCE_GOAL_TYPE_CPIAVC`: The performance goal is set as CPIAVC (cost per impression audible and visible at completion).; `PERFORMANCE_GOAL_TYPE_CPE`: The performance goal is set in CPE (cost per engagement).; `PERFORMANCE_GOAL_TYPE_CPV`: The performance goal is set in CPV (cost per view).; `PERFORMANCE_GOAL_TYPE_CLICK_CVR`: The performance goal is set in click conversion rate (conversions per click) percentage.; `PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR`: The performance goal is set in impression conversion rate (conversions per impression) percentage.; `PERFORMANCE_GOAL_TYPE_VCPM`: The performance goal is set in VCPM (cost per thousand viewable impressions).; `PERFORMANCE_GOAL_TYPE_VTR`: The performance goal is set in YouTube view rate (YouTube views per impression) percentage.; `PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE`: The performance goal is set in audio completion rate (complete audio listens per impression) percentage.; `PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE`: The performance goal is set in video completion rate (complete video views per impression) percentage.; `PERFORMANCE_GOAL_TYPE_OTHER`: The performance goal is set to Other.' enum: - PERFORMANCE_GOAL_TYPE_UNSPECIFIED - PERFORMANCE_GOAL_TYPE_CPM - PERFORMANCE_GOAL_TYPE_CPC - PERFORMANCE_GOAL_TYPE_CPA - PERFORMANCE_GOAL_TYPE_CTR - PERFORMANCE_GOAL_TYPE_VIEWABILITY - PERFORMANCE_GOAL_TYPE_CPIAVC - PERFORMANCE_GOAL_TYPE_CPE - PERFORMANCE_GOAL_TYPE_CPV - PERFORMANCE_GOAL_TYPE_CLICK_CVR - PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR - PERFORMANCE_GOAL_TYPE_VCPM - PERFORMANCE_GOAL_TYPE_VTR - PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE - PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE - PERFORMANCE_GOAL_TYPE_OTHER PerformanceGoalBidStrategy: type: object description: A strategy that automatically adjusts the bid to meet or beat a specified performance goal. properties: performanceGoalAmountMicros: type: string format: int64 description: 'Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser''s currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser''s currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.' customBiddingAlgorithmId: type: string format: int64 description: The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. maxAverageCpmBidAmountMicros: type: string format: int64 description: The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. performanceGoalType: type: string description: 'Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Allowed values — `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_UNSPECIFIED`: Type value is not specified or is unknown in this version.; `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`: Cost per action.; `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`: Cost per click.; `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`: Viewable CPM.; `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`: Custom bidding algorithm.; `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA`: Completed inview and audible views.; `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN`: Inview time over 10 secs views.; `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED`: Viewable impressions.; `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH`: Maximize reach.' 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_CUSTOM_ALGO - BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA - BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN - BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED - BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH PlannableLocation: type: object description: A plannable location used for forecasting. properties: name: type: string description: Output only. The resource name of the plannable location. readOnly: true displayName: type: string description: Output only. The display name of the location, for example "Algeria". readOnly: true plannableLocationId: type: string format: int64 description: Output only. The plannable location ID. readOnly: true regionCode: type: string description: Output only. The region code of the location, for example "DZ" for Algeria. readOnly: true parentPlannableLocationId: type: string format: int64 description: Output only. The parent plannable location ID, for example the country ID for subgeos. readOnly: true geoRegionType: type: string description: 'Output only. The type of location. Allowed values — `GEO_REGION_TYPE_UNKNOWN`: The geographic region type is unknown.; `GEO_REGION_TYPE_OTHER`: The geographic region type is other.; `GEO_REGION_TYPE_COUNTRY`: The geographic region is a country.; `GEO_REGION_TYPE_REGION`: The geographic region type is region.; `GEO_REGION_TYPE_TERRITORY`: The geographic region is a territory.; `GEO_REGION_TYPE_PROVINCE`: The geographic region is a province.; `GEO_REGION_TYPE_STATE`: The geographic region is a state.; `GEO_REGION_TYPE_PREFECTURE`: The geographic region is a prefecture.; `GEO_REGION_TYPE_GOVERNORATE`: The geographic region is a governorate.; `GEO_REGION_TYPE_CANTON`: The geographic region is a canton.; `GEO_REGION_TYPE_UNION_TERRITORY`: The geographic region is a union territory.; `GEO_REGION_TYPE_AUTONOMOUS_COMMUNITY`: The geographic region is an autonomous community.; `GEO_REGION_TYPE_DMA_REGION`: The geographic region is a designated market area (DMA) region.; `GEO_REGION_TYPE_METRO`: The geographic region type is metro.; `GEO_REGION_TYPE_CONGRESSIONAL_DISTRICT`: The geographic region is a congressional district.; `GEO_REGION_TYPE_COUNTY`: The geographic region is a county.; `GEO_REGION_TYPE_MUNICIPALITY`: The geographic region is a municipality.; `GEO_REGION_TYPE_CITY`: The geographic region is a city.; `GEO_REGION_TYPE_POSTAL_CODE`: The geographic region targeting type is postal code.; `GEO_REGION_TYPE_DEPARTMENT`: The geographic region targeting type is department.; `GEO_REGION_TYPE_AIRPORT`: The geographic region is an airport.; `GEO_REGION_TYPE_TV_REGION`: The geographic region is a TV region.; `GEO_REGION_TYPE_OKRUG`: The geographic region is an okrug.; `GEO_REGION_TYPE_BOROUGH`: The geographic region is a borough.; `GEO_REGION_TYPE_CITY_REGION`: The geographic region is a city region.; `GEO_REGION_TYPE_ARRONDISSEMENT`: The geographic region is an arrondissement.; `GEO_REGION_TYPE_NEIGHBORHOOD`: The geographic region is a neighborhood.; `GEO_REGION_TYPE_UNIVERSITY`: The geographic region is a university.; `GEO_REGION_TYPE_DISTRICT`: The geographic region is a district.; `GEO_REGION_TYPE_NATIONAL_PARK`: The geographic region is a national park.; `GEO_REGION_TYPE_BARRIO`: The geographic region is a barrio.; `GEO_REGION_TYPE_SUB_WARD`: The geographic region is a sub ward.; `GEO_REGION_TYPE_MUNICIPALITY_DISTRICT`: The geographic region is a municipality district.; `GEO_REGION_TYPE_SUB_DISTRICT`: The geographic region is a sub district.; `GEO_REGION_TYPE_QUARTER`: The geographic region is a quarter.; `GEO_REGION_TYPE_DIVISION`: The geographic region is a division.; `GEO_REGION_TYPE_COMMUNE`: The geographic region is a commune.; `GEO_REGION_TYPE_COLLOQUIAL_AREA`: The geographic region is a colloquial area.; `GEO_REGION_TYPE_POST_TOWN`: The geographic region is a post town.; `GEO_REGION_TYPE_WARD`: The geographic region is a ward.; `GEO_REGION_TYPE_TOWN`: The geographic region is a town.; `GEO_REGION_TYPE_VILLAGE`: The geographic region is a village.; `GEO_REGION_TYPE_CITY_DISTRICT`: The geographic region is a city district.; `GEO_REGION_TYPE_SUBURB`: The geographic region is a suburb.; `GEO_REGION_TYPE_HAMLET`: The geographic region is a hamlet.; `GEO_REGION_TYPE_MUNICIPAL_DISTRICT`: The geographic region is a municipal district.; `GEO_REGION_TYPE_COMMUNITY`: The geographic region is a community.; `GEO_REGION_TYPE_TOWNSHIP`: The geographic region is a township.; `GEO_REGION_TYPE_URBAN_DISTRICT`: The geographic region is an urban district.; `GEO_REGION_TYPE_RESIDENTIAL_AREA`: The geographic region is a residential area.; `GEO_REGION_TYPE_INDEPENDENT_CITY`: The geographic region is an independent city.; `GEO_REGION_TYPE_SECTOR`: The geographic region is a sector.; `GEO_REGION_TYPE_AREA`: The geographic region is an area.; `GEO_REGION_TYPE_ESTATE`: The geographic region is an estate.; `GEO_REGION_TYPE_PARISH`: The geographic region is a parish.; `GEO_REGION_TYPE_SETTLEMENT`: The geographic region is a settlement.; `GEO_REGION_TYPE_ZONE`: The geographic region is a zone.; `GEO_REGION_TYPE_COLONY`: The geographic region is a colony.; `GEO_REGION_TYPE_INDUSTRIAL_AREA`: The geographic region is an industrial area.; `GEO_REGION_TYPE_PROVINCIAL_CITY`: The geographic region is a provincial city.; `GEO_REGION_TYPE_RURAL_DISTRICT`: The geographic region is a rural district.' 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 - GEO_REGION_TYPE_NATIONAL_PARK - GEO_REGION_TYPE_BARRIO - GEO_REGION_TYPE_SUB_WARD - GEO_REGION_TYPE_MUNICIPALITY_DISTRICT - GEO_REGION_TYPE_SUB_DISTRICT - GEO_REGION_TYPE_QUARTER - GEO_REGION_TYPE_DIVISION - GEO_REGION_TYPE_COMMUNE - GEO_REGION_TYPE_COLLOQUIAL_AREA - GEO_REGION_TYPE_POST_TOWN - GEO_REGION_TYPE_WARD - GEO_REGION_TYPE_TOWN - GEO_REGION_TYPE_VILLAGE - GEO_REGION_TYPE_CITY_DISTRICT - GEO_REGION_TYPE_SUBURB - GEO_REGION_TYPE_HAMLET - GEO_REGION_TYPE_MUNICIPAL_DISTRICT - GEO_REGION_TYPE_COMMUNITY - GEO_REGION_TYPE_TOWNSHIP - GEO_REGION_TYPE_URBAN_DISTRICT - GEO_REGION_TYPE_RESIDENTIAL_AREA - GEO_REGION_TYPE_INDEPENDENT_CITY - GEO_REGION_TYPE_SECTOR - GEO_REGION_TYPE_AREA - GEO_REGION_TYPE_ESTATE - GEO_REGION_TYPE_PARISH - GEO_REGION_TYPE_SETTLEMENT - GEO_REGION_TYPE_ZONE - GEO_REGION_TYPE_COLONY - GEO_REGION_TYPE_INDUSTRIAL_AREA - GEO_REGION_TYPE_PROVINCIAL_CITY - GEO_REGION_TYPE_RURAL_DISTRICT readOnly: true PlannableProductCoreAttributes: type: object description: Core attributes for a plannable product. properties: costModel: type: string description: 'Output only. The cost model. Allowed values — `PLANNABLE_COST_MODEL_UNSPECIFIED`: Not specified.; `PLANNABLE_COST_MODEL_CPM`: CPM.; `PLANNABLE_COST_MODEL_CPV`: CPV.; `PLANNABLE_COST_MODEL_CPC`: CPC.; `PLANNABLE_COST_MODEL_CPA`: CPA.' enum: - PLANNABLE_COST_MODEL_UNSPECIFIED - PLANNABLE_COST_MODEL_CPM - PLANNABLE_COST_MODEL_CPV - PLANNABLE_COST_MODEL_CPC - PLANNABLE_COST_MODEL_CPA readOnly: true productCategory: type: string description: 'Output only. The product category. Allowed values — `PLANNABLE_PRODUCT_CATEGORY_UNSPECIFIED`: Not specified.; `YOUTUBE`: YouTube.; `OPEN_AUCTION`: Open Auction.' enum: - PLANNABLE_PRODUCT_CATEGORY_UNSPECIFIED - YOUTUBE - OPEN_AUCTION readOnly: true buyingMethod: type: string description: 'Output only. The buying method. Allowed values — `PLANNABLE_BUYING_METHOD_UNSPECIFIED`: Not specified.; `PLANNABLE_BUYING_METHOD_AUCTION`: Auction.; `PLANNABLE_BUYING_METHOD_RESERVATION`: Reservation.' enum: - PLANNABLE_BUYING_METHOD_UNSPECIFIED - PLANNABLE_BUYING_METHOD_AUCTION - PLANNABLE_BUYING_METHOD_RESERVATION readOnly: true PlannableTargeting: type: object description: Targeting capabilities for a given product. properties: networks: type: array description: Output only. Targetable networks for the ad product. readOnly: true items: type: string enum: - PLANNABLE_NETWORK_UNSPECIFIED - PLANNABLE_NETWORK_YOUTUBE - PLANNABLE_NETWORK_GOOGLE_VIDEO_PARTNERS - PLANNABLE_NETWORK_YOUTUBE_AND_GOOGLE_VIDEO_PARTNERS description: 'Allowed values — `PLANNABLE_NETWORK_UNSPECIFIED`: Not specified.; `PLANNABLE_NETWORK_YOUTUBE`: YouTube.; `PLANNABLE_NETWORK_GOOGLE_VIDEO_PARTNERS`: Google Video Partners.; `PLANNABLE_NETWORK_YOUTUBE_AND_GOOGLE_VIDEO_PARTNERS`: YouTube and Google Video Partners.' defaultYoutubeSelectLineup: $ref: '#/components/schemas/YouTubeSelectLineUp' surfaceTargetingCombinations: $ref: '#/components/schemas/SurfaceTargetingCombinations' genders: type: array description: Output only. Targetable genders for the ad product. readOnly: true items: type: string enum: - GENDER_UNSPECIFIED - GENDER_MALE - GENDER_FEMALE - GENDER_UNKNOWN description: 'Allowed values — `GENDER_UNSPECIFIED`: Default value when gender is not specified in this version. This enum is a place holder for default value and does not represent a real gender option.; `GENDER_MALE`: The audience gender is male.; `GENDER_FEMALE`: The audience gender is female.; `GENDER_UNKNOWN`: The audience gender is unknown.' devices: type: array description: Output only. Targetable devices for the ad product. readOnly: true items: type: string enum: - DEVICE_TYPE_UNSPECIFIED - DEVICE_TYPE_COMPUTER - DEVICE_TYPE_CONNECTED_TV - DEVICE_TYPE_SMART_PHONE - DEVICE_TYPE_TABLET - DEVICE_TYPE_CONNECTED_DEVICE description: 'Allowed values — `DEVICE_TYPE_UNSPECIFIED`: Default value when device type is not specified in this version. This enum is a placeholder for default value and does not represent a real device type option.; `DEVICE_TYPE_COMPUTER`: Computer.; `DEVICE_TYPE_CONNECTED_TV`: Connected TV.; `DEVICE_TYPE_SMART_PHONE`: Smart phone.; `DEVICE_TYPE_TABLET`: Tablet.; `DEVICE_TYPE_CONNECTED_DEVICE`: Connected device.' ageRanges: type: array description: Output only. Allowed plannable age ranges for the product. Actual targeting is computed by mapping this age range onto standard Google age targeting. readOnly: true items: type: string enum: - PLANNABLE_AGE_RANGE_UNSPECIFIED - PLANNABLE_AGE_RANGE_18_24 - PLANNABLE_AGE_RANGE_18_34 - PLANNABLE_AGE_RANGE_18_44 - PLANNABLE_AGE_RANGE_18_49 - PLANNABLE_AGE_RANGE_18_54 - PLANNABLE_AGE_RANGE_18_64 - PLANNABLE_AGE_RANGE_18_65_UP - PLANNABLE_AGE_RANGE_21_34 - PLANNABLE_AGE_RANGE_21_44 - PLANNABLE_AGE_RANGE_21_49 - PLANNABLE_AGE_RANGE_21_54 - PLANNABLE_AGE_RANGE_21_64 - PLANNABLE_AGE_RANGE_21_65_UP - PLANNABLE_AGE_RANGE_25_34 - PLANNABLE_AGE_RANGE_25_44 - PLANNABLE_AGE_RANGE_25_49 - PLANNABLE_AGE_RANGE_25_54 - PLANNABLE_AGE_RANGE_25_64 - PLANNABLE_AGE_RANGE_25_65_UP - PLANNABLE_AGE_RANGE_35_44 - PLANNABLE_AGE_RANGE_35_49 - PLANNABLE_AGE_RANGE_35_54 - PLANNABLE_AGE_RANGE_35_64 - PLANNABLE_AGE_RANGE_35_65_UP - PLANNABLE_AGE_RANGE_45_54 - PLANNABLE_AGE_RANGE_45_64 - PLANNABLE_AGE_RANGE_45_65_UP - PLANNABLE_AGE_RANGE_50_65_UP - PLANNABLE_AGE_RANGE_55_64 - PLANNABLE_AGE_RANGE_55_65_UP - PLANNABLE_AGE_RANGE_65_UP description: 'Allowed values — `PLANNABLE_AGE_RANGE_UNSPECIFIED`: Not specified.; `PLANNABLE_AGE_RANGE_18_24`: 18 to 24 years old.; `PLANNABLE_AGE_RANGE_18_34`: 18 to 34 years old.; `PLANNABLE_AGE_RANGE_18_44`: 18 to 44 years old.; `PLANNABLE_AGE_RANGE_18_49`: 18 to 49 years old.; `PLANNABLE_AGE_RANGE_18_54`: 18 to 54 years old.; `PLANNABLE_AGE_RANGE_18_64`: 18 to 64 years old.; `PLANNABLE_AGE_RANGE_18_65_UP`: 18 to 65+ years old.; `PLANNABLE_AGE_RANGE_21_34`: 21 to 34 years old.; `PLANNABLE_AGE_RANGE_21_44`: 21 to 44 years old.; `PLANNABLE_AGE_RANGE_21_49`: 21 to 49 years old.; `PLANNABLE_AGE_RANGE_21_54`: 21 to 54 years old.; `PLANNABLE_AGE_RANGE_21_64`: 21 to 64 years old.; `PLANNABLE_AGE_RANGE_21_65_UP`: 21 to 65+ years old.; `PLANNABLE_AGE_RANGE_25_34`: 25 to 34 years old.; `PLANNABLE_AGE_RANGE_25_44`: 25 to 44 years old.; `PLANNABLE_AGE_RANGE_25_49`: 25 to 49 years old.; `PLANNABLE_AGE_RANGE_25_54`: 25 to 54 years old.; `PLANNABLE_AGE_RANGE_25_64`: 25 to 64 years old.; `PLANNABLE_AGE_RANGE_25_65_UP`: 25 to 65+ years old.; `PLANNABLE_AGE_RANGE_35_44`: 35 to 44 years old.; `PLANNABLE_AGE_RANGE_35_49`: 35 to 49 years old.; `PLANNABLE_AGE_RANGE_35_54`: 35 to 54 years old.; `PLANNABLE_AGE_RANGE_35_64`: 35 to 64 years old.; `PLANNABLE_AGE_RANGE_35_65_UP`: 35 to 65+ years old.; `PLANNABLE_AGE_RANGE_45_54`: 45 to 54 years old.; `PLANNABLE_AGE_RANGE_45_64`: 45 to 64 years old.; `PLANNABLE_AGE_RANGE_45_65_UP`: 45 to 65+ years old.; `PLANNABLE_AGE_RANGE_50_65_UP`: 50 to 65+ years old.; `PLANNABLE_AGE_RANGE_55_64`: 55 to 64 years old.; `PLANNABLE_AGE_RANGE_55_65_UP`: 55 to 65+ years old.; `PLANNABLE_AGE_RANGE_65_UP`: 65+ years old.' youtubeSelectLineups: type: array description: Output only. Targetable YouTube Select Lineups for the ad product. readOnly: true items: $ref: '#/components/schemas/YouTubeSelectLineUp' PlannableUserInterest: type: object description: A plannable user interest used for targeting. properties: userInterestPath: type: string description: Output only. The category path of the interest. readOnly: true userInterest: $ref: '#/components/schemas/UserInterest' userInterestDisplayName: type: string description: Output only. The display name of the interest, for example "Outdoor Enthusiasts". readOnly: true userInterestType: type: string description: Output only. The type of audience, e.g., "AFFINITY", "IN_MARKET". readOnly: true PlannableUserList: type: object description: A plannable user list used for reach forecasting. properties: userListType: type: string description: 'Output only. The type of the user list. Allowed values — `USER_LIST_TYPE_UNSPECIFIED`: Unspecified user list type.; `FIRST_PARTY`: A first-party user list.; `THIRD_PARTY`: A third-party user list.' enum: - USER_LIST_TYPE_UNSPECIFIED - FIRST_PARTY - THIRD_PARTY readOnly: true name: type: string description: 'Output only. The resource name identifying the user list. Format: `advertisers/{advertiser_id}/userLists/{user_list_id}`' readOnly: true displayName: type: string description: Output only. The display name of the user list. readOnly: true plannableStatus: type: string description: 'Output only. The plannability status of the user list. Allowed values — `PLANNABLE_STATUS_UNSPECIFIED`: Unspecified plannability status.; `PLANNABLE`: The user list is plannable.; `UNPLANNABLE`: The user list is unplannable.' enum: - PLANNABLE_STATUS_UNSPECIFIED - PLANNABLE - UNPLANNABLE readOnly: true PlannedProduct: type: object description: Configuration for a specific product in the plan. properties: budgetMicros: type: string format: int64 description: Required. The budget for this product in micros. plannableProductCode: type: string description: Required. The code for the product, e.g. "VIDEO_REACH_CAMPAIGN". advancedProductTargeting: $ref: '#/components/schemas/AdvancedProductTargeting' PlannedProductForecast: type: object description: Performance metrics for a forecast point. properties: trueviewViews: type: string format: int64 description: Number of TrueView views. viewableImpressions: type: string format: int64 description: Number of viewable impressions. onTargetCoviewImpressions: type: string format: int64 description: Number of on-target impressions including co-viewers. onTargetCoviewReach: type: string format: int64 description: Number of unique people reached that match the on-target definition including co-viewers. totalImpressions: type: string format: int64 description: Total number of impressions. totalCoviewReach: type: string format: int64 description: Total number of unique people reached including co-viewers. totalReach: type: string format: int64 description: Total number of unique people reached. totalCoviewImpressions: type: string format: int64 description: Total number of impressions including co-viewers. onTargetReach: type: string format: int64 description: Number of unique people reached that match the on-target definition. onTargetImpressions: type: string format: int64 description: Number of on-target impressions. PlannedProductReachForecast: type: object description: Performance forecast for a specific product. properties: costMicros: type: string format: int64 description: The cost in micros for this product. plannableProductCode: type: string description: The code for the product. plannedProductForecast: $ref: '#/components/schemas/PlannedProductForecast' PoiAssignedTargetingOptionDetails: type: object description: Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. properties: latitude: type: number format: double description: Output only. Latitude of the POI rounding to 6th decimal place. readOnly: true longitude: type: number format: double description: Output only. Longitude of the POI rounding to 6th decimal place. readOnly: true displayName: type: string description: Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available. readOnly: true targetingOptionId: type: string description: Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.** proximityRadiusAmount: type: number format: double description: Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. proximityRadiusUnit: type: string description: 'Required. The unit of distance by which the targeting radius is measured. Allowed values — `DISTANCE_UNIT_UNSPECIFIED`: Type value is not specified or is unknown in this version.; `DISTANCE_UNIT_MILES`: Miles.; `DISTANCE_UNIT_KILOMETERS`: Kilometers.' enum: - DISTANCE_UNIT_UNSPECIFIED - DISTANCE_UNIT_MILES - DISTANCE_UNIT_KILOMETERS PoiSearchTerms: type: object description: Search terms for POI targeting options. properties: poiQuery: type: string description: The search query for the desired POI name, street address, or coordinate of the desired POI. The query can be a prefix, e.g. "Times squar", "40.7505045,-73.99562", "315 W 44th St", etc. PoiTargetingOptionDetails: type: object description: Represents a targetable point of interest(POI). This will be populated in the poi_details field when targeting_type is `TARGETING_TYPE_POI`. properties: latitude: type: number format: double description: Output only. Latitude of the POI rounding to 6th decimal place. readOnly: true longitude: type: number format: double description: Output only. Longitude of the POI rounding to 6th decimal place. readOnly: true displayName: type: string description: Output only. The display name of a POI(e.g. "Times Square", "Space Needle"), followed by its full address if available. readOnly: true PrismaConfig: type: object description: Settings specific to the Mediaocean Prisma tool. properties: prismaType: type: string description: 'Required. The Prisma type. Allowed values — `PRISMA_TYPE_UNSPECIFIED`: Type is not specified or unknown in this version.; `PRISMA_TYPE_DISPLAY`: Display type.; `PRISMA_TYPE_SEARCH`: Search type.; `PRISMA_TYPE_VIDEO`: Video type.; `PRISMA_TYPE_AUDIO`: Audio type.; `PRISMA_TYPE_SOCIAL`: Social type.; `PRISMA_TYPE_FEE`: Fee type.' enum: - PRISMA_TYPE_UNSPECIFIED - PRISMA_TYPE_DISPLAY - PRISMA_TYPE_SEARCH - PRISMA_TYPE_VIDEO - PRISMA_TYPE_AUDIO - PRISMA_TYPE_SOCIAL - PRISMA_TYPE_FEE supplier: type: string description: Required. The entity allocated this budget (DSP, site, etc.). prismaCpeCode: $ref: '#/components/schemas/PrismaCpeCode' PrismaCpeCode: type: object description: Google Payments Center supports searching and filtering on the component fields of this code. properties: prismaClientCode: type: string description: The Prisma client code. prismaProductCode: type: string description: The Prisma product code. prismaEstimateCode: type: string description: The Prisma estimate code. ProductFeedData: type: object description: The details of product feed. properties: productMatchType: type: string description: 'How products are selected by the product feed. Allowed values — `PRODUCT_MATCH_TYPE_UNSPECIFIED`: Not specified or unknown.; `PRODUCT_MATCH_TYPE_ALL_PRODUCTS`: All the products are matched.; `PRODUCT_MATCH_TYPE_SPECIFIC_PRODUCTS`: Specific products are selected.; `PRODUCT_MATCH_TYPE_CUSTOM_LABEL`: Match products by their custom labels.' enum: - PRODUCT_MATCH_TYPE_UNSPECIFIED - PRODUCT_MATCH_TYPE_ALL_PRODUCTS - PRODUCT_MATCH_TYPE_SPECIFIC_PRODUCTS - PRODUCT_MATCH_TYPE_CUSTOM_LABEL productMatchDimensions: type: array description: A list of dimensions used to match products. items: $ref: '#/components/schemas/ProductMatchDimension' isFeedDisabled: type: boolean description: Whether the product feed has opted-out of showing products. ProductMatchDimension: type: object description: A dimension used to match products. properties: productOfferId: type: string description: The ID of the product offer to match with a product with the same offer ID. customLabel: $ref: '#/components/schemas/CustomLabel' ProductMetadata: type: object description: Metadata for a plannable product. properties: plannableProductCode: type: string description: Output only. The plannable product code (e.g. "YOUTUBE_REACH_MIX"). readOnly: true plannableProductDescription: type: string description: Output only. The plain-text description of the ad product. readOnly: true plannableProductCoreAttributes: $ref: '#/components/schemas/PlannableProductCoreAttributes' plannableTargeting: $ref: '#/components/schemas/PlannableTargeting' displayName: type: string description: 'Output only. The name associated with the ad product. For example: "Video View Campaign".' readOnly: true ProximityLocationListAssignedTargetingOptionDetails: type: object description: Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. properties: proximityRadius: type: number format: double description: Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers. proximityRadiusUnit: type: string description: 'Required. Radius distance units. Allowed values — `PROXIMITY_RADIUS_UNIT_UNSPECIFIED`: Default value when distance units is not specified in this version. This enum is a place holder for default value and does not represent a real distance unit.; `PROXIMITY_RADIUS_UNIT_MILES`: Radius distance unit in miles.; `PROXIMITY_RADIUS_UNIT_KILOMETERS`: Radius distance unit in kilometeres' enum: - PROXIMITY_RADIUS_UNIT_UNSPECIFIED - PROXIMITY_RADIUS_UNIT_MILES - PROXIMITY_RADIUS_UNIT_KILOMETERS proximityLocationListId: type: string format: int64 description: Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`. RateDetails: type: object description: The rate related settings of the inventory source. properties: inventorySourceRateType: type: string description: 'The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`. Allowed values — `INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED`: The rate type is not specified or is unknown in this version.; `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`: The rate type is CPM (Fixed).; `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`: The rate type is CPM (Floor).; `INVENTORY_SOURCE_RATE_TYPE_CPD`: The rate type is Cost per Day.; `INVENTORY_SOURCE_RATE_TYPE_CPH`: The rate type is Cost per Hour.; `INVENTORY_SOURCE_RATE_TYPE_FLAT`: The rate type is Flat.' 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_CPH - INVENTORY_SOURCE_RATE_TYPE_FLAT unitsPurchased: type: string format: int64 description: Required for guaranteed inventory sources. The number of impressions guaranteed by the seller. minimumSpend: $ref: '#/components/schemas/Money' rate: $ref: '#/components/schemas/Money' ReachCurve: type: object description: The generated reach curve. properties: reachForecasts: type: array description: Points along the curve, ordered by cost. items: $ref: '#/components/schemas/ReachForecast' ReachForecast: type: object description: A single point in the reach curve. properties: costMicros: type: string format: int64 description: Total cost for this point in micros. plannedProductReachForecasts: type: array description: Breakdown for individual products at this cost point. items: $ref: '#/components/schemas/PlannedProductReachForecast' forecast: $ref: '#/components/schemas/PlannedProductForecast' RegionalLocationListAssignedTargetingOptionDetails: type: object description: Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. properties: regionalLocationListId: type: string format: int64 description: Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. negative: type: boolean description: Indicates if this option is being negatively targeted. RemarketingConfig: type: object description: Settings that control the whether remarketing is enabled for the given identified advertiser. properties: advertiserId: type: string format: int64 description: Output only. The ID of the advertiser. readOnly: true remarketingEnabled: type: boolean description: Output only. Whether the Floodlight activity remarketing user list is available to the identified advertiser. readOnly: true ReplaceNegativeKeywordsRequest: type: object description: Request message for NegativeKeywordService.ReplaceNegativeKeywords. properties: newNegativeKeywords: type: array description: The negative keywords that will replace the existing keywords in the negative keyword list, specified as a list of NegativeKeywords. items: $ref: '#/components/schemas/NegativeKeyword' ReplaceNegativeKeywordsResponse: type: object description: Response message for NegativeKeywordService.ReplaceNegativeKeywords. properties: negativeKeywords: type: array description: The full list of negative keywords now present in the negative keyword list. items: $ref: '#/components/schemas/NegativeKeyword' ReplaceSitesRequest: type: object description: Request message for SiteService.ReplaceSites. properties: newSites: type: array description: The sites that will replace the existing sites assigned to the channel, specified as a list of Sites. items: $ref: '#/components/schemas/Site' advertiserId: type: string format: int64 description: The ID of the advertiser that owns the parent channel. partnerId: type: string format: int64 description: The ID of the partner that owns the parent channel. ReplaceSitesResponse: type: object description: Response message for SiteService.ReplaceSites. properties: sites: type: array description: The list of sites in the channel after replacing. items: $ref: '#/components/schemas/Site' RetrievePlannableLocationsResponse: type: object description: Response for RetrievePlannableLocations properties: plannableLocations: type: array description: Output only. The list of plannable locations. readOnly: true items: $ref: '#/components/schemas/PlannableLocation' RetrievePlannableProductsResponse: type: object description: Response for RetrievePlannableProducts properties: productMetadata: type: array description: Output only. The list of product metadata showing targeting possibilities. readOnly: true items: $ref: '#/components/schemas/ProductMetadata' RetrievePlannableUserInterestsResponse: type: object description: Response for RetrievePlannableUserInterests. properties: plannableUserInterests: type: array description: The list of plannable user interests (Google Audiences). items: $ref: '#/components/schemas/PlannableUserInterest' RetrievePlannableUserListsResponse: type: object description: Response for RetrievePlannableUserLists. properties: nextPageToken: type: string description: Output only. A token to retrieve the next page of results. readOnly: true plannableUserLists: type: array description: Output only. The list of plannable user lists. readOnly: true items: $ref: '#/components/schemas/PlannableUserList' ReviewStatusInfo: type: object description: Review statuses for the creative. properties: creativeAndLandingPageReviewStatus: type: string description: 'Creative and landing page review status for the creative. Allowed values — `REVIEW_STATUS_UNSPECIFIED`: Type value is not specified or is unknown in this version.; `REVIEW_STATUS_APPROVED`: The creative is approved.; `REVIEW_STATUS_REJECTED`: The creative is rejected.; `REVIEW_STATUS_PENDING`: The creative is pending review.' enum: - REVIEW_STATUS_UNSPECIFIED - REVIEW_STATUS_APPROVED - REVIEW_STATUS_REJECTED - REVIEW_STATUS_PENDING approvalStatus: type: string description: 'Represents the basic approval needed for a creative to begin serving. Summary of creative_and_landing_page_review_status and content_and_policy_review_status. Allowed values — `APPROVAL_STATUS_UNSPECIFIED`: Type value is not specified or is unknown in this version.; `APPROVAL_STATUS_PENDING_NOT_SERVABLE`: The creative is still under review and not servable.; `APPROVAL_STATUS_PENDING_SERVABLE`: The creative has passed creative & landing page review and is servable, but is awaiting additional content & policy review.; `APPROVAL_STATUS_APPROVED_SERVABLE`: Both creative & landing page review and content & policy review are approved. The creative is servable.; `APPROVAL_STATUS_REJECTED_NOT_SERVABLE`: There is an issue with the creative that must be fixed before it can serve.' enum: - APPROVAL_STATUS_UNSPECIFIED - APPROVAL_STATUS_PENDING_NOT_SERVABLE - APPROVAL_STATUS_PENDING_SERVABLE - APPROVAL_STATUS_APPROVED_SERVABLE - APPROVAL_STATUS_REJECTED_NOT_SERVABLE contentAndPolicyReviewStatus: type: string description: 'Content and policy review status for the creative. Allowed values — `REVIEW_STATUS_UNSPECIFIED`: Type value is not specified or is unknown in this version.; `REVIEW_STATUS_APPROVED`: The creative is approved.; `REVIEW_STATUS_REJECTED`: The creative is rejected.; `REVIEW_STATUS_PENDING`: The creative is pending review.' enum: - REVIEW_STATUS_UNSPECIFIED - REVIEW_STATUS_APPROVED - REVIEW_STATUS_REJECTED - REVIEW_STATUS_PENDING exchangeReviewStatuses: type: array description: Exchange review statuses for the creative. items: $ref: '#/components/schemas/ExchangeReviewStatus' ScriptError: type: object description: An error message for a custom bidding script. properties: column: type: string format: int64 description: The column number in the script where the error was thrown. line: type: string format: int64 description: The line number in the script where the error was thrown. errorMessage: type: string description: The detailed error message. errorCode: type: string description: 'The type of error. Allowed values — `ERROR_CODE_UNSPECIFIED`: The script error is not specified or is unknown in this version.; `SYNTAX_ERROR`: The script has a syntax error.; `DEPRECATED_SYNTAX`: The script uses deprecated syntax.; `INTERNAL_ERROR`: Internal errors were thrown while processing the script.' enum: - ERROR_CODE_UNSPECIFIED - SYNTAX_ERROR - DEPRECATED_SYNTAX - INTERNAL_ERROR SdfConfig: type: object description: Structured Data File (SDF) related settings. properties: version: type: string description: 'Required. The version of SDF being used. Allowed values — `SDF_VERSION_UNSPECIFIED`: SDF version value is not specified or is unknown in this version.; `SDF_VERSION_3_1`: SDF version 3.1; `SDF_VERSION_4`: SDF version 4; `SDF_VERSION_4_1`: SDF version 4.1; `SDF_VERSION_4_2`: SDF version 4.2; `SDF_VERSION_5`: SDF version 5.; `SDF_VERSION_5_1`: SDF version 5.1; `SDF_VERSION_5_2`: SDF version 5.2; `SDF_VERSION_5_3`: SDF version 5.3; `SDF_VERSION_5_4`: SDF version 5.4; `SDF_VERSION_5_5`: SDF version 5.5; `SDF_VERSION_6`: SDF version 6; `SDF_VERSION_7`: SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.; `SDF_VERSION_7_1`: SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.; `SDF_VERSION_8`: SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.; `SDF_VERSION_8_1`: SDF version 8.1.; `SDF_VERSION_9`: SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.; `SDF_VERSION_9_1`: SDF version 9.1.; `SDF_VERSION_9_2`: SDF version 9.2.; `SDF_VERSION_10`: SDF version 10.; `SDF_VERSION_10_1`: SDF version 10.1.' 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 - SDF_VERSION_5_2 - SDF_VERSION_5_3 - SDF_VERSION_5_4 - SDF_VERSION_5_5 - SDF_VERSION_6 - SDF_VERSION_7 - SDF_VERSION_7_1 - SDF_VERSION_8 - SDF_VERSION_8_1 - SDF_VERSION_9 - SDF_VERSION_9_1 - SDF_VERSION_9_2 - SDF_VERSION_10 - SDF_VERSION_10_1 adminEmail: type: string description: An administrator email address to which the SDF processing status reports will be sent. SearchTargetingOptionsRequest: type: object description: Request message for SearchTargetingOptions. properties: pageToken: type: string description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `SearchTargetingOptions` method. If not specified, the first page of results will be returned. poiSearchTerms: $ref: '#/components/schemas/PoiSearchTerms' pageSize: type: integer format: int32 description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. geoRegionSearchTerms: $ref: '#/components/schemas/GeoRegionSearchTerms' businessChainSearchTerms: $ref: '#/components/schemas/BusinessChainSearchTerms' advertiserId: type: string format: int64 description: Required. The Advertiser this request is being made in the context of. SearchTargetingOptionsResponse: type: object description: Response message for SearchTargetingOptions. properties: targetingOptions: type: array description: The list of targeting options that match the search criteria. This list will be absent if empty. items: $ref: '#/components/schemas/TargetingOption' nextPageToken: type: string description: A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `SearchTargetingOptions` method to retrieve the next page of results. SelectedInventories: type: object description: The inventory control of the ad group. properties: allowDiscover: type: boolean description: Whether the ad group is opted-in to Discover inventory. allowYoutubeShorts: type: boolean description: Whether the ad group is opted-in to YouTube shorts inventory. allowGmail: type: boolean description: Whether the ad group is opted-in to Gmail inventory. allowYoutubeStream: type: boolean description: Whether the ad group is opted-in to YouTube in-stream inventory. allowYoutubeFeed: type: boolean description: Whether the ad group is opted-in to YouTube in-feed inventory. allowGoogleDisplayNetwork: type: boolean description: Whether the ad group is opted-in to Google Display Network inventory. SensitiveCategoryAssignedTargetingOptionDetails: type: object description: Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. properties: excludedSensitiveCategory: type: string description: 'Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. Allowed values — `SENSITIVE_CATEGORY_UNSPECIFIED`: This enum is only a placeholder and doesn''t specify a DV360 sensitive category.; `SENSITIVE_CATEGORY_ADULT`: Adult or pornographic text, image, or video content.; `SENSITIVE_CATEGORY_DEROGATORY`: Content that may be construed as biased against individuals, groups, or organizations based on criteria such as race, religion, disability, sex, age, veteran status, sexual orientation, gender identity, or political affiliation. May also indicate discussion of such content, for instance, in an academic or journalistic context.; `SENSITIVE_CATEGORY_DOWNLOADS_SHARING`: Content related to audio, video, or software downloads.; `SENSITIVE_CATEGORY_WEAPONS`: Contains content related to personal weapons, including knives, guns, small firearms, and ammunition. Selecting either "weapons" or "sensitive social issues" will result in selecting both.; `SENSITIVE_CATEGORY_GAMBLING`: Contains content related to betting or wagering in a real-world or online setting.; `SENSITIVE_CATEGORY_VIOLENCE`: Content which may be considered graphically violent, gory, gruesome, or shocking, such as street fighting videos, accident photos, descriptions of torture, etc.; `SENSITIVE_CATEGORY_SUGGESTIVE`: Adult content, as well as suggestive content that''s not explicitly pornographic. This category includes all pages categorized as adult.; `SENSITIVE_CATEGORY_PROFANITY`: Prominent use of words considered indecent, such as curse words and sexual slang. Pages with only very occasional usage, such as news sites that might include such words in a quotation, are not included.; `SENSITIVE_CATEGORY_ALCOHOL`: Contains content related to alcoholic beverages, alcohol brands, recipes, etc.; `SENSITIVE_CATEGORY_DRUGS`: Contains content related to the recreational use of legal or illegal drugs, as well as to drug paraphernalia or cultivation.; `SENSITIVE_CATEGORY_TOBACCO`: Contains content related to tobacco and tobacco accessories, including lighters, humidors, ashtrays, etc.; `SENSITIVE_CATEGORY_POLITICS`: Political news and media, including discussions of social, governmental, and public policy.; `SENSITIVE_CATEGORY_RELIGION`: Content related to religious thought or beliefs.; `SENSITIVE_CATEGORY_TRAGEDY`: Content related to death, disasters, accidents, war, etc.; `SENSITIVE_CATEGORY_TRANSPORTATION_ACCIDENTS`: Content related to motor vehicle, aviation or other transportation accidents.; `SENSITIVE_CATEGORY_SENSITIVE_SOCIAL_ISSUES`: Issues that evoke strong, opposing views and spark debate. These include issues that are controversial in most countries and markets (such as abortion), as well as those that are controversial in specific countries and markets (such as immigration reform in the United States).; `SENSITIVE_CATEGORY_SHOCKING`: Content which may be considered shocking or disturbing, such as violent news stories, stunts, or toilet humor.; `SENSITIVE_CATEGORY_EMBEDDED_VIDEO`: YouTube videos embedded on websites outside of YouTube.com.; `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`: Video of live events streamed over the internet.' 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 - SENSITIVE_CATEGORY_EMBEDDED_VIDEO - SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO SensitiveCategoryTargetingOptionDetails: type: object description: Represents a targetable sensitive category. This will be populated in the sensitive_category_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. properties: sensitiveCategory: type: string description: 'Output only. An enum for the DV360 Sensitive category content classifier. Allowed values — `SENSITIVE_CATEGORY_UNSPECIFIED`: This enum is only a placeholder and doesn''t specify a DV360 sensitive category.; `SENSITIVE_CATEGORY_ADULT`: Adult or pornographic text, image, or video content.; `SENSITIVE_CATEGORY_DEROGATORY`: Content that may be construed as biased against individuals, groups, or organizations based on criteria such as race, religion, disability, sex, age, veteran status, sexual orientation, gender identity, or political affiliation. May also indicate discussion of such content, for instance, in an academic or journalistic context.; `SENSITIVE_CATEGORY_DOWNLOADS_SHARING`: Content related to audio, video, or software downloads.; `SENSITIVE_CATEGORY_WEAPONS`: Contains content related to personal weapons, including knives, guns, small firearms, and ammunition. Selecting either "weapons" or "sensitive social issues" will result in selecting both.; `SENSITIVE_CATEGORY_GAMBLING`: Contains content related to betting or wagering in a real-world or online setting.; `SENSITIVE_CATEGORY_VIOLENCE`: Content which may be considered graphically violent, gory, gruesome, or shocking, such as street fighting videos, accident photos, descriptions of torture, etc.; `SENSITIVE_CATEGORY_SUGGESTIVE`: Adult content, as well as suggestive content that''s not explicitly pornographic. This category includes all pages categorized as adult.; `SENSITIVE_CATEGORY_PROFANITY`: Prominent use of words considered indecent, such as curse words and sexual slang. Pages with only very occasional usage, such as news sites that might include such words in a quotation, are not included.; `SENSITIVE_CATEGORY_ALCOHOL`: Contains content related to alcoholic beverages, alcohol brands, recipes, etc.; `SENSITIVE_CATEGORY_DRUGS`: Contains content related to the recreational use of legal or illegal drugs, as well as to drug paraphernalia or cultivation.; `SENSITIVE_CATEGORY_TOBACCO`: Contains content related to tobacco and tobacco accessories, including lighters, humidors, ashtrays, etc.; `SENSITIVE_CATEGORY_POLITICS`: Political news and media, including discussions of social, governmental, and public policy.; `SENSITIVE_CATEGORY_RELIGION`: Content related to religious thought or beliefs.; `SENSITIVE_CATEGORY_TRAGEDY`: Content related to death, disasters, accidents, war, etc.; `SENSITIVE_CATEGORY_TRANSPORTATION_ACCIDENTS`: Content related to motor vehicle, aviation or other transportation accidents.; `SENSITIVE_CATEGORY_SENSITIVE_SOCIAL_ISSUES`: Issues that evoke strong, opposing views and spark debate. These include issues that are controversial in most countries and markets (such as abortion), as well as those that are controversial in specific countries and markets (such as immigration reform in the United States).; `SENSITIVE_CATEGORY_SHOCKING`: Content which may be considered shocking or disturbing, such as violent news stories, stunts, or toilet humor.; `SENSITIVE_CATEGORY_EMBEDDED_VIDEO`: YouTube videos embedded on websites outside of YouTube.com.; `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`: Video of live events streamed over the internet.' 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 - SENSITIVE_CATEGORY_EMBEDDED_VIDEO - SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO readOnly: true SessionPositionAssignedTargetingOptionDetails: type: object description: Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. properties: sessionPosition: type: string description: 'The position where the ad will show in a session. Allowed values — `SESSION_POSITION_UNSPECIFIED`: This is a placeholder, does not indicate any positions.; `SESSION_POSITION_FIRST_IMPRESSION`: The first impression of the session.' enum: - SESSION_POSITION_UNSPECIFIED - SESSION_POSITION_FIRST_IMPRESSION Site: type: object description: A single site. Sites are apps or websites belonging to a channel. properties: name: type: string description: Output only. The resource name of the site. readOnly: true urlOrAppId: type: string description: Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes. Status: type: object description: 'The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).' properties: message: type: string description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. code: type: integer format: int32 description: The status code, which should be an enum value of google.rpc.Code. details: type: array description: A list of messages that carry the error details. There is a common set of message types for APIs to use. items: type: object additionalProperties: description: Properties of the object. Contains field @type with type URL. SubExchangeAssignedTargetingOptionDetails: type: object description: Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. properties: targetingOptionId: type: string description: Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`. SubExchangeTargetingOptionDetails: type: object description: Represents a targetable sub-exchange. This will be populated in the sub_exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. properties: displayName: type: string description: Output only. The display name of the sub-exchange. readOnly: true SurfaceTargetingCombination: type: object description: A valid combination of surfaces. properties: choices: type: array description: Output only. The combination of surfaces. readOnly: true items: type: string enum: - PLANNABLE_SURFACE_UNSPECIFIED - PLANNABLE_SURFACE_IN_FEED - PLANNABLE_SURFACE_IN_STREAM_BUMPER - PLANNABLE_SURFACE_IN_STREAM_NON_SKIPPABLE - PLANNABLE_SURFACE_IN_STREAM_SKIPPABLE - PLANNABLE_SURFACE_SHORTS - PLANNABLE_SURFACE_DISCOVER_FEED - PLANNABLE_SURFACE_GMAIL - PLANNABLE_SURFACE_GOOGLE_DISPLAY_NETWORK - PLANNABLE_SURFACE_IN_STREAM_NON_SKIPPABLE_THIRTY_SECONDS description: 'Allowed values — `PLANNABLE_SURFACE_UNSPECIFIED`: Not specified.; `PLANNABLE_SURFACE_IN_FEED`: In-feed.; `PLANNABLE_SURFACE_IN_STREAM_BUMPER`: In-stream bumper.; `PLANNABLE_SURFACE_IN_STREAM_NON_SKIPPABLE`: In-stream non-skippable.; `PLANNABLE_SURFACE_IN_STREAM_SKIPPABLE`: In-stream skippable.; `PLANNABLE_SURFACE_SHORTS`: Shorts.; `PLANNABLE_SURFACE_DISCOVER_FEED`: Discover feed.; `PLANNABLE_SURFACE_GMAIL`: Gmail.; `PLANNABLE_SURFACE_GOOGLE_DISPLAY_NETWORK`: Google Display Network.; `PLANNABLE_SURFACE_IN_STREAM_NON_SKIPPABLE_THIRTY_SECONDS`: In-stream non-skippable (30 seconds).' SurfaceTargetingCombinations: type: object description: Surface targeting rules. properties: availableSurfaceTypes: type: array description: Output only. The surface types available. readOnly: true items: type: string enum: - PLANNABLE_SURFACE_UNSPECIFIED - PLANNABLE_SURFACE_IN_FEED - PLANNABLE_SURFACE_IN_STREAM_BUMPER - PLANNABLE_SURFACE_IN_STREAM_NON_SKIPPABLE - PLANNABLE_SURFACE_IN_STREAM_SKIPPABLE - PLANNABLE_SURFACE_SHORTS - PLANNABLE_SURFACE_DISCOVER_FEED - PLANNABLE_SURFACE_GMAIL - PLANNABLE_SURFACE_GOOGLE_DISPLAY_NETWORK - PLANNABLE_SURFACE_IN_STREAM_NON_SKIPPABLE_THIRTY_SECONDS description: 'Allowed values — `PLANNABLE_SURFACE_UNSPECIFIED`: Not specified.; `PLANNABLE_SURFACE_IN_FEED`: In-feed.; `PLANNABLE_SURFACE_IN_STREAM_BUMPER`: In-stream bumper.; `PLANNABLE_SURFACE_IN_STREAM_NON_SKIPPABLE`: In-stream non-skippable.; `PLANNABLE_SURFACE_IN_STREAM_SKIPPABLE`: In-stream skippable.; `PLANNABLE_SURFACE_SHORTS`: Shorts.; `PLANNABLE_SURFACE_DISCOVER_FEED`: Discover feed.; `PLANNABLE_SURFACE_GMAIL`: Gmail.; `PLANNABLE_SURFACE_GOOGLE_DISPLAY_NETWORK`: Google Display Network.; `PLANNABLE_SURFACE_IN_STREAM_NON_SKIPPABLE_THIRTY_SECONDS`: In-stream non-skippable (30 seconds).' validSurfaceCombinations: type: array description: Output only. Valid combinations of surfaces that can be selected together. readOnly: true items: $ref: '#/components/schemas/SurfaceTargetingCombination' defaultSurfaceTypes: type: array description: Output only. The default surface types for this product. readOnly: true items: type: string enum: - PLANNABLE_SURFACE_UNSPECIFIED - PLANNABLE_SURFACE_IN_FEED - PLANNABLE_SURFACE_IN_STREAM_BUMPER - PLANNABLE_SURFACE_IN_STREAM_NON_SKIPPABLE - PLANNABLE_SURFACE_IN_STREAM_SKIPPABLE - PLANNABLE_SURFACE_SHORTS - PLANNABLE_SURFACE_DISCOVER_FEED - PLANNABLE_SURFACE_GMAIL - PLANNABLE_SURFACE_GOOGLE_DISPLAY_NETWORK - PLANNABLE_SURFACE_IN_STREAM_NON_SKIPPABLE_THIRTY_SECONDS description: 'Allowed values — `PLANNABLE_SURFACE_UNSPECIFIED`: Not specified.; `PLANNABLE_SURFACE_IN_FEED`: In-feed.; `PLANNABLE_SURFACE_IN_STREAM_BUMPER`: In-stream bumper.; `PLANNABLE_SURFACE_IN_STREAM_NON_SKIPPABLE`: In-stream non-skippable.; `PLANNABLE_SURFACE_IN_STREAM_SKIPPABLE`: In-stream skippable.; `PLANNABLE_SURFACE_SHORTS`: Shorts.; `PLANNABLE_SURFACE_DISCOVER_FEED`: Discover feed.; `PLANNABLE_SURFACE_GMAIL`: Gmail.; `PLANNABLE_SURFACE_GOOGLE_DISPLAY_NETWORK`: Google Display Network.; `PLANNABLE_SURFACE_IN_STREAM_NON_SKIPPABLE_THIRTY_SECONDS`: In-stream non-skippable (30 seconds).' SurfaceTargetingSettings: type: object description: Surface targeting selection. properties: surfaces: type: array description: Optional. The surfaces to target. items: type: string enum: - PLANNABLE_SURFACE_UNSPECIFIED - PLANNABLE_SURFACE_IN_FEED - PLANNABLE_SURFACE_IN_STREAM_BUMPER - PLANNABLE_SURFACE_IN_STREAM_NON_SKIPPABLE - PLANNABLE_SURFACE_IN_STREAM_SKIPPABLE - PLANNABLE_SURFACE_SHORTS - PLANNABLE_SURFACE_DISCOVER_FEED - PLANNABLE_SURFACE_GMAIL - PLANNABLE_SURFACE_GOOGLE_DISPLAY_NETWORK - PLANNABLE_SURFACE_IN_STREAM_NON_SKIPPABLE_THIRTY_SECONDS description: 'Allowed values — `PLANNABLE_SURFACE_UNSPECIFIED`: Not specified.; `PLANNABLE_SURFACE_IN_FEED`: In-feed.; `PLANNABLE_SURFACE_IN_STREAM_BUMPER`: In-stream bumper.; `PLANNABLE_SURFACE_IN_STREAM_NON_SKIPPABLE`: In-stream non-skippable.; `PLANNABLE_SURFACE_IN_STREAM_SKIPPABLE`: In-stream skippable.; `PLANNABLE_SURFACE_SHORTS`: Shorts.; `PLANNABLE_SURFACE_DISCOVER_FEED`: Discover feed.; `PLANNABLE_SURFACE_GMAIL`: Gmail.; `PLANNABLE_SURFACE_GOOGLE_DISPLAY_NETWORK`: Google Display Network.; `PLANNABLE_SURFACE_IN_STREAM_NON_SKIPPABLE_THIRTY_SECONDS`: In-stream non-skippable (30 seconds).' TargetFrequency: type: object description: Setting that controls the average number of times the ads will show to the same person over a certain period of time. properties: targetCount: type: string format: int64 description: The target number of times, on average, the ads will be shown to the same person in the timespan dictated by time_unit and time_unit_count. timeUnit: type: string description: 'The unit of time in which the target frequency will be applied. The following time unit is applicable: * `TIME_UNIT_WEEKS` Allowed values — `TIME_UNIT_UNSPECIFIED`: Time unit value is not specified or is unknown in this version.; `TIME_UNIT_LIFETIME`: The frequency cap will be applied to the whole life time of the line item.; `TIME_UNIT_MONTHS`: The frequency cap will be applied to a number of months.; `TIME_UNIT_WEEKS`: The frequency cap will be applied to a number of weeks.; `TIME_UNIT_DAYS`: The frequency cap will be applied to a number of days.; `TIME_UNIT_HOURS`: The frequency cap will be applied to a number of hours.; `TIME_UNIT_MINUTES`: The frequency cap will be applied to a number of minutes.' enum: - TIME_UNIT_UNSPECIFIED - TIME_UNIT_LIFETIME - TIME_UNIT_MONTHS - TIME_UNIT_WEEKS - TIME_UNIT_DAYS - TIME_UNIT_HOURS - TIME_UNIT_MINUTES timeUnitCount: type: integer format: int32 description: 'The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1' Targeting: type: object description: Targeting settings for a planned campaign. properties: plannableLocationIds: type: array description: Required. IDs of plannable locations to target. Plannable locations can be retrieved using the `RetrievePlannableLocations` method. items: type: string format: int64 genders: type: array description: Optional. The gender options to target. items: type: string enum: - GENDER_UNSPECIFIED - GENDER_MALE - GENDER_FEMALE - GENDER_UNKNOWN description: 'Allowed values — `GENDER_UNSPECIFIED`: Default value when gender is not specified in this version. This enum is a place holder for default value and does not represent a real gender option.; `GENDER_MALE`: The audience gender is male.; `GENDER_FEMALE`: The audience gender is female.; `GENDER_UNKNOWN`: The audience gender is unknown.' devices: type: array description: Optional. The devices to target. items: type: string enum: - DEVICE_TYPE_UNSPECIFIED - DEVICE_TYPE_COMPUTER - DEVICE_TYPE_CONNECTED_TV - DEVICE_TYPE_SMART_PHONE - DEVICE_TYPE_TABLET - DEVICE_TYPE_CONNECTED_DEVICE description: 'Allowed values — `DEVICE_TYPE_UNSPECIFIED`: Default value when device type is not specified in this version. This enum is a placeholder for default value and does not represent a real device type option.; `DEVICE_TYPE_COMPUTER`: Computer.; `DEVICE_TYPE_CONNECTED_TV`: Connected TV.; `DEVICE_TYPE_SMART_PHONE`: Smart phone.; `DEVICE_TYPE_TABLET`: Tablet.; `DEVICE_TYPE_CONNECTED_DEVICE`: Connected device.' ageRange: type: string description: 'Optional. The age range to target. Allowed values — `PLANNABLE_AGE_RANGE_UNSPECIFIED`: Not specified.; `PLANNABLE_AGE_RANGE_18_24`: 18 to 24 years old.; `PLANNABLE_AGE_RANGE_18_34`: 18 to 34 years old.; `PLANNABLE_AGE_RANGE_18_44`: 18 to 44 years old.; `PLANNABLE_AGE_RANGE_18_49`: 18 to 49 years old.; `PLANNABLE_AGE_RANGE_18_54`: 18 to 54 years old.; `PLANNABLE_AGE_RANGE_18_64`: 18 to 64 years old.; `PLANNABLE_AGE_RANGE_18_65_UP`: 18 to 65+ years old.; `PLANNABLE_AGE_RANGE_21_34`: 21 to 34 years old.; `PLANNABLE_AGE_RANGE_21_44`: 21 to 44 years old.; `PLANNABLE_AGE_RANGE_21_49`: 21 to 49 years old.; `PLANNABLE_AGE_RANGE_21_54`: 21 to 54 years old.; `PLANNABLE_AGE_RANGE_21_64`: 21 to 64 years old.; `PLANNABLE_AGE_RANGE_21_65_UP`: 21 to 65+ years old.; `PLANNABLE_AGE_RANGE_25_34`: 25 to 34 years old.; `PLANNABLE_AGE_RANGE_25_44`: 25 to 44 years old.; `PLANNABLE_AGE_RANGE_25_49`: 25 to 49 years old.; `PLANNABLE_AGE_RANGE_25_54`: 25 to 54 years old.; `PLANNABLE_AGE_RANGE_25_64`: 25 to 64 years old.; `PLANNABLE_AGE_RANGE_25_65_UP`: 25 to 65+ years old.; `PLANNABLE_AGE_RANGE_35_44`: 35 to 44 years old.; `PLANNABLE_AGE_RANGE_35_49`: 35 to 49 years old.; `PLANNABLE_AGE_RANGE_35_54`: 35 to 54 years old.; `PLANNABLE_AGE_RANGE_35_64`: 35 to 64 years old.; `PLANNABLE_AGE_RANGE_35_65_UP`: 35 to 65+ years old.; `PLANNABLE_AGE_RANGE_45_54`: 45 to 54 years old.; `PLANNABLE_AGE_RANGE_45_64`: 45 to 64 years old.; `PLANNABLE_AGE_RANGE_45_65_UP`: 45 to 65+ years old.; `PLANNABLE_AGE_RANGE_50_65_UP`: 50 to 65+ years old.; `PLANNABLE_AGE_RANGE_55_64`: 55 to 64 years old.; `PLANNABLE_AGE_RANGE_55_65_UP`: 55 to 65+ years old.; `PLANNABLE_AGE_RANGE_65_UP`: 65+ years old.' enum: - PLANNABLE_AGE_RANGE_UNSPECIFIED - PLANNABLE_AGE_RANGE_18_24 - PLANNABLE_AGE_RANGE_18_34 - PLANNABLE_AGE_RANGE_18_44 - PLANNABLE_AGE_RANGE_18_49 - PLANNABLE_AGE_RANGE_18_54 - PLANNABLE_AGE_RANGE_18_64 - PLANNABLE_AGE_RANGE_18_65_UP - PLANNABLE_AGE_RANGE_21_34 - PLANNABLE_AGE_RANGE_21_44 - PLANNABLE_AGE_RANGE_21_49 - PLANNABLE_AGE_RANGE_21_54 - PLANNABLE_AGE_RANGE_21_64 - PLANNABLE_AGE_RANGE_21_65_UP - PLANNABLE_AGE_RANGE_25_34 - PLANNABLE_AGE_RANGE_25_44 - PLANNABLE_AGE_RANGE_25_49 - PLANNABLE_AGE_RANGE_25_54 - PLANNABLE_AGE_RANGE_25_64 - PLANNABLE_AGE_RANGE_25_65_UP - PLANNABLE_AGE_RANGE_35_44 - PLANNABLE_AGE_RANGE_35_49 - PLANNABLE_AGE_RANGE_35_54 - PLANNABLE_AGE_RANGE_35_64 - PLANNABLE_AGE_RANGE_35_65_UP - PLANNABLE_AGE_RANGE_45_54 - PLANNABLE_AGE_RANGE_45_64 - PLANNABLE_AGE_RANGE_45_65_UP - PLANNABLE_AGE_RANGE_50_65_UP - PLANNABLE_AGE_RANGE_55_64 - PLANNABLE_AGE_RANGE_55_65_UP - PLANNABLE_AGE_RANGE_65_UP TargetingExpansionConfig: type: object description: Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. properties: audienceExpansionSeedListExcluded: type: boolean description: Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. readOnly: true audienceExpansionLevel: type: string description: 'Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. Allowed values — `UNKNOWN`: Audience expansion level is not specified or is unknown in this version.; `NO_REACH`: Audience expansion off.; `LEAST_REACH`: Conservative audience expansion.; `MID_REACH`: Moderate audience expansion.; `MOST_REACH`: Aggressive audience expansion.' enum: - UNKNOWN - NO_REACH - LEAST_REACH - MID_REACH - MOST_REACH readOnly: true excludeDemographicExpansion: type: boolean description: Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. enableOptimizedTargeting: type: boolean description: 'Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`.' TargetingOption: type: object description: Represents a single targeting option, which is a targetable concept in DV360. properties: contentDurationDetails: $ref: '#/components/schemas/ContentDurationTargetingOptionDetails' viewabilityDetails: $ref: '#/components/schemas/ViewabilityTargetingOptionDetails' exchangeDetails: $ref: '#/components/schemas/ExchangeTargetingOptionDetails' omidDetails: $ref: '#/components/schemas/OmidTargetingOptionDetails' browserDetails: $ref: '#/components/schemas/BrowserTargetingOptionDetails' contentOutstreamPositionDetails: $ref: '#/components/schemas/ContentOutstreamPositionTargetingOptionDetails' videoPlayerSizeDetails: $ref: '#/components/schemas/VideoPlayerSizeTargetingOptionDetails' genderDetails: $ref: '#/components/schemas/GenderTargetingOptionDetails' categoryDetails: $ref: '#/components/schemas/CategoryTargetingOptionDetails' targetingOptionId: type: string description: Output only. A unique identifier for this targeting option. The tuple {`targeting_type`, `targeting_option_id`} will be unique. readOnly: true geoRegionDetails: $ref: '#/components/schemas/GeoRegionTargetingOptionDetails' environmentDetails: $ref: '#/components/schemas/EnvironmentTargetingOptionDetails' subExchangeDetails: $ref: '#/components/schemas/SubExchangeTargetingOptionDetails' contentThemeDetails: $ref: '#/components/schemas/ContentThemeTargetingOptionDetails' languageDetails: $ref: '#/components/schemas/LanguageTargetingOptionDetails' nativeContentPositionDetails: $ref: '#/components/schemas/NativeContentPositionTargetingOptionDetails' digitalContentLabelDetails: $ref: '#/components/schemas/DigitalContentLabelTargetingOptionDetails' appCategoryDetails: $ref: '#/components/schemas/AppCategoryTargetingOptionDetails' poiDetails: $ref: '#/components/schemas/PoiTargetingOptionDetails' parentalStatusDetails: $ref: '#/components/schemas/ParentalStatusTargetingOptionDetails' contentGenreDetails: $ref: '#/components/schemas/ContentGenreTargetingOptionDetails' audioContentTypeDetails: $ref: '#/components/schemas/AudioContentTypeTargetingOptionDetails' operatingSystemDetails: $ref: '#/components/schemas/OperatingSystemTargetingOptionDetails' deviceMakeModelDetails: $ref: '#/components/schemas/DeviceMakeModelTargetingOptionDetails' targetingType: type: string description: 'Output only. The type of this targeting option. Allowed values — `TARGETING_TYPE_UNSPECIFIED`: Default value when type is not specified or is unknown in this version.; `TARGETING_TYPE_CHANNEL`: Target a channel (a custom group of related websites or apps).; `TARGETING_TYPE_APP_CATEGORY`: Target an app category (for example, education or puzzle games).; `TARGETING_TYPE_APP`: Target a specific app (for example, Angry Birds).; `TARGETING_TYPE_URL`: Target a specific url (for example, quora.com).; `TARGETING_TYPE_DAY_AND_TIME`: Target ads during a chosen time period on a specific day.; `TARGETING_TYPE_AGE_RANGE`: Target ads to a specific age range (for example, 18-24).; `TARGETING_TYPE_REGIONAL_LOCATION_LIST`: Target ads to the specified regions on a regional location list.; `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`: Target ads to the specified points of interest on a proximity location list.; `TARGETING_TYPE_GENDER`: Target ads to a specific gender (for example, female or male).; `TARGETING_TYPE_VIDEO_PLAYER_SIZE`: Target a specific video player size for video ads.; `TARGETING_TYPE_USER_REWARDED_CONTENT`: Target user rewarded content for video ads.; `TARGETING_TYPE_PARENTAL_STATUS`: Target ads to a specific parental status (for example, parent or not a parent).; `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`: Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).; `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`: Target ads in a specific content outstream position.; `TARGETING_TYPE_DEVICE_TYPE`: Target ads to a specific device type (for example, tablet or connected TV).; `TARGETING_TYPE_AUDIENCE_GROUP`: Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.; `TARGETING_TYPE_BROWSER`: Target ads to specific web browsers (for example, Chrome).; `TARGETING_TYPE_HOUSEHOLD_INCOME`: Target ads to a specific household income range (for example, top 10%).; `TARGETING_TYPE_ON_SCREEN_POSITION`: Target ads in a specific on screen position.; `TARGETING_TYPE_THIRD_PARTY_VERIFIER`: Filter web sites through third party verification (for example, IAS or DoubleVerify).; `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`: Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).; `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`: Filter website content by sensitive categories (for example, adult).; `TARGETING_TYPE_ENVIRONMENT`: Target ads to a specific environment (for example, web or app).; `TARGETING_TYPE_CARRIER_AND_ISP`: Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).; `TARGETING_TYPE_OPERATING_SYSTEM`: Target ads to a specific operating system (for example, macOS).; `TARGETING_TYPE_DEVICE_MAKE_MODEL`: Target ads to a specific device make or model (for example, Roku or Samsung).; `TARGETING_TYPE_KEYWORD`: Target ads to a specific keyword (for example, dog or retriever).; `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`: Target ads to a specific negative keyword list.; `TARGETING_TYPE_VIEWABILITY`: Target ads to a specific viewability (for example, 80% viewable).; `TARGETING_TYPE_CATEGORY`: Target ads to a specific content category (for example, arts & entertainment).; `TARGETING_TYPE_INVENTORY_SOURCE`: Purchase impressions from specific deals and auction packages.; `TARGETING_TYPE_LANGUAGE`: Target ads to a specific language (for example, English or Japanese).; `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`: Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.; `TARGETING_TYPE_GEO_REGION`: Target ads to a specific regional location (for example, a city or state).; `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`: Purchase impressions from a group of deals and auction packages.; `TARGETING_TYPE_EXCHANGE`: Purchase impressions from specific exchanges.; `TARGETING_TYPE_SUB_EXCHANGE`: Purchase impressions from specific sub-exchanges.; `TARGETING_TYPE_POI`: Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.; `TARGETING_TYPE_BUSINESS_CHAIN`: Target ads around locations of a business chain within a specific geo region.; `TARGETING_TYPE_CONTENT_DURATION`: Target ads to a specific video content duration.; `TARGETING_TYPE_CONTENT_STREAM_TYPE`: Target ads to a specific video content stream type.; `TARGETING_TYPE_NATIVE_CONTENT_POSITION`: Target ads to a specific native content position.; `TARGETING_TYPE_OMID`: Target ads in an Open Measurement enabled inventory.; `TARGETING_TYPE_AUDIO_CONTENT_TYPE`: Target ads to a specific audio content type.; `TARGETING_TYPE_CONTENT_GENRE`: Target ads to a specific content genre.; `TARGETING_TYPE_YOUTUBE_VIDEO`: Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_YOUTUBE_CHANNEL`: Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.; `TARGETING_TYPE_SESSION_POSITION`: Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.; `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`: Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.; `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`: Target ads to a specific YouTube channel pack.' 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 - TARGETING_TYPE_POI - TARGETING_TYPE_BUSINESS_CHAIN - TARGETING_TYPE_CONTENT_DURATION - TARGETING_TYPE_CONTENT_STREAM_TYPE - TARGETING_TYPE_NATIVE_CONTENT_POSITION - TARGETING_TYPE_OMID - TARGETING_TYPE_AUDIO_CONTENT_TYPE - TARGETING_TYPE_CONTENT_GENRE - TARGETING_TYPE_YOUTUBE_VIDEO - TARGETING_TYPE_YOUTUBE_CHANNEL - TARGETING_TYPE_SESSION_POSITION - TARGETING_TYPE_CONTENT_THEME_EXCLUSION - TARGETING_TYPE_YOUTUBE_CHANNEL_PACK readOnly: true contentInstreamPositionDetails: $ref: '#/components/schemas/ContentInstreamPositionTargetingOptionDetails' contentStreamTypeDetails: $ref: '#/components/schemas/ContentStreamTypeTargetingOptionDetails' sensitiveCategoryDetails: $ref: '#/components/schemas/SensitiveCategoryTargetingOptionDetails' ageRangeDetails: $ref: '#/components/schemas/AgeRangeTargetingOptionDetails' name: type: string description: Output only. The resource name for this targeting option. readOnly: true onScreenPositionDetails: $ref: '#/components/schemas/OnScreenPositionTargetingOptionDetails' businessChainDetails: $ref: '#/components/schemas/BusinessChainTargetingOptionDetails' carrierAndIspDetails: $ref: '#/components/schemas/CarrierAndIspTargetingOptionDetails' userRewardedContentDetails: $ref: '#/components/schemas/UserRewardedContentTargetingOptionDetails' authorizedSellerStatusDetails: $ref: '#/components/schemas/AuthorizedSellerStatusTargetingOptionDetails' deviceTypeDetails: $ref: '#/components/schemas/DeviceTypeTargetingOptionDetails' householdIncomeDetails: $ref: '#/components/schemas/HouseholdIncomeTargetingOptionDetails' ThirdPartyMeasurementConfigs: type: object description: Settings that control what third-party vendors are measuring specific line item metrics. properties: viewabilityVendorConfigs: type: array description: 'Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS`' items: $ref: '#/components/schemas/ThirdPartyVendorConfig' brandSafetyVendorConfigs: type: array description: 'Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`' items: $ref: '#/components/schemas/ThirdPartyVendorConfig' brandLiftVendorConfigs: type: array description: 'Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL`' items: $ref: '#/components/schemas/ThirdPartyVendorConfig' reachVendorConfigs: type: array description: 'Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS`' items: $ref: '#/components/schemas/ThirdPartyVendorConfig' ThirdPartyOnlyConfig: type: object description: Settings for advertisers that use third-party ad servers only. properties: pixelOrderIdReportingEnabled: type: boolean description: Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`. ThirdPartyUrl: type: object description: Tracking URLs from third parties to track interactions with an audio or a video creative. properties: type: type: string description: 'Optional. The type of interaction needs to be tracked by the tracking URL Allowed values — `THIRD_PARTY_URL_TYPE_UNSPECIFIED`: The type of third-party URL is unspecified or is unknown in this version.; `THIRD_PARTY_URL_TYPE_IMPRESSION`: Used to count impressions of the creative after the audio or video buffering is complete.; `THIRD_PARTY_URL_TYPE_CLICK_TRACKING`: Used to track user clicks on the audio or video.; `THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_START`: Used to track the number of times a user starts the audio or video.; `THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FIRST_QUARTILE`: Used to track the number of times the audio or video plays to 25% of its length.; `THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MIDPOINT`: Used to track the number of times the audio or video plays to 50% of its length.; `THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_THIRD_QUARTILE`: Used to track the number of times the audio or video plays to 75% of its length.; `THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_COMPLETE`: Used to track the number of times the audio or video plays to the end.; `THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MUTE`: Used to track the number of times a user mutes the audio or video.; `THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PAUSE`: Used to track the number of times a user pauses the audio or video.; `THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_REWIND`: Used to track the number of times a user replays the audio or video.; `THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FULLSCREEN`: Used to track the number of times a user expands the player to full-screen size.; `THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_STOP`: Used to track the number of times a user stops the audio or video.; `THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_CUSTOM`: Used to track the number of times a user performs a custom click, such as clicking on a video hot spot.; `THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_SKIP`: Used to track the number of times the audio or video was skipped.; `THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PROGRESS`: Used to track the number of times the audio or video plays to an offset determined by the progress_offset.' 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 url: type: string description: Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path` ThirdPartyVendorConfig: type: object description: Settings that control how third-party measurement vendors are configured. properties: vendor: type: string description: 'The third-party measurement vendor. Allowed values — `THIRD_PARTY_VENDOR_UNSPECIFIED`: Unknown third-party vendor.; `THIRD_PARTY_VENDOR_MOAT`: Moat.; `THIRD_PARTY_VENDOR_DOUBLE_VERIFY`: DoubleVerify.; `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`: Integral Ad Science.; `THIRD_PARTY_VENDOR_COMSCORE`: Comscore.; `THIRD_PARTY_VENDOR_TELEMETRY`: Telemetry.; `THIRD_PARTY_VENDOR_MEETRICS`: Meetrics.; `THIRD_PARTY_VENDOR_ZEFR`: ZEFR.; `THIRD_PARTY_VENDOR_NIELSEN`: Nielsen.; `THIRD_PARTY_VENDOR_KANTAR`: Kantar.; `THIRD_PARTY_VENDOR_DYNATA`: Dynata.; `THIRD_PARTY_VENDOR_TRANSUNION`: Transunion.; `THIRD_PARTY_VENDOR_ORIGIN`: Origin.; `THIRD_PARTY_VENDOR_GEMIUS`: Gemius.; `THIRD_PARTY_VENDOR_MEDIA_SCOPE`: MediaScope.; `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT`: Audience Project.; `THIRD_PARTY_VENDOR_VIDEO_AMP`: Video Amp.; `THIRD_PARTY_VENDOR_ISPOT_TV`: Ispot TV.; `THIRD_PARTY_VENDOR_INTAGE`: Intage.; `THIRD_PARTY_VENDOR_MACROMILL`: Macromill.; `THIRD_PARTY_VENDOR_VIDEO_RESEARCH`: Video Research.' enum: - THIRD_PARTY_VENDOR_UNSPECIFIED - THIRD_PARTY_VENDOR_MOAT - THIRD_PARTY_VENDOR_DOUBLE_VERIFY - THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE - THIRD_PARTY_VENDOR_COMSCORE - THIRD_PARTY_VENDOR_TELEMETRY - THIRD_PARTY_VENDOR_MEETRICS - THIRD_PARTY_VENDOR_ZEFR - THIRD_PARTY_VENDOR_NIELSEN - THIRD_PARTY_VENDOR_KANTAR - THIRD_PARTY_VENDOR_DYNATA - THIRD_PARTY_VENDOR_TRANSUNION - THIRD_PARTY_VENDOR_ORIGIN - THIRD_PARTY_VENDOR_GEMIUS - THIRD_PARTY_VENDOR_MEDIA_SCOPE - THIRD_PARTY_VENDOR_AUDIENCE_PROJECT - THIRD_PARTY_VENDOR_VIDEO_AMP - THIRD_PARTY_VENDOR_ISPOT_TV - THIRD_PARTY_VENDOR_INTAGE - THIRD_PARTY_VENDOR_MACROMILL - THIRD_PARTY_VENDOR_VIDEO_RESEARCH placementId: type: string description: The ID used by the platform of the third-party vendor to identify the line item. ThirdPartyVerifierAssignedTargetingOptionDetails: type: object description: Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. properties: doubleVerify: $ref: '#/components/schemas/DoubleVerify' integralAdScience: $ref: '#/components/schemas/IntegralAdScience' adloox: $ref: '#/components/schemas/Adloox' TimeRange: type: object description: A time range. properties: startTime: type: string format: google-datetime description: Required. The lower bound of a time range, inclusive. endTime: type: string format: google-datetime description: Required. The upper bound of a time range, inclusive. TimerEvent: type: object description: Timer event of the creative. properties: name: type: string description: Required. The name of the timer event. reportingName: type: string description: Required. The name used to identify this timer event in reports. TrackingFloodlightActivityConfig: type: object description: Settings that control the behavior of a single Floodlight activity config. properties: floodlightActivityId: type: string format: int64 description: Required. The ID of the Floodlight activity. postClickLookbackWindowDays: type: integer format: int32 description: Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive. postViewLookbackWindowDays: type: integer format: int32 description: Required. The number of days after an ad has been viewed in which a conversion may be counted. Must be between 0 and 90 inclusive. Transcode: type: object description: Represents information about the transcoded audio or video file. properties: fileSizeBytes: type: string format: int64 description: Optional. The size of the transcoded file, in bytes. transcoded: type: boolean description: Optional. Indicates if the transcoding was successful. frameRate: type: number format: float description: Optional. The frame rate of the transcoded video, in frames per second. audioSampleRateHz: type: string format: int64 description: Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. mimeType: type: string description: Optional. The MIME type of the transcoded file. bitRateKbps: type: string format: int64 description: Optional. The transcoding bit rate of the transcoded video, in kilobits per second. audioBitRateKbps: type: string format: int64 description: Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. name: type: string description: Optional. The name of the transcoded file. dimensions: $ref: '#/components/schemas/Dimensions' UniversalAdId: type: object description: A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. properties: id: type: string description: Optional. The unique creative identifier. registry: type: string description: 'Optional. The registry provides unique creative identifiers. Allowed values — `UNIVERSAL_AD_REGISTRY_UNSPECIFIED`: The Universal Ad registry is unspecified or is unknown in this version.; `UNIVERSAL_AD_REGISTRY_OTHER`: Use a custom provider to provide the Universal Ad ID.; `UNIVERSAL_AD_REGISTRY_AD_ID`: Use Ad-ID to provide the Universal Ad ID.; `UNIVERSAL_AD_REGISTRY_CLEARCAST`: Use clearcast.co.uk to provide the Universal Ad ID.; `UNIVERSAL_AD_REGISTRY_DV360`: Use Display & Video 360 to provide the Universal Ad ID.; `UNIVERSAL_AD_REGISTRY_CM`: Use Campaign Manager 360 to provide the Universal Ad ID.' 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 UploadAdAssetRequest: type: object description: A request message for UploadAdAsset. properties: filename: type: string description: Required. The filename of the ad asset, including the file extension. The filename must be UTF-8 encoded with a maximum size of 240 bytes. syntheticContentAttestationStatus: type: string description: 'Optional. Whether to add a label to the asset as created or edited using AI when served in regions with local AI labeling regulations. Allowed values — `SYNTHETIC_CONTENT_ATTESTATION_STATUS_UNSPECIFIED`: No attestation has been provided.; `NOT_SYNTHETIC`: Attested as not created or edited using AI.; `IS_SYNTHETIC`: Attested as created or edited using AI.' enum: - SYNTHETIC_CONTENT_ATTESTATION_STATUS_UNSPECIFIED - NOT_SYNTHETIC - IS_SYNTHETIC adAssetType: type: string description: 'Required. The type of the ad asset. Only `AD_ASSET_TYPE_IMAGE` is supported. Allowed values — `AD_ASSET_TYPE_UNSPECIFIED`: The ad asset type is unspecified.; `AD_ASSET_TYPE_IMAGE`: The ad asset is a YouTube/DemandGen image.; `AD_ASSET_TYPE_YOUTUBE_VIDEO`: The ad asset is a YouTube video.' enum: - AD_ASSET_TYPE_UNSPECIFIED - AD_ASSET_TYPE_IMAGE - AD_ASSET_TYPE_YOUTUBE_VIDEO UploadAdAssetResponse: type: object description: A response message for UploadAdAsset. properties: adAsset: $ref: '#/components/schemas/AdAsset' UrlAssignedTargetingOptionDetails: type: object description: Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. properties: url: type: string description: Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`. negative: type: boolean description: Indicates if this option is being negatively targeted. User: type: object description: A single user in Display & Video 360. properties: userId: type: string format: int64 description: Output only. The unique ID of the user. Assigned by the system. readOnly: true email: type: string description: Required. Immutable. The email address used to identify the user. name: type: string description: Output only. The resource name of the user. readOnly: true assignedUserRoles: type: array description: The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles. items: $ref: '#/components/schemas/AssignedUserRole' lastLoginTime: type: string format: google-datetime description: Output only. The timestamp when the user last logged in DV360 UI. readOnly: true displayName: type: string description: Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes. UserInterest: type: object description: The identifier for a user interest. properties: userInterestUserList: type: string description: 'Output only. The resource name of the user list. Populated when `product_category` is "Open Auction". Format: customers/{customer_id}/userLists/{user_list_id}' readOnly: true userInterestCategory: type: string description: 'Output only. The resource name of the interest category. Populated when `product_category` is "Youtube". Format: customers/{customer_id}/userInterests/{user_interest_id}' readOnly: true UserRewardedContentAssignedTargetingOptionDetails: type: object description: User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. properties: userRewardedContent: type: string description: 'Output only. User rewarded content status for video ads. Allowed values — `USER_REWARDED_CONTENT_UNSPECIFIED`: User rewarded content is not specified or is unknown in this version.; `USER_REWARDED_CONTENT_USER_REWARDED`: Represents ads where the user will see a reward after viewing.; `USER_REWARDED_CONTENT_NOT_USER_REWARDED`: Represents all other ads besides user-rewarded.' enum: - USER_REWARDED_CONTENT_UNSPECIFIED - USER_REWARDED_CONTENT_USER_REWARDED - USER_REWARDED_CONTENT_NOT_USER_REWARDED readOnly: true targetingOptionId: type: string description: Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. UserRewardedContentTargetingOptionDetails: type: object description: Represents a targetable user rewarded content status for video ads only. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. properties: userRewardedContent: type: string description: 'Output only. User rewarded content status for video ads. Allowed values — `USER_REWARDED_CONTENT_UNSPECIFIED`: User rewarded content is not specified or is unknown in this version.; `USER_REWARDED_CONTENT_USER_REWARDED`: Represents ads where the user will see a reward after viewing.; `USER_REWARDED_CONTENT_NOT_USER_REWARDED`: Represents all other ads besides user-rewarded.' enum: - USER_REWARDED_CONTENT_UNSPECIFIED - USER_REWARDED_CONTENT_USER_REWARDED - USER_REWARDED_CONTENT_NOT_USER_REWARDED readOnly: true VideoAdInventoryControl: type: object description: The video ad inventory control used in certain YouTube line item types. properties: allowInFeed: type: boolean description: Optional. Whether ads can serve as in-feed format. allowShorts: type: boolean description: Optional. Whether ads can serve as shorts format. allowInStream: type: boolean description: Optional. Whether ads can serve as in-stream format. allowNonSkippableInStream: type: boolean description: Optional. Indicates whether ads can serve as non-skippable in-stream format. VideoAdSequenceSettings: type: object description: Settings related to VideoAdSequence. properties: minimumDuration: type: string description: 'The minimum time interval before the same user sees this sequence again. Allowed values — `VIDEO_AD_SEQUENCE_MINIMUM_DURATION_UNSPECIFIED`: Unspecified or unknown.; `VIDEO_AD_SEQUENCE_MINIMUM_DURATION_WEEK`: 7 days.; `VIDEO_AD_SEQUENCE_MINIMUM_DURATION_MONTH`: 30 days.' enum: - VIDEO_AD_SEQUENCE_MINIMUM_DURATION_UNSPECIFIED - VIDEO_AD_SEQUENCE_MINIMUM_DURATION_WEEK - VIDEO_AD_SEQUENCE_MINIMUM_DURATION_MONTH steps: type: array description: The steps of which the sequence consists. items: $ref: '#/components/schemas/VideoAdSequenceStep' VideoAdSequenceStep: type: object description: The detail of a single step in a VideoAdSequence. properties: previousStepId: type: string format: int64 description: The ID of the previous step. The first step does not have previous step. interactionType: type: string description: 'The interaction on the previous step that will lead the viewer to this step. The first step does not have interaction_type. Allowed values — `INTERACTION_TYPE_UNSPECIFIED`: Unspecified or unknown; `INTERACTION_TYPE_PAID_VIEW`: A paid view.; `INTERACTION_TYPE_SKIP`: Skipped by the viewer.; `INTERACTION_TYPE_IMPRESSION`: A (viewed) ad impression.; `INTERACTION_TYPE_ENGAGED_IMPRESSION`: An ad impression that was not immediately skipped by the viewer, but didn''t reach the billable event either.' enum: - INTERACTION_TYPE_UNSPECIFIED - INTERACTION_TYPE_PAID_VIEW - INTERACTION_TYPE_SKIP - INTERACTION_TYPE_IMPRESSION - INTERACTION_TYPE_ENGAGED_IMPRESSION stepId: type: string format: int64 description: The ID of the step. adGroupId: type: string format: int64 description: The ID of the corresponding ad group of the step. VideoDiscoveryAd: type: object description: Details for a video discovery ad. properties: description2: type: string description: Second text line for the ad. video: $ref: '#/components/schemas/YoutubeVideoDetails' headline: type: string description: The headline of ad. thumbnail: type: string description: 'Thumbnail image used in the ad. Allowed values — `THUMBNAIL_UNSPECIFIED`: Unknown or unspecified.; `THUMBNAIL_DEFAULT`: The default thumbnail, can be auto-generated or user-uploaded.; `THUMBNAIL_1`: Thumbnail 1, generated from the video.; `THUMBNAIL_2`: Thumbnail 2, generated from the video.; `THUMBNAIL_3`: Thumbnail 3, generated from the video.' enum: - THUMBNAIL_UNSPECIFIED - THUMBNAIL_DEFAULT - THUMBNAIL_1 - THUMBNAIL_2 - THUMBNAIL_3 description1: type: string description: First text line for the ad. VideoPerformanceAd: type: object description: Details for a video performance ad. properties: headlines: type: array description: The list of headlines shown on the call-to-action banner. items: type: string longHeadlines: type: array description: The list of long headlines shown on the call-to-action banner. items: type: string displayUrlBreadcrumb1: type: string description: The first piece after the domain in the display URL. finalUrl: type: string description: The URL address of the webpage that people reach after they click the ad. videos: type: array description: The list of YouTube video assets used by this ad. items: $ref: '#/components/schemas/YoutubeVideoDetails' trackingUrl: type: string description: The URL address loaded in the background for tracking purposes. displayUrlBreadcrumb2: type: string description: The second piece after the domain in the display URL. domain: type: string description: The domain of the display URL. customParameters: type: object description: The custom parameters and accompanying values to add to the tracking URL. additionalProperties: type: string companionBanners: type: array description: The list of companion banners used by this ad. items: $ref: '#/components/schemas/ImageAsset' actionButtonLabels: type: array description: The list of text assets shown on the call-to-action button. items: type: string descriptions: type: array description: The list of descriptions shown on the call-to-action banner. items: type: string VideoPlayerSizeAssignedTargetingOptionDetails: type: object description: Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. properties: videoPlayerSize: type: string description: 'Required. The video player size. Allowed values — `VIDEO_PLAYER_SIZE_UNSPECIFIED`: Video player size is not specified in this version. This enum is a place holder for a default value and does not represent a real video player size.; `VIDEO_PLAYER_SIZE_SMALL`: The dimensions of the video player are less than 400×300 (desktop), or up to 20% of screen covered (mobile).; `VIDEO_PLAYER_SIZE_LARGE`: The dimensions of the video player are between 400x300 and 1280x720 pixels (desktop), or 20% to 90% of the screen covered (mobile).; `VIDEO_PLAYER_SIZE_HD`: The dimensions of the video player are 1280×720 or greater (desktop), or over 90% of the screen covered (mobile).; `VIDEO_PLAYER_SIZE_UNKNOWN`: The dimensions of the video player are unknown.' enum: - VIDEO_PLAYER_SIZE_UNSPECIFIED - VIDEO_PLAYER_SIZE_SMALL - VIDEO_PLAYER_SIZE_LARGE - VIDEO_PLAYER_SIZE_HD - VIDEO_PLAYER_SIZE_UNKNOWN VideoPlayerSizeTargetingOptionDetails: type: object description: Represents a targetable video player size. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. properties: videoPlayerSize: type: string description: 'Output only. The video player size. Allowed values — `VIDEO_PLAYER_SIZE_UNSPECIFIED`: Video player size is not specified in this version. This enum is a place holder for a default value and does not represent a real video player size.; `VIDEO_PLAYER_SIZE_SMALL`: The dimensions of the video player are less than 400×300 (desktop), or up to 20% of screen covered (mobile).; `VIDEO_PLAYER_SIZE_LARGE`: The dimensions of the video player are between 400x300 and 1280x720 pixels (desktop), or 20% to 90% of the screen covered (mobile).; `VIDEO_PLAYER_SIZE_HD`: The dimensions of the video player are 1280×720 or greater (desktop), or over 90% of the screen covered (mobile).; `VIDEO_PLAYER_SIZE_UNKNOWN`: The dimensions of the video player are unknown.' enum: - VIDEO_PLAYER_SIZE_UNSPECIFIED - VIDEO_PLAYER_SIZE_SMALL - VIDEO_PLAYER_SIZE_LARGE - VIDEO_PLAYER_SIZE_HD - VIDEO_PLAYER_SIZE_UNKNOWN readOnly: true ViewabilityAssignedTargetingOptionDetails: type: object description: Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. properties: viewability: type: string description: 'Required. The predicted viewability percentage. Allowed values — `VIEWABILITY_UNSPECIFIED`: Default value when viewability is not specified in this version. This enum is a placeholder for default value and does not represent a real viewability option.; `VIEWABILITY_10_PERCENT_OR_MORE`: Bid only on impressions that are at least 10% likely to be viewable.; `VIEWABILITY_20_PERCENT_OR_MORE`: Bid only on impressions that are at least 20% likely to be viewable.; `VIEWABILITY_30_PERCENT_OR_MORE`: Bid only on impressions that are at least 30% likely to be viewable.; `VIEWABILITY_40_PERCENT_OR_MORE`: Bid only on impressions that are at least 40% likely to be viewable.; `VIEWABILITY_50_PERCENT_OR_MORE`: Bid only on impressions that are at least 50% likely to be viewable.; `VIEWABILITY_60_PERCENT_OR_MORE`: Bid only on impressions that are at least 60% likely to be viewable.; `VIEWABILITY_70_PERCENT_OR_MORE`: Bid only on impressions that are at least 70% likely to be viewable.; `VIEWABILITY_80_PERCENT_OR_MORE`: Bid only on impressions that are at least 80% likely to be viewable.; `VIEWABILITY_90_PERCENT_OR_MORE`: Bid only on impressions that are at least 90% likely to be viewable.' 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 ViewabilityTargetingOptionDetails: type: object description: Represents a targetable viewability. This will be populated in the viewability_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. properties: viewability: type: string description: 'Output only. The predicted viewability percentage. Allowed values — `VIEWABILITY_UNSPECIFIED`: Default value when viewability is not specified in this version. This enum is a placeholder for default value and does not represent a real viewability option.; `VIEWABILITY_10_PERCENT_OR_MORE`: Bid only on impressions that are at least 10% likely to be viewable.; `VIEWABILITY_20_PERCENT_OR_MORE`: Bid only on impressions that are at least 20% likely to be viewable.; `VIEWABILITY_30_PERCENT_OR_MORE`: Bid only on impressions that are at least 30% likely to be viewable.; `VIEWABILITY_40_PERCENT_OR_MORE`: Bid only on impressions that are at least 40% likely to be viewable.; `VIEWABILITY_50_PERCENT_OR_MORE`: Bid only on impressions that are at least 50% likely to be viewable.; `VIEWABILITY_60_PERCENT_OR_MORE`: Bid only on impressions that are at least 60% likely to be viewable.; `VIEWABILITY_70_PERCENT_OR_MORE`: Bid only on impressions that are at least 70% likely to be viewable.; `VIEWABILITY_80_PERCENT_OR_MORE`: Bid only on impressions that are at least 80% likely to be viewable.; `VIEWABILITY_90_PERCENT_OR_MORE`: Bid only on impressions that are at least 90% likely to be viewable.' 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 readOnly: true YouTubeSelectLineUp: type: object description: A Plannable YouTube Select Lineup for product targeting. properties: lineupId: type: string format: int64 description: Output only. The ID of the YouTube Select Lineup. readOnly: true displayName: type: string description: Output only. The display name of the YouTube Select Lineup. readOnly: true YouTubeSelectSettings: type: object description: Settings for YouTube Select Lineups. properties: lineupId: type: string format: int64 description: Optional. The ID of the YouTube Select Lineup. YoutubeAndPartnersBiddingStrategy: type: object description: Settings that control the bid strategy for YouTube and Partners resources. properties: value: type: string format: int64 description: 'The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.' adGroupEffectiveTargetCpaValue: type: string format: int64 description: Output only. The effective target CPA for ad group, in micros of advertiser's currency. readOnly: true adGroupEffectiveTargetCpaSource: type: string description: 'Output only. Source of the effective target CPA value for ad group. Allowed values — `BIDDING_SOURCE_UNSPECIFIED`: Bidding source is not specified or unknown.; `BIDDING_SOURCE_LINE_ITEM`: Bidding value is inherited from the line item.; `BIDDING_SOURCE_AD_GROUP`: Bidding value is defined in the ad group.' enum: - BIDDING_SOURCE_UNSPECIFIED - BIDDING_SOURCE_LINE_ITEM - BIDDING_SOURCE_AD_GROUP readOnly: true type: type: string description: 'The type of the bidding strategy. Allowed values — `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_UNSPECIFIED`: Type is not specified or unknown.; `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV`: A bidding strategy that pays a configurable amount per video view.; `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM`: A bidding strategy that pays a configurable amount per impression.; `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA`: A bidding strategy that automatically optimizes conversions per dollar.; `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM`: A bidding strategy that pays a configurable amount per impression.; `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM`: A bidding strategy for YouTube Instant Reserve line items that pays a fixed amount per impression.; `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_LIFT`: An automated bidding strategy that sets bids to achieve maximum lift.; `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS`: A bidding strategy that automatically maximizes number of conversions given a daily budget.; `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPV`: A bidding strategy that automatically optimizes cost per video view.; `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS`: A bidding strategy that automatically maximizes revenue while averaging a specific target Return On Ad Spend (ROAS).; `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSION_VALUE`: A bidding strategy that automatically sets bids to maximize revenue while spending your budget.' enum: - YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_UNSPECIFIED - YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV - YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM - YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA - YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM - YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM - YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_LIFT - YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS - YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPV - YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS - YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSION_VALUE YoutubeAndPartnersInventorySourceConfig: type: object description: Settings that control what YouTube related inventories the YouTube and Partners line item will target. properties: includeYoutube: type: boolean description: Optional. Whether to target inventory on YouTube. This includes both search, channels and videos. includeGoogleTv: type: boolean description: Optional. Whether to target inventory in video apps available with Google TV. includeYoutubeVideoPartners: type: boolean description: Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube. YoutubeAndPartnersSettings: type: object description: Settings for YouTube and Partners line items. properties: inventorySourceSettings: $ref: '#/components/schemas/YoutubeAndPartnersInventorySourceConfig' viewFrequencyCap: $ref: '#/components/schemas/FrequencyCap' linkedMerchantId: type: string format: int64 description: Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. leadFormId: type: string format: int64 description: Optional. The ID of the form to generate leads. effectiveContentCategory: type: string description: 'Output only. The content category which takes effect when serving the line item. When content category is set in both line item and advertiser, the stricter one will take effect when serving the line item. New line items will only inherit the advertiser level setting. Allowed values — `YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_UNSPECIFIED`: Content category is not specified or is unknown in this version.; `YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_STANDARD`: A category consisting of a wide range of content appropriate for most brands. The content is based off of YouTube''s [advertiser-friendly content guidelines](https://support.google.com/youtube/answer/6162278).; `YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_EXPANDED`: A category including all content across YouTube and video partners that meets standards for monetization.; `YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_LIMITED`: A category consisting of a reduced range of content that meets heightened requirements, especially regarding inappropriate language and sexual suggestiveness.' enum: - YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_UNSPECIFIED - YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_STANDARD - YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_EXPANDED - YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_LIMITED readOnly: true relatedVideoIds: type: array description: Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. items: type: string thirdPartyMeasurementConfigs: $ref: '#/components/schemas/ThirdPartyMeasurementConfigs' videoAdSequenceSettings: $ref: '#/components/schemas/VideoAdSequenceSettings' targetFrequency: $ref: '#/components/schemas/TargetFrequency' contentCategory: type: string description: 'Output only. The kind of content on which the YouTube and Partners ads will be shown. *Warning*: This field will be removed in the near future. Use effective_content_category instead. Allowed values — `YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_UNSPECIFIED`: Content category is not specified or is unknown in this version.; `YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_STANDARD`: A category consisting of a wide range of content appropriate for most brands. The content is based off of YouTube''s [advertiser-friendly content guidelines](https://support.google.com/youtube/answer/6162278).; `YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_EXPANDED`: A category including all content across YouTube and video partners that meets standards for monetization.; `YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_LIMITED`: A category consisting of a reduced range of content that meets heightened requirements, especially regarding inappropriate language and sexual suggestiveness.' enum: - YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_UNSPECIFIED - YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_STANDARD - YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_EXPANDED - YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_LIMITED readOnly: true videoAdInventoryControl: $ref: '#/components/schemas/VideoAdInventoryControl' YoutubeAssetAssociation: type: object description: An association between a resource and a YouTube asset. properties: name: type: string description: 'Identifier. The resource name of the association. For line item-level associations: The name pattern is `advertisers/{advertiser_id}/lineItems/{line_item_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For ad group-level associations: The name pattern is `advertisers/{advertiser_id}/adGroups/{ad_group_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: `youtube_asset_association_id` is the ID of the asset set linked, or 0 if the location_matching_type or affiliate_location_matching_type is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: `youtube_asset_association_id` is be the ID of the sitelink asset linked.' youtubeAssetType: type: string description: 'Required. The type of YouTube asset associated with the resource. Allowed values — `YOUTUBE_ASSET_TYPE_UNSPECIFIED`: YouTube asset type is not specified or is unknown in this version.; `YOUTUBE_ASSET_TYPE_LOCATION`: Location asset.; `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`: Affiliate location asset.; `YOUTUBE_ASSET_TYPE_SITELINK`: Sitelink asset.' enum: - YOUTUBE_ASSET_TYPE_UNSPECIFIED - YOUTUBE_ASSET_TYPE_LOCATION - YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION - YOUTUBE_ASSET_TYPE_SITELINK linkedYoutubeAsset: $ref: '#/components/schemas/YoutubeAssetAssociationLinkedYouTubeAsset' YoutubeAssetAssociationAffiliateLocationAssetFilter: type: object description: An asset filter that matches eligible affiliate location assets for serving. properties: affiliateLocationMatchingFunction: $ref: '#/components/schemas/YoutubeAssetAssociationAffiliateLocationAssetFilterAffiliateLocationMatchingFunction' affiliateLocationMatchingType: type: string description: 'Required. The matching type of this affiliate location asset filter. Allowed values — `AFFILIATE_LOCATION_MATCHING_TYPE_UNSPECIFIED`: Affiliate location matching type is not specified or is unknown in this version.; `SELECT_ALL`: All available affiliate location assets are eligible for serving.; `SELECTED_CHAINS`: The selected affiliate location assets can serve.; `DISABLED`: No affiliate location assets can serve.' enum: - AFFILIATE_LOCATION_MATCHING_TYPE_UNSPECIFIED - SELECT_ALL - SELECTED_CHAINS - DISABLED assetSetId: type: string format: int64 description: Output only. The ID of the asset set that matches the affiliate location assets eligible for serving. readOnly: true YoutubeAssetAssociationAffiliateLocationAssetFilterAffiliateLocationChain: type: object description: A chain of affiliate locations. properties: chainId: type: string format: int64 description: Required. ID of the affiliate location chain. YoutubeAssetAssociationAffiliateLocationAssetFilterAffiliateLocationMatchingFunction: type: object description: The matching function for an affiliate location asset filter. properties: chains: type: array description: Optional. The selected affiliate location chain IDs. This field is required if affiliate_location_matching_type is `SELECTED_CHAINS`. items: $ref: '#/components/schemas/YoutubeAssetAssociationAffiliateLocationAssetFilterAffiliateLocationChain' YoutubeAssetAssociationLinkedYouTubeAsset: type: object description: A YouTube asset linked to a resource in a YoutubeAssetAssociation. properties: locationAssetFilter: $ref: '#/components/schemas/YoutubeAssetAssociationLocationAssetFilter' sitelinkAsset: $ref: '#/components/schemas/YoutubeAssetAssociationSitelinkAsset' affiliateLocationAssetFilter: $ref: '#/components/schemas/YoutubeAssetAssociationAffiliateLocationAssetFilter' YoutubeAssetAssociationLocationAssetFilter: type: object description: An asset filter that matches eligible location assets for serving. properties: locationMatchingFunction: $ref: '#/components/schemas/YoutubeAssetAssociationLocationAssetFilterLocationMatchingFunction' locationMatchingType: type: string description: 'Required. The matching type of this location asset filter. Allowed values — `LOCATION_MATCHING_TYPE_UNSPECIFIED`: Location matching type is not specified or is unknown in this version.; `SELECT_ALL`: All available location assets are eligible for serving.; `FILTER`: The location assets that match a provided business name and/or label filters can serve.; `SELECTED_ASSETS`: Only the selected location assets can serve.; `DISABLED`: No location assets can serve.' enum: - LOCATION_MATCHING_TYPE_UNSPECIFIED - SELECT_ALL - FILTER - SELECTED_ASSETS - DISABLED assetSetId: type: string format: int64 description: Output only. The ID of the asset set that matches the location assets eligible for serving. readOnly: true YoutubeAssetAssociationLocationAssetFilterLocationMatchingFunction: type: object description: The matching function for a location asset filter. properties: labels: type: array description: Optional. The labels to match with. Labels are logically OR'ed together. This field is optional and can only be set if location_matching_type is `FILTER`. items: type: string business: type: string description: Optional. The business name to match with. This field is optional and can only be set if location_matching_type is `FILTER`. locationAssetIds: type: array description: Optional. The selected location asset IDs. This field is required if location_matching_type is `SELECTED_ASSETS`. items: type: string format: int64 YoutubeAssetAssociationSitelinkAsset: type: object description: A sitelink asset. properties: assetId: type: string format: int64 description: Required. ID of the sitelink asset. YoutubeChannelAssignedTargetingOptionDetails: type: object description: Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. properties: negative: type: boolean description: Indicates if this option is being negatively targeted. channelId: type: string description: The YouTube uploader channel id or the channel code of a YouTube channel. YoutubeChannelPackAssignedTargetingOptionDetails: type: object description: Details for YouTube channel pack assigned targeting option. This will be populated in the youtube_channel_pack_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL_PACK`. properties: negative: type: boolean description: Optional. Indicates if this option is being negatively targeted. channelPackId: type: string format: int64 description: Required. The ID of the YouTube channel pack. YoutubeVideoAsset: type: object description: Data for a YouTube video ad asset. properties: youtubeVideoId: type: string description: Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL. YoutubeVideoAssignedTargetingOptionDetails: type: object description: Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. properties: negative: type: boolean description: Indicates if this option is being negatively targeted. videoId: type: string description: YouTube video id as it appears on the YouTube watch page. YoutubeVideoDetails: type: object description: Details of a YouTube video. properties: videoAssetId: type: string format: int64 description: Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. unavailableReason: type: string description: 'The reason why the video data is not available. Allowed values — `VIDEO_UNAVAILABLE_REASON_UNSPECIFIED`: Unknown or unspecified.; `VIDEO_UNAVAILABLE_REASON_PRIVATE`: The video is private.; `VIDEO_UNAVAILABLE_REASON_DELETED`: The video is deleted.' enum: - VIDEO_UNAVAILABLE_REASON_UNSPECIFIED - VIDEO_UNAVAILABLE_REASON_PRIVATE - VIDEO_UNAVAILABLE_REASON_DELETED id: type: string description: Output only. The YouTube video ID which can be searched on YouTube webpage. readOnly: true securitySchemes: oauth2: type: oauth2 description: Google OAuth 2.0. Authorization and token endpoints read from https://accounts.google.com/.well-known/openid-configuration. flows: authorizationCode: authorizationUrl: https://accounts.google.com/o/oauth2/v2/auth tokenUrl: https://oauth2.googleapis.com/token refreshUrl: https://oauth2.googleapis.com/token scopes: https://www.googleapis.com/auth/doubleclickbidmanager: View and manage your reports in DoubleClick Bid Manager https://www.googleapis.com/auth/display-video-user-management: 'Private Service: https://www.googleapis.com/auth/display-video-user-management' https://www.googleapis.com/auth/display-video: Create, see, edit, and permanently delete your Display & Video 360 entities and reports https://www.googleapis.com/auth/display-video-mediaplanning: Create, see, and edit Display & Video 360 Campaign entities and see billing invoices