2026-11-11
▼ ▲ displayvideo.sdfuploadtasks.operations.get
HTTP Method : GET
Description : Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.
Path : v4/{+name}
Parameter Order : name
Flat Path : v4/sdfuploadtasks/operations/{operationsId}
Parameters :
name
Type : string
Location : path
Required : Yes
Pattern : ^sdfuploadtasks/operations/[^/]+$
Description : The name of the operation resource.
Scopes :
▼ ▲ displayvideo.advertisers.audit
Path : v4/advertisers/{+advertiserId}:audit
Parameters :
advertiserId
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser to audit.
Required : Yes
Format : int64
Type : string
Location : path
readMask
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
Type : string
Format : google-fieldmask
Location : query
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.
Flat Path : v4/advertisers/{advertisersId}:audit
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.get
Parameters :
advertiserId
Format : int64
Type : string
Location : path
Required : Yes
Description : Required. The ID of the advertiser to fetch.
Pattern : ^[^/]+$
Path : v4/advertisers/{+advertiserId}
Parameter Order : advertiserId
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Description : Gets an advertiser.
Flat Path : v4/advertisers/{advertisersId}
▼ ▲ displayvideo.advertisers.editAssignedTargetingOptions
HTTP Method : POST
Flat Path : v4/advertisers/{advertisersId}:editAssignedTargetingOptions
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 .
Path : v4/advertisers/{+advertiserId}:editAssignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Description : Required. The ID of the advertiser.
Format : int64
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.list
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
orderBy
Type : string
Location : query
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`.
filter
Location : query
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.
pageToken
Location : query
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.
Type : string
pageSize
Type : integer
Location : query
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Format : int32
partnerId
Type : string
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.
Format : int64
Location : query
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.
Flat Path : v4/advertisers
Path : v4/advertisers
▼ ▲ displayvideo.advertisers.patch
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : PATCH
Path : v4/advertisers/{+advertiserId}
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}
Description : Updates an existing advertiser. Returns the updated advertiser if successful.
Parameters :
updateMask
Type : string
Format : google-fieldmask
Description : Required. The mask to control which fields to update.
Location : query
advertiserId
Pattern : ^[^/]+$
Location : path
Type : string
Required : Yes
Description : Output only. The unique ID of the advertiser. Assigned by the system.
Format : int64
▼ ▲ displayvideo.advertisers.delete
Parameters :
advertiserId
Format : int64
Type : string
Description : The ID of the advertiser we need to delete.
Location : path
Pattern : ^[^/]+$
Required : Yes
Path : v4/advertisers/{+advertiserId}
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.
Parameter Order : advertiserId
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : DELETE
Flat Path : v4/advertisers/{advertisersId}
▼ ▲ displayvideo.advertisers.listAssignedTargetingOptions
Parameters :
pageSize
Location : query
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.
Type : integer
pageToken
Location : query
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.
Type : string
filter
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.
Location : query
advertiserId
Required : Yes
Type : string
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser the line item belongs to.
orderBy
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`.
Location : query
Type : string
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}:listAssignedTargetingOptions
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}:listAssignedTargetingOptions
Description : Lists assigned targeting options of an advertiser across targeting types.
HTTP Method : GET
▼ ▲ displayvideo.advertisers.create
Path : v4/advertisers
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Flat Path : v4/advertisers
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.
▼ ▲ displayvideo.advertisers.reachForecast.retrievePlannableLocations
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.
Parameter Order : advertiserId
Parameters :
advertiserId
Description : Required. The ID of the advertiser to list plannable locations for.
Required : Yes
Format : int64
Location : path
Type : string
Pattern : ^[^/]+$
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/reachForecast:retrievePlannableLocations
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/reachForecast:retrievePlannableLocations
▼ ▲ displayvideo.advertisers.reachForecast.retrievePlannableUserInterests
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/reachForecast:retrievePlannableUserInterests
Parameters :
advertiserId
Description : Required. The ID of the advertiser to list plannable user interests for.
Format : int64
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
productCategory
Enum :
Description : Required. The product category to retrieve plannable user interests for.
Type : string
Location : query
Enum Descriptions :
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.
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}/reachForecast:retrievePlannableUserInterests
HTTP Method : GET
▼ ▲ displayvideo.advertisers.reachForecast.retrievePlannableProducts
Parameters :
advertiserId
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the advertiser to list plannable products for.
Type : string
plannableLocationId
Description : Required. The ID of the plannable location.
Type : string
Location : query
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.
Flat Path : v4/advertisers/{advertisersId}/reachForecast:retrievePlannableProducts
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/reachForecast:retrievePlannableProducts
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.reachForecast.generateReachForecast
Parameters :
advertiserId
Format : int64
Description : Required. The ID of the advertiser that will run the planned campaign.
Type : string
Location : path
Pattern : ^[^/]+$
Required : Yes
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}/reachForecast:generateReachForecast
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/reachForecast:generateReachForecast
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.
▼ ▲ displayvideo.advertisers.reachForecast.retrievePlannableUserLists
Flat Path : v4/advertisers/{advertisersId}/reachForecast:retrievePlannableUserLists
Parameter Order : advertiserId
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/reachForecast:retrievePlannableUserLists
Parameters :
filter
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.
Location : query
pageSize
Location : query
Type : integer
Description : Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `5000`.
Format : int32
advertiserId
Description : Required. The ID of the advertiser to retrieve plannable user lists for.
Location : path
Type : string
Required : Yes
Pattern : ^[^/]+$
Format : int64
pageToken
Type : string
Location : query
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.
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.
▼ ▲ displayvideo.advertisers.negativeKeywordLists.patch
Flat Path : v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListId}
HTTP Method : PATCH
Path : v4/advertisers/{+advertiserId}/negativeKeywordLists/{negativeKeywordListId}
Parameter Order :
Description : Updates a negative keyword list. Returns the updated negative keyword list if successful.
Parameters :
updateMask
Type : string
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Location : query
negativeKeywordListId
Type : string
Description : Output only. The unique ID of the negative keyword list. Assigned by the system.
Location : path
Format : int64
Required : Yes
advertiserId
Description : Required. The ID of the DV360 advertiser to which the negative keyword list belongs.
Type : string
Location : path
Required : Yes
Pattern : ^[^/]+$
Format : int64
▼ ▲ displayvideo.advertisers.negativeKeywordLists.get
Parameters :
advertiserId
Required : Yes
Type : string
Location : path
Pattern : ^[^/]+$
Format : int64
Description : Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs.
negativeKeywordListId
Required : Yes
Description : Required. The ID of the negative keyword list to fetch.
Location : path
Type : string
Format : int64
Pattern : ^[^/]+$
Flat Path : v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}
Description : Gets a negative keyword list given an advertiser ID and a negative keyword list ID.
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}
Parameter Order :
▼ ▲ displayvideo.advertisers.negativeKeywordLists.list
Parameters :
pageSize
Location : query
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.
advertiserId
Type : string
Location : path
Required : Yes
Pattern : ^[^/]+$
Format : int64
Description : Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong.
pageToken
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.
Location : query
Type : string
Parameter Order : advertiserId
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/negativeKeywordLists
HTTP Method : GET
Description : Lists negative keyword lists based on a given advertiser id.
Flat Path : v4/advertisers/{advertisersId}/negativeKeywordLists
▼ ▲ displayvideo.advertisers.negativeKeywordLists.create
Flat Path : v4/advertisers/{advertisersId}/negativeKeywordLists
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Description : Required. The ID of the DV360 advertiser to which the negative keyword list will belong.
Location : path
Required : Yes
Format : int64
Type : string
Pattern : ^[^/]+$
Parameter Order : advertiserId
Description : Creates a new negative keyword list. Returns the newly created negative keyword list if successful.
HTTP Method : POST
Path : v4/advertisers/{+advertiserId}/negativeKeywordLists
▼ ▲ displayvideo.advertisers.negativeKeywordLists.delete
Parameters :
negativeKeywordListId
Description : Required. The ID of the negative keyword list to delete.
Location : path
Type : string
Pattern : ^[^/]+$
Format : int64
Required : Yes
advertiserId
Location : path
Required : Yes
Description : Required. The ID of the DV360 advertiser to which the negative keyword list belongs.
Pattern : ^[^/]+$
Format : int64
Type : string
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}
Description : Deletes a negative keyword list given an advertiser ID and a negative keyword list ID.
Parameter Order :
HTTP Method : DELETE
Path : v4/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.replace
Parameters :
advertiserId
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Location : path
Required : Yes
Type : string
Format : int64
negativeKeywordListId
Pattern : ^[^/]+$
Required : Yes
Description : Required. The ID of the parent negative keyword list to which the negative keywords belong.
Type : string
Format : int64
Location : path
Parameter Order :
Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:replace
Scopes : https://www.googleapis.com/auth/display-video
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.
HTTP Method : POST
Flat Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:replace
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.bulkEdit
HTTP Method : POST
Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:bulkEdit
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.
Flat Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:bulkEdit
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Type : string
Location : path
Format : int64
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Required : Yes
negativeKeywordListId
Location : path
Required : Yes
Description : Required. The ID of the parent negative keyword list to which the negative keywords belong.
Pattern : ^[^/]+$
Format : int64
Type : string
Parameter Order :
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.create
HTTP Method : POST
Parameter Order :
Description : Creates a negative keyword in a negative keyword list.
Parameters :
advertiserId
Required : Yes
Location : path
Type : string
Format : int64
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
negativeKeywordListId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Format : int64
Description : Required. The ID of the parent negative keyword list in which the negative keyword will be created.
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords
Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.list
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Flat Path : v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords
Description : Lists negative keywords in a negative keyword list.
Parameters :
advertiserId
Format : int64
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
negativeKeywordListId
Location : path
Type : string
Format : int64
Required : Yes
Pattern : ^[^/]+$
Description : Required. The ID of the parent negative keyword list to which the requested negative keywords belong.
filter
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.
Location : query
pageSize
Type : integer
Location : query
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.
pageToken
Location : query
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.
orderBy
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`.
Location : query
Type : string
Path : v4/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.delete
Parameters :
advertiserId
Format : int64
Type : string
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Location : path
Required : Yes
keywordValue
Required : Yes
Type : string
Location : path
Description : Required. The keyword value of the negative keyword to delete.
Pattern : ^[^/]+$
negativeKeywordListId
Description : Required. The ID of the parent negative keyword list to which the negative keyword belongs.
Pattern : ^[^/]+$
Format : int64
Location : path
Type : string
Required : Yes
Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords/{+keywordValue}
Description : Deletes a negative keyword from a negative keyword list.
Parameter Order :
Flat Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords/{negativeKeywordsId}
HTTP Method : DELETE
▼ ▲ displayvideo.advertisers.insertionOrders.list
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameters :
pageSize
Format : int32
Type : integer
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.
Location : query
orderBy
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`.
Location : query
filter
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.
Location : query
advertiserId
Type : string
Location : path
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser to list insertion orders for.
Format : int64
Required : Yes
pageToken
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.
Type : string
Location : query
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.
Path : v4/advertisers/{+advertiserId}/insertionOrders
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}/insertionOrders
▼ ▲ displayvideo.advertisers.insertionOrders.patch
Description : Updates an existing insertion order. Returns the updated insertion order if successful.
Flat Path : v4/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}
HTTP Method : PATCH
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}
Parameters :
advertiserId
Pattern : ^[^/]+$
Format : int64
Location : path
Type : string
Description : Output only. The unique ID of the advertiser the insertion order belongs to.
Required : Yes
updateMask
Description : Required. The mask to control which fields to update.
Location : query
Type : string
Format : google-fieldmask
insertionOrderId
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Description : Output only. The unique ID of the insertion order. Assigned by the system.
Format : int64
▼ ▲ displayvideo.advertisers.insertionOrders.delete
Flat Path : v4/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}
HTTP Method : DELETE
Parameter Order :
Parameters :
advertiserId
Location : path
Required : Yes
Pattern : ^[^/]+$
Format : int64
Type : string
Description : The ID of the advertiser this insertion order belongs to.
insertionOrderId
Location : path
Format : int64
Required : Yes
Description : The ID of the insertion order to delete.
Type : string
Pattern : ^[^/]+$
Scopes : https://www.googleapis.com/auth/display-video
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.
Path : v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}
▼ ▲ displayvideo.advertisers.insertionOrders.get
Parameter Order :
Path : v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}
Parameters :
insertionOrderId
Description : Required. The ID of the insertion order to fetch.
Pattern : ^[^/]+$
Format : int64
Required : Yes
Location : path
Type : string
advertiserId
Description : Required. The ID of the advertiser this insertion order belongs to.
Format : int64
Location : path
Type : string
Required : Yes
Pattern : ^[^/]+$
Flat Path : v4/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}
Description : Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist.
HTTP Method : GET
▼ ▲ displayvideo.advertisers.insertionOrders.create
Parameters :
advertiserId
Location : path
Required : Yes
Format : int64
Description : Output only. The unique ID of the advertiser the insertion order belongs to.
Type : string
Pattern : ^[^/]+$
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/insertionOrders
Flat Path : v4/advertisers/{advertisersId}/insertionOrders
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/display-video
Description : Creates a new insertion order. Returns the newly created insertion order if successful.
▼ ▲ displayvideo.advertisers.lineItems.bulkEditAssignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/lineItems:bulkEditAssignedTargetingOptions
Parameters :
advertiserId
Description : Required. The ID of the advertiser the line items belong to.
Type : string
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Parameter Order : advertiserId
HTTP Method : POST
Flat Path : v4/advertisers/{advertisersId}/lineItems:bulkEditAssignedTargetingOptions
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.
▼ ▲ displayvideo.advertisers.lineItems.bulkUpdate
Parameters :
advertiserId
Format : int64
Type : string
Location : path
Pattern : ^[^/]+$
Required : Yes
Description : Required. The ID of the advertiser this line item belongs to.
Path : v4/advertisers/{+advertiserId}/lineItems:bulkUpdate
Flat Path : v4/advertisers/{advertisersId}/lineItems:bulkUpdate
HTTP Method : POST
Parameter Order : advertiserId
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.
▼ ▲ displayvideo.advertisers.lineItems.list
Parameter Order : advertiserId
Parameters :
pageSize
Type : integer
Format : int32
Location : query
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.
filter
Type : string
Location : query
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.
advertiserId
Format : int64
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser to list line items for.
orderBy
Type : string
Location : query
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`.
pageToken
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.
Location : query
Type : string
Path : v4/advertisers/{+advertiserId}/lineItems
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.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/lineItems
▼ ▲ displayvideo.advertisers.lineItems.duplicate
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.
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}:duplicate
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}:duplicate
Parameter Order :
Parameters :
advertiserId
Format : int64
Type : string
Description : Required. The ID of the advertiser this line item belongs to.
Location : path
Required : Yes
Pattern : ^[^/]+$
lineItemId
Format : int64
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Description : Required. The ID of the line item to duplicate.
▼ ▲ displayvideo.advertisers.lineItems.delete
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : DELETE
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.
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}
Parameters :
lineItemId
Type : string
Pattern : ^[^/]+$
Required : Yes
Location : path
Description : The ID of the line item to delete.
Format : int64
advertiserId
Required : Yes
Format : int64
Location : path
Description : The ID of the advertiser this line item belongs to.
Pattern : ^[^/]+$
Type : string
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}
Parameter Order :
▼ ▲ displayvideo.advertisers.lineItems.patch
Parameters :
advertiserId
Type : string
Pattern : ^[^/]+$
Location : path
Format : int64
Required : Yes
Description : Output only. The unique ID of the advertiser the line item belongs to.
updateMask
Format : google-fieldmask
Type : string
Location : query
Description : Required. The mask to control which fields to update.
lineItemId
Description : Output only. The unique ID of the line item. Assigned by the system.
Type : string
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}
HTTP Method : PATCH
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.
▼ ▲ displayvideo.advertisers.lineItems.get
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}
Description : Gets a line item.
HTTP Method : GET
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
lineItemId
Description : Required. The ID of the line item to fetch.
Location : path
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
advertiserId
Required : Yes
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser this line item belongs to.
Location : path
Type : string
Parameter Order :
▼ ▲ displayvideo.advertisers.lineItems.bulkListAssignedTargetingOptions
Description : Lists assigned targeting options for multiple line items across targeting types.
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the advertiser the line items belongs to.
Type : string
lineItemIds
Repeated : Yes
Location : query
Type : string
Format : int64
Description : Required. The IDs of the line items to list assigned targeting options for.
pageSize
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.
Location : query
Format : int32
Type : integer
orderBy
Location : query
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`.
filter
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.
Type : string
Location : query
pageToken
Location : query
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.
Type : string
Flat Path : v4/advertisers/{advertisersId}/lineItems:bulkListAssignedTargetingOptions
Path : v4/advertisers/{+advertiserId}/lineItems:bulkListAssignedTargetingOptions
Parameter Order : advertiserId
HTTP Method : GET
▼ ▲ displayvideo.advertisers.lineItems.create
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.
Parameters :
advertiserId
Required : Yes
Pattern : ^[^/]+$
Location : path
Format : int64
Description : Output only. The unique ID of the advertiser the line item belongs to.
Type : string
Flat Path : v4/advertisers/{advertisersId}/lineItems
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
HTTP Method : POST
Path : v4/advertisers/{+advertiserId}/lineItems
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions
HTTP Method : POST
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.
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Location : path
Description : Required. The ID of the advertiser the line item belongs to.
Required : Yes
Format : int64
Type : string
Pattern : ^[^/]+$
targetingType
Required : Yes
Pattern : ^[^/]+$
Location : path
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_AUCTION_PACKAGE` * `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_DEAL` * `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`
Enum :
Type : string
Enum Descriptions :
lineItemId
Format : int64
Location : path
Description : Required. The ID of the line item the assigned targeting option will belong to.
Required : Yes
Pattern : ^[^/]+$
Type : string
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list
Description : Lists the targeting options assigned to a line item.
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
pageToken
Type : string
Location : query
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.
targetingType
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_AUCTION_PACKAGE` * `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_DEAL` * `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)
Location : path
Required : Yes
Enum Descriptions :
Enum :
Pattern : ^[^/]+$
Type : string
lineItemId
Location : path
Required : Yes
Description : Required. The ID of the line item to list assigned targeting options for.
Format : int64
Type : string
Pattern : ^[^/]+$
filter
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.
Type : string
Location : query
advertiserId
Location : path
Description : Required. The ID of the advertiser the line item belongs to.
Type : string
Required : Yes
Pattern : ^[^/]+$
Format : int64
orderBy
Location : query
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`.
Type : string
pageSize
Format : int32
Location : query
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.
Type : integer
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get
Parameters :
advertiserId
Type : string
Format : int64
Pattern : ^[^/]+$
Required : Yes
Description : Required. The ID of the advertiser the line item belongs to.
Location : path
assignedTargetingOptionId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.
lineItemId
Type : string
Format : int64
Pattern : ^[^/]+$
Required : Yes
Description : Required. The ID of the line item the assigned targeting option belongs to.
Location : path
targetingType
Type : string
Pattern : ^[^/]+$
Enum :
Required : Yes
Location : path
Enum Descriptions :
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_AUCTION_PACKAGE` * `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_DEAL` * `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)
Description : Gets a single targeting option assigned to a line item.
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
HTTP Method : GET
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete
HTTP Method : DELETE
Parameter Order :
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Scopes : https://www.googleapis.com/auth/display-video
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.
Parameters :
assignedTargetingOptionId
Location : path
Description : Required. The ID of the assigned targeting option to delete.
Type : string
Required : Yes
Pattern : ^[^/]+$
advertiserId
Location : path
Type : string
Required : Yes
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser the line item belongs to.
Format : int64
targetingType
Required : Yes
Location : path
Pattern : ^[^/]+$
Enum :
Enum Descriptions :
Type : string
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_AUCTION_PACKAGE` * `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_DEAL` * `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`
lineItemId
Description : Required. The ID of the line item the assigned targeting option belongs to.
Type : string
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
▼ ▲ displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.delete
Parameters :
linkedEntity.adGroupId
Description : The ID of an ad group.
Format : int64
Location : query
Type : string
lineItemId
Location : path
Type : string
Required : Yes
Description : The ID of a line item.
Pattern : ^[^/]+$
Format : int64
youtubeAssetAssociationId
Required : Yes
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.
Location : path
Type : string
Format : int64
Pattern : ^[^/]+$
youtubeAssetType
Required : Yes
Pattern : ^[^/]+$
Location : path
Enum :
Description : Required. The type of YouTube asset associated with the resource.
Enum Descriptions :
Type : string
advertiserId
Description : Required. The ID of the advertiser that the linked entity belongs to.
Location : path
Format : int64
Pattern : ^[^/]+$
Type : string
Required : Yes
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.
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : DELETE
Parameter Order :
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations/{+youtubeAssetAssociationId}
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations/{youtubeAssetAssociationsId}
▼ ▲ displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.list
Parameters :
linkedEntity.adGroupId
Location : query
Format : int64
Type : string
Description : The ID of an ad group.
advertiserId
Required : Yes
Pattern : ^[^/]+$
Location : path
Type : string
Description : Required. The ID of the advertiser that the linked entity belongs to.
Format : int64
pageToken
Location : query
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.
Type : string
pageSize
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.
Location : query
youtubeAssetType
Required : Yes
Description : Required. The type of YouTube asset being associated with the resource.
Pattern : ^[^/]+$
Location : path
Enum :
Enum Descriptions :
Type : string
lineItemId
Type : string
Format : int64
Required : Yes
Location : path
Description : The ID of a line item.
Pattern : ^[^/]+$
orderBy
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`.
Type : string
Location : query
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations
Parameter Order :
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations
HTTP Method : GET
Description : Lists the YouTube asset associations linked to the given resource.
▼ ▲ displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.create
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations
Parameters :
youtubeAssetType
Type : string
Location : path
Description : Required. The type of YouTube asset associated with the resource.
Enum :
Required : Yes
Pattern : ^[^/]+$
Enum Descriptions :
advertiserId
Required : Yes
Location : path
Type : string
Format : int64
Description : Required. The ID of the advertiser that the linked entity belongs to.
Pattern : ^[^/]+$
linkedEntity.adGroupId
Description : The ID of an ad group.
Type : string
Location : query
Format : int64
lineItemId
Location : path
Required : Yes
Format : int64
Type : string
Description : The ID of a line item.
Pattern : ^[^/]+$
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations
HTTP Method : POST
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.
▼ ▲ displayvideo.advertisers.adAssets.bulkCreate
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}/adAssets:bulkCreate
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Description : Required. The ID of the advertiser these ad assets belong to.
Format : int64
Path : v4/advertisers/{+advertiserId}/adAssets:bulkCreate
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`.
▼ ▲ displayvideo.advertisers.adAssets.create
Path : v4/advertisers/{+advertiserId}/adAssets
HTTP Method : POST
Parameter Order : advertiserId
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`.
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Format : int64
Description : Required. The ID of the advertiser this ad asset belongs to.
Flat Path : v4/advertisers/{advertisersId}/adAssets
▼ ▲ displayvideo.advertisers.adAssets.upload
Flat Path : v4/advertisers/{advertisersId}/adAssets:uploadAdAsset
Parameter Order : advertiserId
Supportsmediaupload : Yes
Scopes : https://www.googleapis.com/auth/display-video
Mediaupload :
Protocols :
Simple :
Path : /upload/v4/advertisers/{+advertiserId}/adAssets:uploadAdAsset
Multipart : Yes
Accept : */*
Parameters :
advertiserId
Required : Yes
Type : string
Format : int64
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the advertiser this ad asset belongs to.
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`.
HTTP Method : POST
Path : v4/advertisers/{+advertiserId}/adAssets:uploadAdAsset
▼ ▲ displayvideo.advertisers.adAssets.list
Parameters :
filter
Location : query
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`
Type : string
pageToken
Type : string
Location : query
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.
pageSize
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.
Location : query
Type : integer
Format : int32
orderBy
Location : query
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`.
Type : string
advertiserId
Description : Required. The ID of the advertiser the ad assets belong to.
Type : string
Format : int64
Location : path
Required : Yes
Pattern : ^[^/]+$
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}/adAssets
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/adAssets
HTTP Method : GET
Description : Lists ad assets under an advertiser ID. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
▼ ▲ displayvideo.advertisers.adAssets.get
Parameters :
advertiserId
Required : Yes
Pattern : ^[^/]+$
Location : path
Type : string
Description : Required. The ID of the advertiser this ad asset belongs to.
Format : int64
adAssetId
Type : string
Format : int64
Pattern : ^[^/]+$
Required : Yes
Description : Required. The ID of the ad asset to fetch. Only supports assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`
Location : path
Path : v4/advertisers/{+advertiserId}/adAssets/{+adAssetId}
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Description : Gets an ad asset. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
Parameter Order :
Flat Path : v4/advertisers/{advertisersId}/adAssets/{adAssetsId}
▼ ▲ displayvideo.advertisers.adAssets.patch
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.
Flat Path : v4/advertisers/{advertisersId}/adAssets/{adAssetsId}
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/adAssets/{+adAssetId}
HTTP Method : PATCH
Parameter Order :
Parameters :
updateMask
Type : string
Format : google-fieldmask
Description : Required. The list of fields to update. Only AdAsset.synthetic_content_attestation_status is mutable.
Location : query
advertiserId
Format : int64
Pattern : ^[^/]+$
Required : Yes
Description : Required. The ID of the advertiser this ad asset belongs to.
Type : string
Location : path
adAssetId
Pattern : ^[^/]+$
Format : int64
Required : Yes
Type : string
Description : Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad.
Location : path
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.bulkEdit
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.
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertiserId}/locationLists/{locationListsId}/assignedLocations:bulkEdit
Path : v4/advertisers/{advertiserId}/locationLists/{+locationListId}/assignedLocations:bulkEdit
Parameter Order :
HTTP Method : POST
Parameters :
advertiserId
Format : int64
Required : Yes
Type : string
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Location : path
locationListId
Description : Required. The ID of the location list to which these assignments are assigned.
Location : path
Pattern : ^[^/]+$
Format : int64
Required : Yes
Type : string
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.list
Description : Lists locations assigned to a location list.
Parameters :
locationListId
Format : int64
Required : Yes
Location : path
Description : Required. The ID of the location list to which these assignments are assigned.
Type : string
pageSize
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.
Format : int32
Type : integer
Location : query
orderBy
Location : query
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`.
Type : string
filter
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.
Location : query
advertiserId
Location : path
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Type : string
Format : int64
Required : Yes
pageToken
Type : string
Location : query
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.
Path : v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Flat Path : v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
Parameter Order :
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.create
Flat Path : v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
Parameters :
advertiserId
Format : int64
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Required : Yes
Location : path
Type : string
locationListId
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the location list for which the assignment will be created.
Type : string
Path : v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Description : Creates an assignment between a location and a location list.
HTTP Method : POST
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.delete
HTTP Method : DELETE
Description : Deletes the assignment between a location and a location list.
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{+assignedLocationId}
Flat Path : v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{assignedLocationsId}
Parameters :
assignedLocationId
Type : string
Description : Required. The ID of the assigned location to delete.
Location : path
Pattern : ^[^/]+$
Format : int64
Required : Yes
locationListId
Type : string
Location : path
Description : Required. The ID of the location list to which this assignment is assigned.
Required : Yes
Format : int64
advertiserId
Location : path
Required : Yes
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Format : int64
Type : string
Parameter Order :
▼ ▲ displayvideo.advertisers.locationLists.list
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/locationLists
Flat Path : v4/advertisers/{advertisersId}/locationLists
Parameters :
pageToken
Location : query
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.
Type : string
orderBy
Type : string
Location : query
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`.
advertiserId
Format : int64
Pattern : ^[^/]+$
Location : path
Type : string
Description : Required. The ID of the DV360 advertiser to which the fetched location lists belong.
Required : Yes
pageSize
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.
Location : query
Type : integer
filter
Location : query
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.
Type : string
Description : Lists location lists based on a given advertiser id.
Parameter Order : advertiserId
HTTP Method : GET
▼ ▲ displayvideo.advertisers.locationLists.create
Path : v4/advertisers/{+advertiserId}/locationLists
HTTP Method : POST
Description : Creates a new location list. Returns the newly created location list if successful.
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/locationLists
Parameter Order : advertiserId
Parameters :
advertiserId
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Location : path
Required : Yes
Format : int64
Type : string
Pattern : ^[^/]+$
▼ ▲ displayvideo.advertisers.locationLists.get
Parameters :
advertiserId
Location : path
Format : int64
Required : Yes
Pattern : ^[^/]+$
Description : Required. The ID of the DV360 advertiser to which the fetched location list belongs.
Type : string
locationListId
Format : int64
Required : Yes
Pattern : ^[^/]+$
Description : Required. The ID of the location list to fetch.
Location : path
Type : string
Path : v4/advertisers/{+advertiserId}/locationLists/{+locationListId}
Parameter Order :
Flat Path : v4/advertisers/{advertisersId}/locationLists/{locationListsId}
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Description : Gets a location list.
▼ ▲ displayvideo.advertisers.locationLists.patch
Flat Path : v4/advertisers/{advertisersId}/locationLists/{locationListId}
Parameter Order :
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/display-video
Description : Updates a location list. Returns the updated location list if successful.
Parameters :
locationListId
Location : path
Type : string
Required : Yes
Description : Output only. The unique ID of the location list. Assigned by the system.
Format : int64
advertiserId
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the DV360 advertiser to which the location lists belongs.
updateMask
Location : query
Type : string
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Path : v4/advertisers/{+advertiserId}/locationLists/{locationListId}
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.get
Parameters :
targetingType
Required : Yes
Pattern : ^[^/]+$
Enum Descriptions :
Location : path
Enum :
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`
Type : string
assignedTargetingOptionId
Required : Yes
Description : Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested.
Location : path
Type : string
Pattern : ^[^/]+$
advertiserId
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the advertiser.
Description : Gets a single targeting option assigned to an advertiser.
Flat Path : v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Path : v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
HTTP Method : GET
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.delete
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Flat Path : v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Parameters :
targetingType
Type : string
Required : Yes
Enum Descriptions :
Enum :
Location : path
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` * `TARGETING_TYPE_YOUTUBE_VIDEO` * `TARGETING_TYPE_YOUTUBE_CHANNEL`
assignedTargetingOptionId
Description : Required. The ID of the assigned targeting option to delete.
Pattern : ^[^/]+$
Location : path
Type : string
Required : Yes
advertiserId
Type : string
Description : Required. The ID of the advertiser.
Format : int64
Pattern : ^[^/]+$
Required : Yes
Location : path
Parameter Order :
Description : Deletes an assigned targeting option from an advertiser.
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.create
HTTP Method : POST
Path : v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Flat Path : v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Description : Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful.
Parameters :
advertiserId
Format : int64
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Description : Required. The ID of the advertiser.
targetingType
Required : Yes
Type : string
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` * `TARGETING_TYPE_YOUTUBE_VIDEO` * `TARGETING_TYPE_YOUTUBE_CHANNEL`
Location : path
Enum :
Pattern : ^[^/]+$
Enum Descriptions :
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.list
Parameters :
targetingType
Pattern : ^[^/]+$
Required : Yes
Enum Descriptions :
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`
Type : string
Location : path
Enum :
filter
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.
Type : string
Location : query
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 `ListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Location : query
orderBy
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`.
Location : query
advertiserId
Format : int64
Location : path
Type : string
Required : Yes
Description : Required. The ID of the advertiser.
Pattern : ^[^/]+$
pageSize
Format : int32
Location : query
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.
Type : integer
Parameter Order :
Flat Path : v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Description : Lists the targeting options assigned to an advertiser.
Path : v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions
HTTP Method : GET
▼ ▲ displayvideo.advertisers.creatives.patch
Parameters :
updateMask
Format : google-fieldmask
Location : query
Type : string
Description : Required. The mask to control which fields to update.
advertiserId
Required : Yes
Format : int64
Location : path
Type : string
Pattern : ^[^/]+$
Description : Output only. The unique ID of the advertiser the creative belongs to.
creativeId
Format : int64
Pattern : ^[^/]+$
Description : Output only. The unique ID of the creative. Assigned by the system.
Required : Yes
Location : path
Type : string
Path : v4/advertisers/{+advertiserId}/creatives/{+creativeId}
Parameter Order :
Flat Path : v4/advertisers/{advertisersId}/creatives/{creativesId}
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : PATCH
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.
▼ ▲ displayvideo.advertisers.creatives.get
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Required : Yes
Description : Required. The ID of the advertiser this creative belongs to.
Type : string
Location : path
Pattern : ^[^/]+$
Format : int64
creativeId
Type : string
Required : Yes
Description : Required. The ID of the creative to fetch.
Location : path
Pattern : ^[^/]+$
Format : int64
Flat Path : v4/advertisers/{advertisersId}/creatives/{creativesId}
Parameter Order :
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/creatives/{+creativeId}
Description : Gets a creative.
▼ ▲ displayvideo.advertisers.creatives.list
HTTP Method : GET
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.
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
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 `ListCreatives` method. If not specified, the first page of results will be returned.
Location : query
pageSize
Location : query
Type : integer
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.
Format : int32
orderBy
Type : string
Location : query
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`.
filter
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.
Type : string
Location : query
advertiserId
Pattern : ^[^/]+$
Format : int64
Description : Required. The ID of the advertiser to list creatives for.
Required : Yes
Type : string
Location : path
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/creatives
Flat Path : v4/advertisers/{advertisersId}/creatives
▼ ▲ displayvideo.advertisers.creatives.create
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.
Parameters :
advertiserId
Type : string
Description : Output only. The unique ID of the advertiser the creative belongs to.
Pattern : ^[^/]+$
Required : Yes
Location : path
Format : int64
Path : v4/advertisers/{+advertiserId}/creatives
Parameter Order : advertiserId
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/creatives
HTTP Method : POST
▼ ▲ displayvideo.advertisers.creatives.delete
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.
HTTP Method : DELETE
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/creatives/{+creativeId}
Flat Path : v4/advertisers/{advertisersId}/creatives/{creativesId}
Parameters :
advertiserId
Required : Yes
Format : int64
Type : string
Pattern : ^[^/]+$
Description : The ID of the advertiser this creative belongs to.
Location : path
creativeId
Required : Yes
Description : The ID of the creative to be deleted.
Format : int64
Type : string
Pattern : ^[^/]+$
Location : path
▼ ▲ displayvideo.advertisers.channels.sites.replace
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Flat Path : v4/advertisers/{advertiserId}/channels/{channelsId}/sites:replace
Parameters :
advertiserId
Format : int64
Location : path
Description : The ID of the advertiser that owns the parent channel.
Required : Yes
Type : string
channelId
Description : Required. The ID of the parent channel whose sites will be replaced.
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Location : path
Path : v4/advertisers/{advertiserId}/channels/{+channelId}/sites:replace
Parameter Order :
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.
▼ ▲ displayvideo.advertisers.channels.sites.bulkEdit
HTTP Method : POST
Flat Path : v4/advertisers/{advertiserId}/channels/{channelsId}/sites:bulkEdit
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Path : v4/advertisers/{advertiserId}/channels/{+channelId}/sites:bulkEdit
Parameters :
advertiserId
Required : Yes
Type : string
Description : The ID of the advertiser that owns the parent channel.
Location : path
Format : int64
channelId
Format : int64
Location : path
Description : Required. The ID of the parent channel to which the sites belong.
Required : Yes
Pattern : ^[^/]+$
Type : string
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.
▼ ▲ displayvideo.advertisers.channels.sites.create
Parameters :
channelId
Format : int64
Type : string
Location : path
Required : Yes
Description : Required. The ID of the parent channel in which the site will be created.
Pattern : ^[^/]+$
partnerId
Type : string
Location : query
Description : The ID of the partner that owns the parent channel.
Format : int64
advertiserId
Type : string
Format : int64
Location : path
Required : Yes
Description : The ID of the advertiser that owns the parent channel.
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Path : v4/advertisers/{advertiserId}/channels/{+channelId}/sites
Parameter Order :
Flat Path : v4/advertisers/{advertiserId}/channels/{channelsId}/sites
Description : Creates a site in a channel.
▼ ▲ displayvideo.advertisers.channels.sites.delete
Path : v4/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}
Flat Path : v4/advertisers/{advertiserId}/channels/{channelsId}/sites/{sitesId}
Parameter Order :
Parameters :
urlOrAppId
Type : string
Pattern : ^[^/]+$
Description : Required. The URL or app ID of the site to delete.
Required : Yes
Location : path
channelId
Required : Yes
Type : string
Location : path
Format : int64
Description : Required. The ID of the parent channel to which the site belongs.
Pattern : ^[^/]+$
partnerId
Type : string
Format : int64
Location : query
Description : The ID of the partner that owns the parent channel.
advertiserId
Format : int64
Description : The ID of the advertiser that owns the parent channel.
Location : path
Type : string
Required : Yes
Scopes : https://www.googleapis.com/auth/display-video
Description : Deletes a site from a channel.
HTTP Method : DELETE
▼ ▲ displayvideo.advertisers.channels.sites.list
HTTP Method : GET
Description : Lists sites in a channel.
Flat Path : v4/advertisers/{advertisersId}/channels/{channelsId}/sites
Parameters :
channelId
Required : Yes
Location : path
Format : int64
Description : Required. The ID of the parent channel to which the requested sites belong.
Type : string
Pattern : ^[^/]+$
partnerId
Description : The ID of the partner that owns the parent channel.
Location : query
Format : int64
Type : string
pageToken
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.
Type : string
Location : query
filter
Location : query
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.
advertiserId
Format : int64
Type : string
Description : The ID of the advertiser that owns the parent channel.
Location : path
Pattern : ^[^/]+$
Required : Yes
orderBy
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`.
Type : string
Location : query
pageSize
Type : integer
Format : int32
Location : query
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.
Parameter Order :
Path : v4/advertisers/{+advertiserId}/channels/{+channelId}/sites
▼ ▲ displayvideo.advertisers.channels.create
Flat Path : v4/advertisers/{advertisersId}/channels
Description : Creates a new channel. Returns the newly created channel if successful.
Path : v4/advertisers/{+advertiserId}/channels
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Description : The ID of the partner that owns the created channel.
Format : int64
Location : query
Type : string
advertiserId
Format : int64
Type : string
Location : path
Description : The ID of the advertiser that owns the created channel.
Required : Yes
Pattern : ^[^/]+$
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.channels.get
Parameter Order :
Flat Path : v4/advertisers/{advertisersId}/channels/{channelsId}
HTTP Method : GET
Description : Gets a channel for a partner or advertiser.
Path : v4/advertisers/{+advertiserId}/channels/{+channelId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
channelId
Type : string
Pattern : ^[^/]+$
Format : int64
Required : Yes
Description : Required. The ID of the channel to fetch.
Location : path
partnerId
Location : query
Format : int64
Description : The ID of the partner that owns the fetched channel.
Type : string
advertiserId
Required : Yes
Type : string
Description : The ID of the advertiser that owns the fetched channel.
Location : path
Pattern : ^[^/]+$
Format : int64
▼ ▲ displayvideo.advertisers.channels.patch
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/channels/{channelId}
Path : v4/advertisers/{+advertiserId}/channels/{channelId}
Parameters :
updateMask
Type : string
Description : Required. The mask to control which fields to update.
Location : query
Format : google-fieldmask
advertiserId
Description : The ID of the advertiser that owns the created channel.
Type : string
Format : int64
Location : path
Pattern : ^[^/]+$
Required : Yes
channelId
Type : string
Location : path
Description : Output only. The unique ID of the channel. Assigned by the system.
Required : Yes
Format : int64
partnerId
Description : The ID of the partner that owns the created channel.
Format : int64
Location : query
Type : string
Parameter Order :
Description : Updates a channel. Returns the updated channel if successful.
▼ ▲ displayvideo.advertisers.channels.list
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/channels
Parameters :
advertiserId
Description : The ID of the advertiser that owns the channels.
Format : int64
Type : string
Pattern : ^[^/]+$
Required : Yes
Location : path
orderBy
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`.
Location : query
filter
Location : query
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.
partnerId
Format : int64
Description : The ID of the partner that owns the channels.
Location : query
Type : string
pageToken
Location : query
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.
Type : string
pageSize
Type : integer
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.
Location : query
Format : int32
Description : Lists channels for a partner or advertiser.
Flat Path : v4/advertisers/{advertisersId}/channels
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.campaigns.list
Flat Path : v4/advertisers/{advertisersId}/campaigns
Path : v4/advertisers/{+advertiserId}/campaigns
HTTP Method : GET
Parameters :
filter
Location : query
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.
Type : string
orderBy
Type : string
Location : query
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`.
advertiserId
Format : int64
Type : string
Pattern : ^[^/]+$
Required : Yes
Description : The ID of the advertiser to list campaigns for.
Location : path
pageSize
Type : integer
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Location : query
Format : int32
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 `ListCampaigns` method. If not specified, the first page of results will be returned.
Location : query
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.
Scopes :
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.campaigns.patch
Description : Updates an existing campaign. Returns the updated campaign if successful.
Scopes :
HTTP Method : PATCH
Flat Path : v4/advertisers/{advertisersId}/campaigns/{campaignsId}
Path : v4/advertisers/{+advertiserId}/campaigns/{+campaignId}
Parameters :
campaignId
Location : path
Type : string
Required : Yes
Pattern : ^[^/]+$
Description : Output only. The unique ID of the campaign. Assigned by the system.
Format : int64
updateMask
Type : string
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Location : query
advertiserId
Type : string
Required : Yes
Pattern : ^[^/]+$
Description : Output only. The unique ID of the advertiser the campaign belongs to.
Location : path
Format : int64
Parameter Order :
▼ ▲ displayvideo.advertisers.campaigns.delete
Path : v4/advertisers/{+advertiserId}/campaigns/{+campaignId}
Parameters :
advertiserId
Location : path
Required : Yes
Description : The ID of the advertiser this campaign belongs to.
Pattern : ^[^/]+$
Type : string
Format : int64
campaignId
Location : path
Required : Yes
Description : The ID of the campaign we need to delete.
Type : string
Format : int64
Pattern : ^[^/]+$
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.
Scopes :
Parameter Order :
HTTP Method : DELETE
Flat Path : v4/advertisers/{advertisersId}/campaigns/{campaignsId}
▼ ▲ displayvideo.advertisers.campaigns.create
Path : v4/advertisers/{+advertiserId}/campaigns
Flat Path : v4/advertisers/{advertisersId}/campaigns
Parameter Order : advertiserId
HTTP Method : POST
Scopes :
Description : Creates a new campaign. Returns the newly created campaign if successful.
Parameters :
advertiserId
Location : path
Required : Yes
Description : Output only. The unique ID of the advertiser the campaign belongs to.
Type : string
Format : int64
Pattern : ^[^/]+$
▼ ▲ displayvideo.advertisers.campaigns.get
Parameters :
advertiserId
Location : path
Type : string
Format : int64
Description : Required. The ID of the advertiser this campaign belongs to.
Required : Yes
Pattern : ^[^/]+$
campaignId
Required : Yes
Description : Required. The ID of the campaign to fetch.
Pattern : ^[^/]+$
Location : path
Format : int64
Type : string
Path : v4/advertisers/{+advertiserId}/campaigns/{+campaignId}
Parameter Order :
HTTP Method : GET
Description : Gets a campaign.
Scopes :
Flat Path : v4/advertisers/{advertisersId}/campaigns/{campaignsId}
▼ ▲ displayvideo.advertisers.adGroupAds.list
Description : Lists ad group ads.
Flat Path : v4/advertisers/{advertisersId}/adGroupAds
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
filter
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` * `parentCreativeId` 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"` * All ad group ads under a parent creative: `parentCreativeId="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.
Location : query
advertiserId
Required : Yes
Pattern : ^[^/]+$
Format : int64
Location : path
Type : string
Description : Required. The ID of the advertiser the ads belong to.
pageSize
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.
Type : integer
Format : int32
Location : query
orderBy
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`.
Location : query
Type : string
pageToken
Location : query
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.
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/adGroupAds
▼ ▲ displayvideo.advertisers.adGroupAds.delete
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}
Description : Deletes an ad group ad.
Parameters :
advertiserId
Location : path
Format : int64
Required : Yes
Description : Required. The ID of the advertiser the ad belongs to.
Type : string
Pattern : ^[^/]+$
adGroupAdId
Format : int64
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the ad to delete.
Parameter Order :
Path : v4/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}
▼ ▲ displayvideo.advertisers.adGroupAds.patch
HTTP Method : PATCH
Flat Path : v4/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}
Path : v4/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}
Parameter Order :
Description : Updates an ad group ad.
Parameters :
adGroupAdId
Type : string
Pattern : ^[^/]+$
Location : path
Description : Output only. The unique ID of the ad. Assigned by the system.
Format : int64
Required : Yes
advertiserId
Description : Output only. The unique ID of the advertiser the ad belongs to.
Location : path
Pattern : ^[^/]+$
Format : int64
Type : string
Required : Yes
updateMask
Type : string
Location : query
Format : google-fieldmask
Description : Required. The mask to control which fields to update.
▼ ▲ displayvideo.advertisers.adGroupAds.create
Parameters :
advertiserId
Location : path
Format : int64
Type : string
Required : Yes
Pattern : ^[^/]+$
Description : Output only. The unique ID of the advertiser the ad belongs to.
Path : v4/advertisers/{+advertiserId}/adGroupAds
Description : Creates an ad group ad.
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/adGroupAds
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.adGroupAds.get
Description : Gets an ad group ad.
Path : v4/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}
Parameters :
adGroupAdId
Pattern : ^[^/]+$
Required : Yes
Location : path
Description : Required. The ID of the ad to fetch.
Format : int64
Type : string
advertiserId
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the advertiser this ad group ad belongs to.
Type : string
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}
Parameter Order :
HTTP Method : GET
▼ ▲ displayvideo.advertisers.invoices.list
HTTP Method : GET
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.
Parameters :
pageSize
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.
Format : int32
Location : query
Type : integer
pageToken
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.
Location : query
Type : string
advertiserId
Type : string
Format : int64
Location : path
Description : Required. The ID of the advertiser to list invoices for.
Required : Yes
Pattern : ^[^/]+$
loiSapinInvoiceType
Description : Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise.
Location : query
Type : string
Enum Descriptions :
Enum :
issueMonth
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.
Type : string
Location : query
Scopes :
Flat Path : v4/advertisers/{advertisersId}/invoices
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/invoices
▼ ▲ displayvideo.advertisers.invoices.lookupInvoiceCurrency
Parameters :
advertiserId
Type : string
Location : path
Description : Required. The ID of the advertiser to lookup currency for.
Required : Yes
Pattern : ^[^/]+$
Format : int64
invoiceMonth
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.
Type : string
Location : query
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/invoices:lookupInvoiceCurrency
Scopes :
Description : Retrieves the invoice currency used by an advertiser in a given month.
HTTP Method : GET
Flat Path : v4/advertisers/{advertisersId}/invoices:lookupInvoiceCurrency
▼ ▲ displayvideo.advertisers.adGroups.bulkListAssignedTargetingOptions
Flat Path : v4/advertisers/{advertisersId}/adGroups:bulkListAssignedTargetingOptions
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/adGroups:bulkListAssignedTargetingOptions
Parameter Order : advertiserId
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
pageToken
Location : query
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.
filter
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.
Location : query
advertiserId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the advertiser the line items belongs to.
Format : int64
adGroupIds
Repeated : Yes
Format : int64
Description : Required. The IDs of the ad groups to list assigned targeting options for.
Type : string
Location : query
pageSize
Format : int32
Location : query
Type : integer
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.
orderBy
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`.
Location : query
Type : string
Description : Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.
▼ ▲ displayvideo.advertisers.adGroups.patch
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}
Parameters :
advertiserId
Description : Output only. The unique ID of the advertiser the ad group belongs to.
Location : path
Pattern : ^[^/]+$
Type : string
Format : int64
Required : Yes
adGroupId
Description : Output only. The unique ID of the ad group. Assigned by the system.
Type : string
Pattern : ^[^/]+$
Location : path
Format : int64
Required : Yes
updateMask
Type : string
Format : google-fieldmask
Description : Required. The mask to control which fields to update.
Location : query
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}
Scopes : https://www.googleapis.com/auth/display-video
Description : Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups.
Parameter Order :
HTTP Method : PATCH
▼ ▲ displayvideo.advertisers.adGroups.create
Parameters :
advertiserId
Location : path
Type : string
Required : Yes
Format : int64
Description : Output only. The unique ID of the advertiser the ad group belongs to.
Pattern : ^[^/]+$
Path : v4/advertisers/{+advertiserId}/adGroups
HTTP Method : POST
Parameter Order : advertiserId
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/adGroups
Description : Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups.
▼ ▲ displayvideo.advertisers.adGroups.get
Parameters :
advertiserId
Location : path
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser this ad group belongs to.
Format : int64
Type : string
Required : Yes
adGroupId
Location : path
Required : Yes
Pattern : ^[^/]+$
Description : Required. The ID of the ad group to fetch.
Format : int64
Type : string
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}
Description : Gets an ad group.
HTTP Method : GET
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}
▼ ▲ displayvideo.advertisers.adGroups.delete
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.
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : DELETE
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}
Parameters :
adGroupId
Description : Required. The ID of the ad group to delete.
Type : string
Format : int64
Pattern : ^[^/]+$
Required : Yes
Location : path
advertiserId
Description : Required. The ID of the advertiser this ad group belongs to.
Type : string
Location : path
Pattern : ^[^/]+$
Format : int64
Required : Yes
▼ ▲ displayvideo.advertisers.adGroups.list
Path : v4/advertisers/{+advertiserId}/adGroups
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}/adGroups
Parameters :
advertiserId
Location : path
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the advertiser the ad groups belongs to.
Pattern : ^[^/]+$
pageSize
Type : integer
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.
Location : query
Format : int32
pageToken
Location : query
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.
filter
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.
Location : query
Type : string
orderBy
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`.
Type : string
Location : query
Description : Lists ad groups.
▼ ▲ displayvideo.advertisers.adGroups.bulkEditAssignedTargetingOptions
Flat Path : v4/advertisers/{advertisersId}/adGroups:bulkEditAssignedTargetingOptions
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.
HTTP Method : POST
Parameter Order : advertiserId
Parameters :
advertiserId
Pattern : ^[^/]+$
Format : int64
Type : string
Required : Yes
Location : path
Description : Required. The ID of the advertiser the ad groups belong to.
Path : v4/advertisers/{+advertiserId}/adGroups:bulkEditAssignedTargetingOptions
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.list
Parameter Order :
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Description : Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included.
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Required : Yes
Description : Required. The ID of the advertiser the ad group belongs to.
Location : path
Pattern : ^[^/]+$
Format : int64
Type : string
pageSize
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.
Type : integer
Format : int32
Location : query
pageToken
Location : query
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.
targetingType
Location : path
Required : Yes
Pattern : ^[^/]+$
Enum Descriptions :
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_CATEGORY` * `TARGETING_TYPE_COMBINED_AUDIENCE` * `TARGETING_TYPE_CUSTOM_LIST` * `TARGETING_TYPE_FIRST_PARTY_AND_PARTNER_AUDIENCE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_GOOGLE_AUDIENCE` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_LOOKALIKE_AUDIENCE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`
Type : string
Enum :
adGroupId
Location : path
Required : Yes
Format : int64
Description : Required. The ID of the ad group to list assigned targeting options for.
Type : string
Pattern : ^[^/]+$
orderBy
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`.
Type : string
Location : query
filter
Type : string
Location : query
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.
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.delete
Parameters :
advertiserId
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
Type : string
Description : Required. The ID of the advertiser the ad group belongs to.
adGroupId
Type : string
Format : int64
Location : path
Required : Yes
Pattern : ^[^/]+$
Description : Required. The ID of the ad group the assigned targeting option belongs to.
assignedTargetingOptionId
Location : path
Required : Yes
Type : string
Description : Required. The ID of the assigned targeting option to delete.
Pattern : ^[^/]+$
targetingType
Enum :
Required : Yes
Pattern : ^[^/]+$
Type : string
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_CATEGORY` * `TARGETING_TYPE_COMBINED_AUDIENCE` * `TARGETING_TYPE_CUSTOM_LIST` * `TARGETING_TYPE_FIRST_PARTY_AND_PARTNER_AUDIENCE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_GOOGLE_AUDIENCE` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_LOOKALIKE_AUDIENCE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`
Location : path
Enum Descriptions :
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Scopes : https://www.googleapis.com/auth/display-video
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`.
HTTP Method : DELETE
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Parameter Order :
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.get
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
targetingType
Enum Descriptions :
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_CATEGORY` * `TARGETING_TYPE_COMBINED_AUDIENCE` * `TARGETING_TYPE_CUSTOM_LIST` * `TARGETING_TYPE_FIRST_PARTY_AND_PARTNER_AUDIENCE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_GOOGLE_AUDIENCE` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_LOOKALIKE_AUDIENCE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`
Type : string
Location : path
Pattern : ^[^/]+$
Required : Yes
Enum :
adGroupId
Format : int64
Type : string
Description : Required. The ID of the ad group the assigned targeting option belongs to.
Location : path
Required : Yes
Pattern : ^[^/]+$
advertiserId
Location : path
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser the ad group belongs to.
assignedTargetingOptionId
Type : string
Pattern : ^[^/]+$
Required : Yes
Description : Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.
Location : path
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Parameter Order :
HTTP Method : GET
Description : Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.create
Parameter Order :
HTTP Method : POST
Parameters :
targetingType
Required : Yes
Enum Descriptions :
Type : string
Pattern : ^[^/]+$
Location : path
Enum :
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_CATEGORY` * `TARGETING_TYPE_COMBINED_AUDIENCE` * `TARGETING_TYPE_CUSTOM_LIST` * `TARGETING_TYPE_FIRST_PARTY_AND_PARTNER_AUDIENCE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_GOOGLE_AUDIENCE` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_LOOKALIKE_AUDIENCE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`
adGroupId
Type : string
Pattern : ^[^/]+$
Location : path
Format : int64
Description : Required. The ID of the ad group the assigned targeting option will belong to.
Required : Yes
advertiserId
Type : string
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser the ad group belongs to.
Required : Yes
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.
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions
▼ ▲ displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.create
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.
HTTP Method : POST
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations
Parameters :
youtubeAssetType
Pattern : ^[^/]+$
Enum Descriptions :
Required : Yes
Type : string
Enum :
Description : Required. The type of YouTube asset associated with the resource.
Location : path
linkedEntity.lineItemId
Type : string
Location : query
Description : The ID of a line item.
Format : int64
adGroupId
Format : int64
Description : The ID of an ad group.
Type : string
Location : path
Required : Yes
Pattern : ^[^/]+$
advertiserId
Type : string
Description : Required. The ID of the advertiser that the linked entity belongs to.
Pattern : ^[^/]+$
Location : path
Format : int64
Required : Yes
▼ ▲ displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.delete
Scopes : https://www.googleapis.com/auth/display-video
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.
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations/{+youtubeAssetAssociationId}
HTTP Method : DELETE
Parameter Order :
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations/{youtubeAssetAssociationsId}
Parameters :
advertiserId
Format : int64
Pattern : ^[^/]+$
Location : path
Required : Yes
Type : string
Description : Required. The ID of the advertiser that the linked entity belongs to.
adGroupId
Type : string
Format : int64
Pattern : ^[^/]+$
Required : Yes
Location : path
Description : The ID of an ad group.
youtubeAssetAssociationId
Pattern : ^[^/]+$
Location : path
Format : int64
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 : Yes
Type : string
linkedEntity.lineItemId
Description : The ID of a line item.
Location : query
Type : string
Format : int64
youtubeAssetType
Type : string
Description : Required. The type of YouTube asset associated with the resource.
Required : Yes
Pattern : ^[^/]+$
Enum :
Enum Descriptions :
Location : path
▼ ▲ displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.list
HTTP Method : GET
Description : Lists the YouTube asset associations linked to the given resource.
Parameters :
pageSize
Type : integer
Format : int32
Location : query
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.
advertiserId
Description : Required. The ID of the advertiser that the linked entity belongs to.
Pattern : ^[^/]+$
Required : Yes
Location : path
Format : int64
Type : string
pageToken
Type : string
Location : query
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.
youtubeAssetType
Description : Required. The type of YouTube asset being associated with the resource.
Location : path
Enum :
Pattern : ^[^/]+$
Required : Yes
Type : string
Enum Descriptions :
linkedEntity.lineItemId
Description : The ID of a line item.
Type : string
Format : int64
Location : query
orderBy
Location : query
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`.
adGroupId
Type : string
Pattern : ^[^/]+$
Required : Yes
Location : path
Description : The ID of an ad group.
Format : int64
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations
▼ ▲ displayvideo.advertisers.assets.upload
Parameters :
advertiserId
Type : string
Description : Required. The ID of the advertiser this asset belongs to.
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Path : v4/advertisers/{+advertiserId}/assets
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).
Supportsmediaupload : Yes
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
HTTP Method : POST
Flat Path : v4/advertisers/{advertisersId}/assets
Mediaupload :
Accept : */*
Protocols :
Simple :
Path : /upload/v4/advertisers/{+advertiserId}/assets
Multipart : Yes
▼ ▲ displayvideo.customLists.get
Parameter Order : customListId
Parameters :
customListId
Pattern : ^[^/]+$
Description : Required. The ID of the custom list to fetch.
Format : int64
Type : string
Required : Yes
Location : path
advertiserId
Type : string
Format : int64
Location : query
Description : The ID of the DV360 advertiser that has access to the fetched custom lists.
Description : Gets a custom list.
Path : v4/customLists/{+customListId}
Flat Path : v4/customLists/{customListsId}
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
▼ ▲ displayvideo.customLists.list
Parameters :
pageSize
Type : integer
Location : query
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.
orderBy
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`.
Type : string
Location : query
advertiserId
Location : query
Format : int64
Type : string
Description : The ID of the DV360 advertiser that has access to the fetched custom lists.
pageToken
Type : string
Location : query
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.
filter
Location : query
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.
Type : string
Description : Lists custom lists. The order is defined by the order_by parameter.
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/customLists
Path : v4/customLists
HTTP Method : GET
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.delete
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources/{+assignedInventorySourceId}
Parameters :
partnerId
Description : The ID of the partner that owns the parent inventory source group. Only this partner has write access to this assigned inventory source.
Type : string
Format : int64
Location : query
assignedInventorySourceId
Location : path
Required : Yes
Pattern : ^[^/]+$
Format : int64
Type : string
Description : Required. The ID of the assigned inventory source to delete.
advertiserId
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.
Format : int64
Location : query
Type : string
inventorySourceGroupId
Location : path
Format : int64
Required : Yes
Type : string
Pattern : ^[^/]+$
Description : Required. The ID of the inventory source group to which this assignment is assigned.
Description : Deletes the assignment between an inventory source and an inventory source group.
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources/{assignedInventorySourcesId}
HTTP Method : DELETE
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.create
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Description : Creates an assignment between an inventory source and an inventory source group.
Parameter Order : inventorySourceGroupId
Parameters :
advertiserId
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.
Format : int64
Type : string
Location : query
partnerId
Format : int64
Type : string
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.
Location : query
inventorySourceGroupId
Location : path
Format : int64
Required : Yes
Type : string
Description : Required. The ID of the inventory source group to which the assignment will be assigned.
Pattern : ^[^/]+$
Path : v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.bulkEdit
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.
HTTP Method : POST
Parameter Order : inventorySourceGroupId
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources:bulkEdit
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
inventorySourceGroupId
Required : Yes
Type : string
Pattern : ^[^/]+$
Location : path
Format : int64
Description : Required. The ID of the inventory source group to which the assignments are assigned.
Path : v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources:bulkEdit
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.list
Description : Lists inventory sources assigned to an inventory source group.
Parameter Order : inventorySourceGroupId
Path : v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources
Parameters :
inventorySourceGroupId
Type : string
Description : Required. The ID of the inventory source group to which these assignments are assigned.
Pattern : ^[^/]+$
Location : path
Format : int64
Required : Yes
pageSize
Location : query
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.
partnerId
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.
Location : query
Type : string
filter
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.
Location : query
orderBy
Type : string
Location : query
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`.
advertiserId
Type : string
Format : int64
Location : query
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.
pageToken
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.
Location : query
Type : string
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources
HTTP Method : GET
▼ ▲ displayvideo.inventorySourceGroups.get
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupsId}
Parameters :
inventorySourceGroupId
Pattern : ^[^/]+$
Description : Required. The ID of the inventory source group to fetch.
Required : Yes
Location : path
Format : int64
Type : string
advertiserId
Location : query
Format : int64
Type : string
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.
partnerId
Description : The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group.
Location : query
Type : string
Format : int64
Description : Gets an inventory source group.
Path : v4/inventorySourceGroups/{+inventorySourceGroupId}
HTTP Method : GET
Parameter Order : inventorySourceGroupId
▼ ▲ displayvideo.inventorySourceGroups.list
Flat Path : v4/inventorySourceGroups
Parameters :
orderBy
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`.
Type : string
Location : query
advertiserId
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.
Location : query
Type : string
pageToken
Location : query
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.
partnerId
Location : query
Format : int64
Type : string
Description : The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups.
pageSize
Type : integer
Format : int32
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Location : query
filter
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.
Type : string
Location : query
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/inventorySourceGroups
HTTP Method : GET
Description : Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter.
▼ ▲ displayvideo.inventorySourceGroups.delete
Parameters :
inventorySourceGroupId
Required : Yes
Format : int64
Type : string
Location : path
Pattern : ^[^/]+$
Description : Required. The ID of the inventory source group to delete.
advertiserId
Description : The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.
Type : string
Format : int64
Location : query
partnerId
Format : int64
Location : query
Type : string
Description : The ID of the partner that owns the inventory source group. Only this partner has write access to this group.
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupsId}
Path : v4/inventorySourceGroups/{+inventorySourceGroupId}
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/display-video
Description : Deletes an inventory source group.
Parameter Order : inventorySourceGroupId
▼ ▲ displayvideo.inventorySourceGroups.create
HTTP Method : POST
Description : Creates a new inventory source group. Returns the newly created inventory source group if successful.
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
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.
Type : string
Location : query
advertiserId
Format : int64
Description : The ID of the advertiser that owns the inventory source group. The parent partner will not have access to this group.
Location : query
Type : string
Path : v4/inventorySourceGroups
Flat Path : v4/inventorySourceGroups
▼ ▲ displayvideo.inventorySourceGroups.patch
Scopes : https://www.googleapis.com/auth/display-video
Description : Updates an inventory source group. Returns the updated inventory source group if successful.
Parameter Order : inventorySourceGroupId
HTTP Method : PATCH
Path : v4/inventorySourceGroups/{inventorySourceGroupId}
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupId}
Parameters :
inventorySourceGroupId
Type : string
Format : int64
Description : Output only. The unique ID of the inventory source group. Assigned by the system.
Required : Yes
Location : path
advertiserId
Type : string
Format : int64
Location : query
Description : The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.
updateMask
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Location : query
Type : string
partnerId
Description : The ID of the partner that owns the inventory source group. Only this partner has write access to this group.
Location : query
Format : int64
Type : string
▼ ▲ displayvideo.inventorySources.editInventorySourceReadWriteAccessors
HTTP Method : POST
Flat Path : v4/inventorySources/{inventorySourcesId}:editInventorySourceReadWriteAccessors
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/inventorySources/{+inventorySourceId}:editInventorySourceReadWriteAccessors
Parameters :
inventorySourceId
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of inventory source to update.
Format : int64
Parameter Order : inventorySourceId
Description : Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.
▼ ▲ displayvideo.inventorySources.create
Flat Path : v4/inventorySources
Description : Creates a new inventory source. Returns the newly created inventory source if successful.
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Type : string
Description : The ID of the advertiser that the request is being made within.
Format : int64
Location : query
partnerId
Location : query
Format : int64
Description : The ID of the partner that the request is being made within.
Type : string
Path : v4/inventorySources
HTTP Method : POST
▼ ▲ displayvideo.inventorySources.patch
Flat Path : v4/inventorySources/{inventorySourcesId}
Path : v4/inventorySources/{+inventorySourceId}
Parameters :
partnerId
Format : int64
Description : The ID of the partner that the request is being made within.
Type : string
Location : query
advertiserId
Format : int64
Type : string
Description : The ID of the advertiser that the request is being made within.
Location : query
inventorySourceId
Location : path
Required : Yes
Pattern : ^[^/]+$
Description : Output only. The unique ID of the inventory source. Assigned by the system.
Type : string
Format : int64
updateMask
Description : Required. The mask to control which fields to update.
Location : query
Format : google-fieldmask
Type : string
Parameter Order : inventorySourceId
Description : Updates an existing inventory source. Returns the updated inventory source if successful.
HTTP Method : PATCH
▼ ▲ displayvideo.inventorySources.get
Path : v4/inventorySources/{+inventorySourceId}
Parameters :
partnerId
Type : string
Location : query
Description : Required. The ID of the DV360 partner to which the fetched inventory source is permissioned.
Format : int64
advertiserId
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.
Location : query
inventorySourceId
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
Description : Required. The ID of the inventory source to fetch.
Format : int64
Flat Path : v4/inventorySources/{inventorySourcesId}
Description : Gets an inventory source.
Parameter Order : inventorySourceId
HTTP Method : GET
▼ ▲ displayvideo.inventorySources.list
HTTP Method : GET
Parameters :
pageSize
Location : query
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Type : integer
Format : int32
pageToken
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.
Location : query
Type : string
filter
Location : query
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.
Type : string
partnerId
Format : int64
Location : query
Description : The ID of the partner that has access to the inventory source.
Type : string
orderBy
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`.
Location : query
advertiserId
Type : string
Location : query
Format : int64
Description : The ID of the advertiser that has access to the inventory source.
Path : v4/inventorySources
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.
Flat Path : v4/inventorySources
▼ ▲ displayvideo.targetingTypes.targetingOptions.list
Path : v4/targetingTypes/{+targetingType}/targetingOptions
Parameters :
orderBy
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`.
Location : query
advertiserId
Description : Required. The Advertiser this request is being made in the context of.
Format : int64
Type : string
Location : query
targetingType
Enum Descriptions :
Type : string
Description : Required. The type of targeting option to be listed. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUCTION_PACKAGE` * `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`
Enum :
Location : path
Required : Yes
Pattern : ^[^/]+$
filter
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.
Location : query
Type : string
pageSize
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.
Type : integer
Location : query
pageToken
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.
Location : query
Type : string
Flat Path : v4/targetingTypes/{targetingTypesId}/targetingOptions
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Description : Lists targeting options of a given type.
Parameter Order : targetingType
▼ ▲ displayvideo.targetingTypes.targetingOptions.get
HTTP Method : GET
Parameter Order :
Path : v4/targetingTypes/{+targetingType}/targetingOptions/{+targetingOptionId}
Description : Gets a single targeting option.
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
targetingOptionId
Required : Yes
Type : string
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the of targeting option to retrieve.
advertiserId
Description : Required. The Advertiser this request is being made in the context of.
Type : string
Location : query
Format : int64
targetingType
Enum :
Required : Yes
Type : string
Pattern : ^[^/]+$
Location : path
Description : Required. The type of targeting option to retrieve. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUCTION_PACKAGE` * `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`
Enum Descriptions :
Flat Path : v4/targetingTypes/{targetingTypesId}/targetingOptions/{targetingOptionsId}
▼ ▲ displayvideo.targetingTypes.targetingOptions.search
Flat Path : v4/targetingTypes/{targetingTypesId}/targetingOptions:search
Path : v4/targetingTypes/{+targetingType}/targetingOptions:search
HTTP Method : POST
Description : Searches for targeting options of a given type based on the given search terms.
Parameters :
targetingType
Description : Required. The type of targeting options to retrieve. Accepted values are: * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_BUSINESS_CHAIN`
Enum :
Pattern : ^[^/]+$
Enum Descriptions :
Type : string
Required : Yes
Location : path
Parameter Order : targetingType
▼ ▲ displayvideo.floodlightGroups.patch
Path : v4/floodlightGroups/{floodlightGroupId}
Parameter Order : floodlightGroupId
HTTP Method : PATCH
Description : Updates an existing Floodlight group. Returns the updated Floodlight group if successful.
Parameters :
floodlightGroupId
Location : path
Description : Output only. The unique ID of the Floodlight group. Assigned by the system.
Required : Yes
Type : string
Format : int64
partnerId
Type : string
Location : query
Description : Required. The partner context by which the Floodlight group is being accessed.
Format : int64
updateMask
Location : query
Format : google-fieldmask
Description : Required. The mask to control which fields to update.
Type : string
Flat Path : v4/floodlightGroups/{floodlightGroupId}
▼ ▲ displayvideo.floodlightGroups.get
Flat Path : v4/floodlightGroups/{floodlightGroupsId}
Parameters :
floodlightGroupId
Location : path
Description : Required. The ID of the Floodlight group to fetch.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
partnerId
Location : query
Type : string
Format : int64
Description : Required. The partner context by which the Floodlight group is being accessed.
Path : v4/floodlightGroups/{+floodlightGroupId}
Parameter Order : floodlightGroupId
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/display-video
Description : Gets a Floodlight group.
▼ ▲ displayvideo.floodlightGroups.floodlightActivities.get
Parameter Order :
Flat Path : v4/floodlightGroups/{floodlightGroupsId}/floodlightActivities/{floodlightActivitiesId}
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/display-video
Description : Gets a Floodlight activity.
Path : v4/floodlightGroups/{+floodlightGroupId}/floodlightActivities/{+floodlightActivityId}
Parameters :
floodlightGroupId
Required : Yes
Format : int64
Location : path
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of the parent Floodlight group to which the requested Floodlight activity belongs.
partnerId
Description : Required. The ID of the partner through which the Floodlight activity is being accessed.
Type : string
Location : query
Format : int64
floodlightActivityId
Required : Yes
Type : string
Format : int64
Location : path
Pattern : ^[^/]+$
Description : Required. The ID of the Floodlight activity to fetch.
▼ ▲ displayvideo.floodlightGroups.floodlightActivities.list
Flat Path : v4/floodlightGroups/{floodlightGroupsId}/floodlightActivities
Parameter Order : floodlightGroupId
HTTP Method : GET
Description : Lists Floodlight activities in a Floodlight group.
Parameters :
partnerId
Location : query
Description : Required. The ID of the partner through which the Floodlight activities are being accessed.
Format : int64
Type : string
floodlightGroupId
Required : Yes
Format : int64
Description : Required. The ID of the parent Floodlight group to which the requested Floodlight activities belong.
Pattern : ^[^/]+$
Location : path
Type : string
pageToken
Location : query
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.
Type : string
pageSize
Format : int32
Type : integer
Location : query
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.
orderBy
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`.
Type : string
Location : query
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/floodlightGroups/{+floodlightGroupId}/floodlightActivities
▼ ▲ displayvideo.combinedAudiences.list
Description : Lists combined audiences. The order is defined by the order_by parameter.
Flat Path : v4/combinedAudiences
Path : v4/combinedAudiences
Parameters :
filter
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.
Location : query
Type : string
partnerId
Format : int64
Location : query
Type : string
Description : The ID of the partner that has access to the fetched combined audiences.
advertiserId
Location : query
Type : string
Description : The ID of the advertiser that has access to the fetched combined audiences.
Format : int64
pageToken
Location : query
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.
Type : string
pageSize
Type : integer
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.
Format : int32
Location : query
orderBy
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`.
Location : query
Type : string
HTTP Method : GET
▼ ▲ displayvideo.combinedAudiences.get
Path : v4/combinedAudiences/{+combinedAudienceId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Location : query
Description : The ID of the partner that has access to the fetched combined audience.
Type : string
Format : int64
combinedAudienceId
Format : int64
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
Description : Required. The ID of the combined audience to fetch.
advertiserId
Location : query
Type : string
Format : int64
Description : The ID of the advertiser that has access to the fetched combined audience.
Description : Gets a combined audience.
Flat Path : v4/combinedAudiences/{combinedAudiencesId}
Parameter Order : combinedAudienceId
HTTP Method : GET
▼ ▲ displayvideo.firstPartyAndPartnerAudiences.get
Parameter Order : firstPartyAndPartnerAudienceId
Parameters :
partnerId
Format : int64
Location : query
Type : string
Description : The ID of the partner that has access to the fetched first party and partner audience.
advertiserId
Type : string
Description : The ID of the advertiser that has access to the fetched first party and partner audience.
Location : query
Format : int64
firstPartyAndPartnerAudienceId
Type : string
Location : path
Required : Yes
Pattern : ^[^/]+$
Format : int64
Description : Required. The ID of the first party and partner audience to fetch.
Description : Gets a first party or partner audience.
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Path : v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}
Flat Path : v4/firstPartyAndPartnerAudiences/{firstPartyAndPartnerAudiencesId}
▼ ▲ displayvideo.firstPartyAndPartnerAudiences.editCustomerMatchMembers
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`
Flat Path : v4/firstPartyAndPartnerAudiences/{firstPartyAndPartnerAudiencesId}:editCustomerMatchMembers
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Path : v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}:editCustomerMatchMembers
Parameter Order : firstPartyAndPartnerAudienceId
Parameters :
firstPartyAndPartnerAudienceId
Format : int64
Type : string
Pattern : ^[^/]+$
Required : Yes
Location : path
Description : Required. The ID of the Customer Match FirstPartyAndPartnerAudience whose members will be edited.
▼ ▲ displayvideo.firstPartyAndPartnerAudiences.patch
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : firstPartyAndPartnerAudienceId
Path : v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}
Flat Path : v4/firstPartyAndPartnerAudiences/{firstPartyAndPartnerAudiencesId}
Description : Updates an existing FirstPartyAndPartnerAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
Parameters :
advertiserId
Location : query
Format : int64
Description : Required. The ID of the owner advertiser of the updated FirstPartyAndPartnerAudience.
Type : string
firstPartyAndPartnerAudienceId
Required : Yes
Type : string
Format : int64
Pattern : ^[^/]+$
Location : path
Description : Identifier. The unique ID of the first party and partner audience. Assigned by the system.
updateMask
Type : string
Format : google-fieldmask
Location : query
Description : Required. The mask to control which fields to update. Updates are only supported for the following fields: * `displayName` * `description` * `membershipDurationDays`
HTTP Method : PATCH
▼ ▲ displayvideo.firstPartyAndPartnerAudiences.create
Parameters :
advertiserId
Format : int64
Location : query
Description : Required. The ID of the advertiser under whom the FirstPartyAndPartnerAudience will be created.
Type : string
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Path : v4/firstPartyAndPartnerAudiences
Description : Creates a FirstPartyAndPartnerAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
Flat Path : v4/firstPartyAndPartnerAudiences
▼ ▲ displayvideo.firstPartyAndPartnerAudiences.list
Path : v4/firstPartyAndPartnerAudiences
Parameters :
filter
Type : string
Location : query
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.
pageSize
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.
Format : int32
Location : query
Type : integer
advertiserId
Description : The ID of the advertiser that has access to the fetched first party and partner audiences.
Type : string
Location : query
Format : int64
partnerId
Type : string
Location : query
Format : int64
Description : The ID of the partner that has access to the fetched first party and partner audiences.
orderBy
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`.
Location : query
pageToken
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.
Location : query
Type : string
Scopes : https://www.googleapis.com/auth/display-video
Description : Lists first party and partner audiences. The order is defined by the order_by parameter.
Flat Path : v4/firstPartyAndPartnerAudiences
HTTP Method : GET
▼ ▲ displayvideo.partners.get
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : partnerId
Flat Path : v4/partners/{partnersId}
Description : Gets a partner.
Parameters :
partnerId
Type : string
Format : int64
Pattern : ^[^/]+$
Location : path
Required : Yes
Description : Required. The ID of the partner to fetch.
Path : v4/partners/{+partnerId}
▼ ▲ displayvideo.partners.list
Description : Lists partners that are accessible to the current user. The order is defined by the order_by parameter.
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/partners
HTTP Method : GET
Path : v4/partners
Parameters :
filter
Location : query
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.
Type : string
orderBy
Location : query
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`.
pageToken
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.
Location : query
Type : string
pageSize
Location : query
Format : int32
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Type : integer
▼ ▲ displayvideo.partners.editAssignedTargetingOptions
Path : v4/partners/{+partnerId}:editAssignedTargetingOptions
Parameters :
partnerId
Location : path
Type : string
Required : Yes
Pattern : ^[^/]+$
Format : int64
Description : Required. The ID of the partner.
HTTP Method : POST
Flat Path : v4/partners/{partnersId}:editAssignedTargetingOptions
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 .
Parameter Order : partnerId
▼ ▲ displayvideo.partners.channels.get
Description : Gets a channel for a partner or advertiser.
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/partners/{+partnerId}/channels/{+channelId}
Parameters :
advertiserId
Format : int64
Type : string
Description : The ID of the advertiser that owns the fetched channel.
Location : query
partnerId
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
Description : The ID of the partner that owns the fetched channel.
Format : int64
channelId
Required : Yes
Location : path
Description : Required. The ID of the channel to fetch.
Type : string
Pattern : ^[^/]+$
Format : int64
Flat Path : v4/partners/{partnersId}/channels/{channelsId}
Parameter Order :
HTTP Method : GET
▼ ▲ displayvideo.partners.channels.create
Flat Path : v4/partners/{partnersId}/channels
Path : v4/partners/{+partnerId}/channels
HTTP Method : POST
Description : Creates a new channel. Returns the newly created channel if successful.
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Required : Yes
Format : int64
Description : The ID of the partner that owns the created channel.
Pattern : ^[^/]+$
Location : path
Type : string
advertiserId
Type : string
Description : The ID of the advertiser that owns the created channel.
Location : query
Format : int64
Parameter Order : partnerId
▼ ▲ displayvideo.partners.channels.list
Parameters :
filter
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.
Location : query
Type : string
advertiserId
Location : query
Type : string
Format : int64
Description : The ID of the advertiser that owns the channels.
pageSize
Type : integer
Location : query
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.
Format : int32
partnerId
Type : string
Description : The ID of the partner that owns the channels.
Location : path
Pattern : ^[^/]+$
Format : int64
Required : Yes
pageToken
Location : query
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.
orderBy
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`.
Location : query
Parameter Order : partnerId
Path : v4/partners/{+partnerId}/channels
Flat Path : v4/partners/{partnersId}/channels
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/display-video
Description : Lists channels for a partner or advertiser.
▼ ▲ displayvideo.partners.channels.patch
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
HTTP Method : PATCH
Parameters :
updateMask
Format : google-fieldmask
Description : Required. The mask to control which fields to update.
Location : query
Type : string
advertiserId
Description : The ID of the advertiser that owns the created channel.
Location : query
Format : int64
Type : string
partnerId
Format : int64
Description : The ID of the partner that owns the created channel.
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
channelId
Type : string
Location : path
Format : int64
Required : Yes
Description : Output only. The unique ID of the channel. Assigned by the system.
Path : v4/partners/{+partnerId}/channels/{channelId}
Description : Updates a channel. Returns the updated channel if successful.
Flat Path : v4/partners/{partnersId}/channels/{channelId}
▼ ▲ displayvideo.partners.channels.sites.delete
Parameter Order :
HTTP Method : DELETE
Path : v4/partners/{partnerId}/channels/{+channelId}/sites/{+urlOrAppId}
Description : Deletes a site from a channel.
Parameters :
urlOrAppId
Required : Yes
Pattern : ^[^/]+$
Type : string
Location : path
Description : Required. The URL or app ID of the site to delete.
advertiserId
Type : string
Format : int64
Description : The ID of the advertiser that owns the parent channel.
Location : query
partnerId
Description : The ID of the partner that owns the parent channel.
Required : Yes
Format : int64
Location : path
Type : string
channelId
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of the parent channel to which the site belongs.
Required : Yes
Location : path
Format : int64
Flat Path : v4/partners/{partnerId}/channels/{channelsId}/sites/{sitesId}
▼ ▲ displayvideo.partners.channels.sites.create
Flat Path : v4/partners/{partnerId}/channels/{channelsId}/sites
Parameters :
partnerId
Type : string
Format : int64
Location : path
Required : Yes
Description : The ID of the partner that owns the parent channel.
channelId
Type : string
Pattern : ^[^/]+$
Description : Required. The ID of the parent channel in which the site will be created.
Format : int64
Required : Yes
Location : path
advertiserId
Description : The ID of the advertiser that owns the parent channel.
Format : int64
Location : query
Type : string
Description : Creates a site in a channel.
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/partners/{partnerId}/channels/{+channelId}/sites
Parameter Order :
HTTP Method : POST
▼ ▲ displayvideo.partners.channels.sites.list
Path : v4/partners/{+partnerId}/channels/{+channelId}/sites
Parameter Order :
Parameters :
pageToken
Location : query
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.
Type : string
partnerId
Location : path
Pattern : ^[^/]+$
Format : int64
Type : string
Required : Yes
Description : The ID of the partner that owns the parent channel.
channelId
Location : path
Description : Required. The ID of the parent channel to which the requested sites belong.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Type : string
orderBy
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`.
Location : query
Type : string
advertiserId
Format : int64
Description : The ID of the advertiser that owns the parent channel.
Type : string
Location : query
pageSize
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.
Location : query
Type : integer
Format : int32
filter
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.
Location : query
Type : string
Description : Lists sites in a channel.
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/partners/{partnersId}/channels/{channelsId}/sites
HTTP Method : GET
▼ ▲ displayvideo.partners.channels.sites.replace
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.
Flat Path : v4/partners/{partnerId}/channels/{channelsId}/sites:replace
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Required : Yes
Type : string
Location : path
Description : The ID of the partner that owns the parent channel.
Format : int64
channelId
Description : Required. The ID of the parent channel whose sites will be replaced.
Location : path
Type : string
Format : int64
Required : Yes
Pattern : ^[^/]+$
Path : v4/partners/{partnerId}/channels/{+channelId}/sites:replace
HTTP Method : POST
▼ ▲ displayvideo.partners.channels.sites.bulkEdit
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.
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Type : string
Format : int64
Description : The ID of the partner that owns the parent channel.
Location : path
Required : Yes
channelId
Type : string
Location : path
Required : Yes
Format : int64
Description : Required. The ID of the parent channel to which the sites belong.
Pattern : ^[^/]+$
Path : v4/partners/{partnerId}/channels/{+channelId}/sites:bulkEdit
Parameter Order :
Flat Path : v4/partners/{partnerId}/channels/{channelsId}/sites:bulkEdit
HTTP Method : POST
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.get
Scopes : https://www.googleapis.com/auth/display-video
Description : Gets a single targeting option assigned to a partner.
HTTP Method : GET
Parameter Order :
Flat Path : v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Parameters :
assignedTargetingOptionId
Description : Required. An identifier unique to the targeting type in this partner that identifies the assigned targeting option being requested.
Location : path
Pattern : ^[^/]+$
Type : string
Required : Yes
targetingType
Pattern : ^[^/]+$
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Type : string
Enum Descriptions :
Required : Yes
Location : path
Enum :
partnerId
Required : Yes
Location : path
Type : string
Pattern : ^[^/]+$
Format : int64
Description : Required. The ID of the partner.
Path : v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.delete
Description : Deletes an assigned targeting option from a partner.
Parameter Order :
HTTP Method : DELETE
Flat Path : v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Path : v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
targetingType
Pattern : ^[^/]+$
Required : Yes
Location : path
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Enum :
Enum Descriptions :
Type : string
partnerId
Description : Required. The ID of the partner.
Format : int64
Type : string
Location : path
Required : Yes
Pattern : ^[^/]+$
assignedTargetingOptionId
Pattern : ^[^/]+$
Required : Yes
Location : path
Description : Required. The ID of the assigned targeting option to delete.
Type : string
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.list
Flat Path : v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
HTTP Method : GET
Path : v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Parameter Order :
Parameters :
targetingType
Location : path
Description : Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Type : string
Enum Descriptions :
Pattern : ^[^/]+$
Required : Yes
Enum :
partnerId
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Format : int64
Description : Required. The ID of the partner.
pageToken
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.
Type : string
Location : query
filter
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.
Type : string
Location : query
pageSize
Location : query
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.
Format : int32
Type : integer
orderBy
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`.
Location : query
Description : Lists the targeting options assigned to a partner.
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.create
Flat Path : v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
HTTP Method : POST
Description : Assigns a targeting option to a partner. Returns the assigned targeting option if successful.
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Location : path
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the partner.
Format : int64
targetingType
Required : Yes
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Enum Descriptions :
Location : path
Enum :
Type : string
Pattern : ^[^/]+$
Parameter Order :
Path : v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions
▼ ▲ displayvideo.sdfdownloadtasks.create
Flat Path : v4/sdfdownloadtasks
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
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.
Path : v4/sdfdownloadtasks
▼ ▲ displayvideo.sdfdownloadtasks.operations.get
HTTP Method : GET
Scopes :
Path : v4/{+name}
Flat Path : v4/sdfdownloadtasks/operations/{operationsId}
Parameter Order : name
Description : Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.
Parameters :
name
Description : The name of the operation resource.
Required : Yes
Type : string
Location : path
Pattern : ^sdfdownloadtasks/operations/[^/]+$
▼ ▲ displayvideo.googleAudiences.get
Parameters :
advertiserId
Format : int64
Location : query
Type : string
Description : The ID of the advertiser that has access to the fetched Google audience.
partnerId
Format : int64
Type : string
Description : The ID of the partner that has access to the fetched Google audience.
Location : query
googleAudienceId
Description : Required. The ID of the Google audience to fetch.
Pattern : ^[^/]+$
Required : Yes
Type : string
Location : path
Format : int64
Parameter Order : googleAudienceId
Path : v4/googleAudiences/{+googleAudienceId}
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/googleAudiences/{googleAudiencesId}
HTTP Method : GET
Description : Gets a Google audience.
▼ ▲ displayvideo.googleAudiences.list
Parameters :
orderBy
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`.
Type : string
Location : query
pageSize
Location : query
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.
pageToken
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.
Type : string
Location : query
advertiserId
Description : The ID of the advertiser that has access to the fetched Google audiences.
Location : query
Format : int64
Type : string
partnerId
Location : query
Type : string
Description : The ID of the partner that has access to the fetched Google audiences.
Format : int64
filter
Location : query
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.
Scopes : https://www.googleapis.com/auth/display-video
Description : Lists Google audiences. The order is defined by the order_by parameter.
Path : v4/googleAudiences
HTTP Method : GET
Flat Path : v4/googleAudiences
▼ ▲ displayvideo.media.download
Parameter Order : resourceName
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.
HTTP Method : GET
Path : download/{+resourceName}
Flat Path : download/{downloadId}
Supportsmediadownload : Yes
Scopes :
Parameters :
resourceName
Type : string
Location : path
Required : Yes
Description : Name of the media that is being downloaded. See ReadRequest.resource_name.
Pattern : ^.*$
▼ ▲ displayvideo.media.upload
Flat Path : media/{mediaId}
Path : media/{+resourceName}
Scopes :
Parameters :
resourceName
Pattern : ^.*$
Required : Yes
Description : Name of the media that is being downloaded. See ReadRequest.resource_name.
Type : string
Location : path
Parameter Order : resourceName
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.
Mediaupload :
Accept : */*
Protocols :
Simple :
Path : /upload/media/{+resourceName}
Multipart : Yes
HTTP Method : POST
Supportsmediaupload : Yes
▼ ▲ displayvideo.users.create
Path : v4/users
Scopes : https://www.googleapis.com/auth/display-video-user-management
HTTP Method : POST
Flat Path : v4/users
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.
▼ ▲ displayvideo.users.bulkEditAssignedUserRoles
Parameter Order : userId
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.
Parameters :
userId
Format : int64
Type : string
Location : path
Required : Yes
Pattern : ^[^/]+$
Description : Required. The ID of the user to which the assigned user roles belong.
Scopes : https://www.googleapis.com/auth/display-video-user-management
Flat Path : v4/users/{usersId}:bulkEditAssignedUserRoles
HTTP Method : POST
Path : v4/users/{+userId}:bulkEditAssignedUserRoles
▼ ▲ displayvideo.users.delete
Scopes : https://www.googleapis.com/auth/display-video-user-management
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.
Flat Path : v4/users/{usersId}
Path : v4/users/{+userId}
Parameters :
userId
Description : Required. The ID of the user to delete.
Format : int64
Pattern : ^[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : userId
HTTP Method : DELETE
▼ ▲ displayvideo.users.patch
HTTP Method : PATCH
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.
Scopes : https://www.googleapis.com/auth/display-video-user-management
Path : v4/users/{+userId}
Parameters :
userId
Type : string
Required : Yes
Pattern : ^[^/]+$
Location : path
Format : int64
Description : Output only. The unique ID of the user. Assigned by the system.
updateMask
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Type : string
Location : query
Parameter Order : userId
Flat Path : v4/users/{usersId}
▼ ▲ displayvideo.users.list
Parameters :
pageSize
Format : int32
Type : integer
Location : query
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
filter
Location : query
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.
orderBy
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`.
Location : query
pageToken
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.
Location : query
Type : string
Path : v4/users
Scopes : https://www.googleapis.com/auth/display-video-user-management
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.
HTTP Method : GET
Flat Path : v4/users
▼ ▲ displayvideo.users.get
Flat Path : v4/users/{usersId}
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.
Parameters :
userId
Description : Required. The ID of the user to fetch.
Type : string
Pattern : ^[^/]+$
Required : Yes
Location : path
Format : int64
Parameter Order : userId
Scopes : https://www.googleapis.com/auth/display-video-user-management
HTTP Method : GET
Path : v4/users/{+userId}
▼ ▲ displayvideo.guaranteedOrders.create
Parameters :
advertiserId
Format : int64
Type : string
Location : query
Description : The ID of the advertiser that the request is being made within.
partnerId
Description : The ID of the partner that the request is being made within.
Location : query
Format : int64
Type : string
Path : v4/guaranteedOrders
Flat Path : v4/guaranteedOrders
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/display-video
Description : Creates a new guaranteed order. Returns the newly created guaranteed order if successful.
▼ ▲ displayvideo.guaranteedOrders.list
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/guaranteedOrders
Parameters :
partnerId
Location : query
Description : The ID of the partner that has access to the guaranteed order.
Format : int64
Type : string
filter
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.
Location : query
Type : string
pageSize
Type : integer
Format : int32
Location : query
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
orderBy
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`.
Location : query
advertiserId
Format : int64
Type : string
Description : The ID of the advertiser that has access to the guaranteed order.
Location : query
pageToken
Location : query
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.
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.
Flat Path : v4/guaranteedOrders
HTTP Method : GET
▼ ▲ displayvideo.guaranteedOrders.patch
Path : v4/guaranteedOrders/{+guaranteedOrderId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
updateMask
Type : string
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Location : query
advertiserId
Location : query
Type : string
Description : The ID of the advertiser that the request is being made within.
Format : int64
partnerId
Description : The ID of the partner that the request is being made within.
Type : string
Format : int64
Location : query
guaranteedOrderId
Required : Yes
Pattern : ^[^/]+$
Description : Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
Location : path
Type : string
Parameter Order : guaranteedOrderId
Description : Updates an existing guaranteed order. Returns the updated guaranteed order if successful.
Flat Path : v4/guaranteedOrders/{guaranteedOrdersId}
HTTP Method : PATCH
▼ ▲ displayvideo.guaranteedOrders.get
Description : Gets a guaranteed order.
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/guaranteedOrders/{guaranteedOrdersId}
Path : v4/guaranteedOrders/{+guaranteedOrderId}
HTTP Method : GET
Parameter Order : guaranteedOrderId
Parameters :
partnerId
Type : string
Location : query
Format : int64
Description : The ID of the partner that has access to the guaranteed order.
guaranteedOrderId
Location : path
Required : Yes
Type : string
Description : Required. The ID of the guaranteed order to fetch. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`
Pattern : ^[^/]+$
advertiserId
Type : string
Format : int64
Description : The ID of the advertiser that has access to the guaranteed order.
Location : query
▼ ▲ displayvideo.guaranteedOrders.editGuaranteedOrderReadAccessors
Path : v4/guaranteedOrders/{+guaranteedOrderId}:editGuaranteedOrderReadAccessors
Parameters :
guaranteedOrderId
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of the guaranteed order to edit. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`
Flat Path : v4/guaranteedOrders/{guaranteedOrdersId}:editGuaranteedOrderReadAccessors
Description : Edits read advertisers of a guaranteed order.
Parameter Order : guaranteedOrderId
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
▼ ▲ displayvideo.customBiddingAlgorithms.rules.create
Parameter Order : customBiddingAlgorithmId
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Type : string
Format : int64
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Location : query
partnerId
Description : The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this rules resource.
Format : int64
Type : string
Location : query
customBiddingAlgorithmId
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules
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.
HTTP Method : POST
▼ ▲ displayvideo.customBiddingAlgorithms.rules.list
HTTP Method : GET
Description : Lists rules resources that belong to the given algorithm. The order is defined by the order_by parameter.
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules
Parameters :
pageToken
Location : query
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.
Type : string
orderBy
Location : query
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`.
customBiddingAlgorithmId
Location : path
Required : Yes
Type : string
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
partnerId
Description : The ID of the partner that owns the parent custom bidding algorithm.
Location : query
Type : string
Format : int64
advertiserId
Type : string
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Location : query
Format : int64
pageSize
Type : integer
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.
Location : query
Format : int32
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : customBiddingAlgorithmId
▼ ▲ displayvideo.customBiddingAlgorithms.rules.get
HTTP Method : GET
Parameter Order :
Description : Retrieves a rules resource.
Parameters :
partnerId
Format : int64
Type : string
Description : The ID of the partner that owns the parent custom bidding algorithm.
Location : query
customBiddingAlgorithmRulesId
Type : string
Location : path
Pattern : ^[^/]+$
Format : int64
Description : Required. The ID of the rules resource to fetch.
Required : Yes
customBiddingAlgorithmId
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Pattern : ^[^/]+$
Required : Yes
Format : int64
Location : path
Type : string
advertiserId
Format : int64
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Type : string
Location : query
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules/{rulesId}
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules/{+customBiddingAlgorithmRulesId}
▼ ▲ displayvideo.customBiddingAlgorithms.scripts.create
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.
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts
Parameter Order : customBiddingAlgorithmId
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts
Parameters :
partnerId
Format : int64
Location : query
Type : string
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.
advertiserId
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Location : query
Type : string
Format : int64
customBiddingAlgorithmId
Location : path
Description : Required. The ID of the custom bidding algorithm that owns the script.
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
▼ ▲ displayvideo.customBiddingAlgorithms.scripts.get
Parameter Order :
HTTP Method : GET
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts/{scriptsId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
customBiddingScriptId
Location : path
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of the custom bidding script to fetch.
Required : Yes
Format : int64
advertiserId
Type : string
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Format : int64
Location : query
partnerId
Format : int64
Location : query
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.
Type : string
customBiddingAlgorithmId
Location : path
Required : Yes
Pattern : ^[^/]+$
Format : int64
Description : Required. The ID of the custom bidding algorithm owns the script.
Type : string
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts/{+customBiddingScriptId}
Description : Gets a custom bidding script.
▼ ▲ displayvideo.customBiddingAlgorithms.scripts.list
Parameter Order : customBiddingAlgorithmId
Parameters :
pageToken
Type : string
Location : query
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.
customBiddingAlgorithmId
Type : string
Format : int64
Description : Required. The ID of the custom bidding algorithm owns the script.
Location : path
Pattern : ^[^/]+$
Required : Yes
orderBy
Location : query
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`.
partnerId
Type : string
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.
Format : int64
Location : query
pageSize
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.
Location : query
Format : int32
Type : integer
advertiserId
Format : int64
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Type : string
Location : query
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Description : Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter.
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts
▼ ▲ displayvideo.customBiddingAlgorithms.uploadRules
Parameters :
customBiddingAlgorithmId
Location : path
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Format : int64
partnerId
Format : int64
Type : string
Location : query
Description : The ID of the partner that owns the parent custom bidding algorithm.
advertiserId
Type : string
Format : int64
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Location : query
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}:uploadRules
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.
Parameter Order : customBiddingAlgorithmId
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadRules
▼ ▲ displayvideo.customBiddingAlgorithms.get
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}
Scopes : https://www.googleapis.com/auth/display-video
Description : Gets a custom bidding algorithm.
HTTP Method : GET
Parameter Order : customBiddingAlgorithmId
Parameters :
partnerId
Location : query
Type : string
Format : int64
Description : The ID of the DV360 partner that has access to the custom bidding algorithm.
advertiserId
Location : query
Type : string
Description : The ID of the DV360 partner that has access to the custom bidding algorithm.
Format : int64
customBiddingAlgorithmId
Description : Required. The ID of the custom bidding algorithm to fetch.
Format : int64
Type : string
Pattern : ^[^/]+$
Required : Yes
Location : path
▼ ▲ displayvideo.customBiddingAlgorithms.uploadScript
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Type : string
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.
Location : query
Format : int64
advertiserId
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Format : int64
Type : string
Location : query
customBiddingAlgorithmId
Format : int64
Required : Yes
Location : path
Description : Required. The ID of the custom bidding algorithm owns the script.
Pattern : ^[^/]+$
Type : string
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadScript
HTTP Method : GET
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.
Parameter Order : customBiddingAlgorithmId
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}:uploadScript
▼ ▲ displayvideo.customBiddingAlgorithms.list
Path : v4/customBiddingAlgorithms
HTTP Method : GET
Flat Path : v4/customBiddingAlgorithms
Scopes : https://www.googleapis.com/auth/display-video
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.
Parameters :
advertiserId
Format : int64
Location : query
Description : The ID of the DV360 advertiser that has access to the custom bidding algorithm.
Type : string
orderBy
Location : query
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`.
Type : string
pageToken
Type : string
Location : query
Description : A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingAlgorithms` method. If not specified, the first page of results will be returned.
pageSize
Location : query
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.
Format : int32
Type : integer
filter
Location : query
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.
Type : string
partnerId
Description : The ID of the DV360 partner that has access to the custom bidding algorithm.
Location : query
Type : string
Format : int64
▼ ▲ displayvideo.customBiddingAlgorithms.patch
HTTP Method : PATCH
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.
Parameter Order : customBiddingAlgorithmId
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}
Parameters :
customBiddingAlgorithmId
Description : Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
Location : path
Pattern : ^[^/]+$
Format : int64
Type : string
Required : Yes
updateMask
Description : Required. The mask to control which fields to update.
Location : query
Format : google-fieldmask
Type : string
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}
▼ ▲ displayvideo.customBiddingAlgorithms.create
Path : v4/customBiddingAlgorithms
Description : Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.
Flat Path : v4/customBiddingAlgorithms
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST