2026-10-22
▼ ▲ displayvideo.targetingTypes.targetingOptions.get
Path : v5/targetingTypes/{+targetingType}/targetingOptions/{+targetingOptionId}
Description : Gets a single targeting option.
Parameters :
advertiserId
Format : int64
Type : string
Location : query
Description : Required. The Advertiser this request is being made in the context of.
targetingType
Enum :
Pattern : ^[^/]+$
Required : Yes
Enum Descriptions :
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`
Location : path
Type : string
targetingOptionId
Location : path
Pattern : ^[^/]+$
Required : Yes
Description : Required. The ID of the of targeting option to retrieve.
Type : string
HTTP Method : GET
Flat Path : v5/targetingTypes/{targetingTypesId}/targetingOptions/{targetingOptionsId}
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
▼ ▲ displayvideo.targetingTypes.targetingOptions.list
Parameters :
advertiserId
Format : int64
Type : string
Description : Required. The Advertiser this request is being made in the context of.
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 `ListTargetingOptions` method. If not specified, the first page of results will be returned.
targetingType
Enum Descriptions :
Enum :
Required : Yes
Location : path
Pattern : ^[^/]+$
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`
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.
Type : string
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
orderBy
Type : string
Location : query
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`.
Path : v5/targetingTypes/{+targetingType}/targetingOptions
Flat Path : v5/targetingTypes/{targetingTypesId}/targetingOptions
Parameter Order : targetingType
Description : Lists targeting options of a given type.
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
▼ ▲ displayvideo.targetingTypes.targetingOptions.search
Path : v5/targetingTypes/{+targetingType}/targetingOptions:search
Parameters :
targetingType
Location : path
Description : Required. The type of targeting options to retrieve. Accepted values are: * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_BUSINESS_CHAIN`
Type : string
Enum Descriptions :
Required : Yes
Pattern : ^[^/]+$
Enum :
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/targetingTypes/{targetingTypesId}/targetingOptions:search
HTTP Method : POST
Description : Searches for targeting options of a given type based on the given search terms.
Parameter Order : targetingType
▼ ▲ displayvideo.partners.list
HTTP Method : GET
Path : v5/partners
Flat Path : v5/partners
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
Parameters :
orderBy
Location : query
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`.
Type : string
pageSize
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Type : integer
Format : int32
Location : query
filter
Location : query
Type : string
Description : Allows filtering by partner fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `entityStatus` Examples: * All active partners: `entityStatus="ENTITY_STATUS_ACTIVE"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
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 `ListPartners` method. If not specified, the first page of results will be returned.
▼ ▲ displayvideo.partners.editAssignedTargetingOptions
Parameters :
partnerId
Location : path
Format : int64
Description : Required. The ID of the partner.
Required : Yes
Type : string
Pattern : ^[^/]+$
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 .
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : partnerId
Flat Path : v5/partners/{partnersId}:editAssignedTargetingOptions
HTTP Method : POST
Path : v5/partners/{+partnerId}:editAssignedTargetingOptions
▼ ▲ displayvideo.partners.get
Description : Gets a partner.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/partners/{+partnerId}
Flat Path : v5/partners/{partnersId}
Parameter Order : partnerId
Parameters :
partnerId
Description : Required. The ID of the partner to fetch.
Required : Yes
Location : path
Pattern : ^[^/]+$
Format : int64
Type : string
▼ ▲ displayvideo.partners.inventorySources.get
Flat Path : v5/partners/{partnersId}/inventorySources/{inventorySourcesId}
Parameters :
inventorySourceId
Location : path
Format : int64
Pattern : ^[^/]+$
Type : string
Required : Yes
Description : Required. The ID of the inventory source deal to fetch.
partnerId
Description : The ID of the DV360 partner.
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Type : string
advertiserId
Location : query
Format : int64
Description : The ID of the DV360 advertiser.
Type : string
Description : Gets an inventory source deal.
HTTP Method : GET
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/partners/{+partnerId}/inventorySources/{+inventorySourceId}
▼ ▲ displayvideo.partners.inventorySources.list
Path : v5/partners/{+partnerId}/inventorySources
Flat Path : v5/partners/{partnersId}/inventorySources
HTTP Method : GET
Parameters :
filter
Description : Optional. 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
Location : query
pageSize
Type : integer
Description : Optional. Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Location : query
Format : int32
advertiserId
Description : The ID of the DV360 advertiser.
Location : query
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 `ListInventorySources` method. If not specified, the first page of results will be returned.
partnerId
Description : The ID of the DV360 partner.
Required : Yes
Format : int64
Location : path
Pattern : ^[^/]+$
Type : string
orderBy
Location : query
Description : Optional. 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`.
Type : string
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : partnerId
Description : Lists inventory source deals.
▼ ▲ displayvideo.partners.channels.list
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
pageSize
Format : int32
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.
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 `ListChannels` method. If not specified, the first page of results will be returned.
Location : query
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
partnerId
Format : int64
Location : path
Description : The ID of the partner that owns the channels.
Type : string
Required : Yes
Pattern : ^[^/]+$
advertiserId
Location : query
Format : int64
Description : The ID of the advertiser that owns the channels.
Type : string
orderBy
Location : query
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`.
Type : string
Parameter Order : partnerId
Path : v5/partners/{+partnerId}/channels
Flat Path : v5/partners/{partnersId}/channels
Description : Lists channels for a partner or advertiser.
HTTP Method : GET
▼ ▲ displayvideo.partners.channels.create
HTTP Method : POST
Parameter Order : partnerId
Flat Path : v5/partners/{partnersId}/channels
Path : v5/partners/{+partnerId}/channels
Scopes : https://www.googleapis.com/auth/display-video
Description : Creates a new channel. Returns the newly created channel if successful.
Parameters :
partnerId
Location : path
Required : Yes
Description : The ID of the partner that owns the created channel.
Format : int64
Type : string
Pattern : ^[^/]+$
advertiserId
Location : query
Format : int64
Type : string
Description : The ID of the advertiser that owns the created channel.
▼ ▲ displayvideo.partners.channels.patch
Parameter Order :
Parameters :
updateMask
Type : string
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Location : query
channelId
Format : int64
Type : string
Required : Yes
Description : Output only. The unique ID of the channel. Assigned by the system.
Location : path
advertiserId
Format : int64
Description : The ID of the advertiser that owns the created channel.
Location : query
Type : string
partnerId
Format : int64
Location : path
Type : string
Required : Yes
Description : The ID of the partner that owns the created channel.
Pattern : ^[^/]+$
Description : Updates a channel. Returns the updated channel if successful.
Path : v5/partners/{+partnerId}/channels/{channelId}
Flat Path : v5/partners/{partnersId}/channels/{channelId}
HTTP Method : PATCH
▼ ▲ displayvideo.partners.channels.get
HTTP Method : GET
Path : v5/partners/{+partnerId}/channels/{+channelId}
Flat Path : v5/partners/{partnersId}/channels/{channelsId}
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Description : Gets a channel for a partner or advertiser.
Parameters :
channelId
Type : string
Format : int64
Description : Required. The ID of the channel to fetch.
Pattern : ^[^/]+$
Required : Yes
Location : path
advertiserId
Type : string
Description : The ID of the advertiser that owns the fetched channel.
Format : int64
Location : query
partnerId
Type : string
Pattern : ^[^/]+$
Description : The ID of the partner that owns the fetched channel.
Required : Yes
Format : int64
Location : path
▼ ▲ displayvideo.partners.channels.sites.replace
HTTP Method : POST
Flat Path : v5/partners/{partnerId}/channels/{channelsId}/sites:replace
Path : v5/partners/{partnerId}/channels/{+channelId}/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.
Parameter Order :
Parameters :
channelId
Type : string
Location : path
Required : Yes
Description : Required. The ID of the parent channel whose sites will be replaced.
Pattern : ^[^/]+$
Format : int64
partnerId
Required : Yes
Type : string
Location : path
Format : int64
Description : The ID of the partner that owns the parent channel.
▼ ▲ displayvideo.partners.channels.sites.bulkEdit
Parameter Order :
HTTP Method : POST
Flat Path : v5/partners/{partnerId}/channels/{channelsId}/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.
Path : v5/partners/{partnerId}/channels/{+channelId}/sites:bulkEdit
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
channelId
Description : Required. The ID of the parent channel to which the sites belong.
Type : string
Pattern : ^[^/]+$
Location : path
Format : int64
Required : Yes
partnerId
Format : int64
Required : Yes
Location : path
Type : string
Description : The ID of the partner that owns the parent channel.
▼ ▲ displayvideo.partners.channels.sites.create
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Flat Path : v5/partners/{partnerId}/channels/{channelsId}/sites
Path : v5/partners/{partnerId}/channels/{+channelId}/sites
Description : Creates a site in a channel.
Parameters :
channelId
Description : Required. The ID of the parent channel in which the site will be created.
Type : string
Format : int64
Pattern : ^[^/]+$
Location : path
Required : Yes
partnerId
Format : int64
Type : string
Required : Yes
Location : path
Description : The ID of the partner that owns the parent channel.
advertiserId
Description : The ID of the advertiser that owns the parent channel.
Type : string
Location : query
Format : int64
Parameter Order :
▼ ▲ displayvideo.partners.channels.sites.delete
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/partners/{partnerId}/channels/{+channelId}/sites/{+urlOrAppId}
HTTP Method : DELETE
Flat Path : v5/partners/{partnerId}/channels/{channelsId}/sites/{sitesId}
Parameter Order :
Parameters :
advertiserId
Format : int64
Description : The ID of the advertiser that owns the parent channel.
Location : query
Type : string
channelId
Type : string
Description : Required. The ID of the parent channel to which the site belongs.
Required : Yes
Location : path
Format : int64
Pattern : ^[^/]+$
urlOrAppId
Description : Required. The URL or app ID of the site to delete.
Pattern : ^[^/]+$
Location : path
Type : string
Required : Yes
partnerId
Required : Yes
Type : string
Description : The ID of the partner that owns the parent channel.
Location : path
Format : int64
Description : Deletes a site from a channel.
▼ ▲ displayvideo.partners.channels.sites.list
Scopes : https://www.googleapis.com/auth/display-video
Description : Lists sites in a channel.
HTTP Method : GET
Flat Path : v5/partners/{partnersId}/channels/{channelsId}/sites
Path : v5/partners/{+partnerId}/channels/{+channelId}/sites
Parameter Order :
Parameters :
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 `ListSites` method. If not specified, the first page of results will be returned.
filter
Type : string
Location : query
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.
channelId
Type : string
Description : Required. The ID of the parent channel to which the requested sites belong.
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
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
Format : int32
Type : integer
partnerId
Format : int64
Description : The ID of the partner that owns the parent channel.
Pattern : ^[^/]+$
Location : path
Required : Yes
Type : string
advertiserId
Type : string
Location : query
Description : The ID of the advertiser that owns the parent channel.
Format : int64
orderBy
Type : string
Location : query
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`.
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.create
Parameters :
targetingType
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Pattern : ^[^/]+$
Enum :
Enum Descriptions :
Required : Yes
Type : string
Location : path
partnerId
Description : Required. The ID of the partner.
Type : string
Pattern : ^[^/]+$
Location : path
Format : int64
Required : Yes
Path : v5/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Parameter Order :
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/display-video
Description : Assigns a targeting option to a partner. Returns the assigned targeting option if successful.
Flat Path : v5/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.delete
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
targetingType
Required : Yes
Enum Descriptions :
Pattern : ^[^/]+$
Type : string
Location : path
Enum :
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
partnerId
Description : Required. The ID of the partner.
Location : path
Format : int64
Type : string
Required : Yes
Pattern : ^[^/]+$
assignedTargetingOptionId
Type : string
Description : Required. The ID of the assigned targeting option to delete.
Pattern : ^[^/]+$
Required : Yes
Location : path
Description : Deletes an assigned targeting option from a partner.
Parameter Order :
Path : v5/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Flat Path : v5/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
HTTP Method : DELETE
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.list
Flat Path : v5/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions
HTTP Method : GET
Description : Lists the targeting options assigned to a partner.
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.
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 `ListPartnerAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
filter
Location : query
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
orderBy
Type : string
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`.
partnerId
Format : int64
Description : Required. The ID of the partner.
Type : string
Location : path
Pattern : ^[^/]+$
Required : Yes
targetingType
Required : Yes
Location : path
Enum :
Pattern : ^[^/]+$
Enum Descriptions :
Type : string
Description : Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Parameter Order :
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.get
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Path : v5/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Parameter Order :
Description : Gets a single targeting option assigned to a partner.
Parameters :
targetingType
Enum Descriptions :
Type : string
Pattern : ^[^/]+$
Location : path
Enum :
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Required : Yes
partnerId
Type : string
Location : path
Format : int64
Required : Yes
Description : Required. The ID of the partner.
Pattern : ^[^/]+$
assignedTargetingOptionId
Description : Required. An identifier unique to the targeting type in this partner that identifies the assigned targeting option being requested.
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
▼ ▲ displayvideo.combinedAudiences.list
Path : v5/combinedAudiences
Description : Lists combined audiences. The order is defined by the order_by parameter.
Parameters :
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 `ListCombinedAudiences` method. If not specified, the first page of results will be returned.
Location : query
Type : string
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.
Type : integer
Format : int32
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.
Type : string
Location : query
advertiserId
Type : string
Format : int64
Location : query
Description : The ID of the advertiser that has access to the fetched combined audiences.
partnerId
Location : query
Description : The ID of the partner that has access to the fetched combined audiences.
Type : string
Format : int64
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `combinedAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
Flat Path : v5/combinedAudiences
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
▼ ▲ displayvideo.combinedAudiences.get
Description : Gets a combined audience.
HTTP Method : GET
Parameter Order : combinedAudienceId
Flat Path : v5/combinedAudiences/{combinedAudiencesId}
Parameters :
combinedAudienceId
Location : path
Format : int64
Required : Yes
Description : Required. The ID of the combined audience to fetch.
Type : string
Pattern : ^[^/]+$
advertiserId
Format : int64
Type : string
Location : query
Description : The ID of the advertiser that has access to the fetched combined audience.
partnerId
Description : The ID of the partner that has access to the fetched combined audience.
Type : string
Location : query
Format : int64
Path : v5/combinedAudiences/{+combinedAudienceId}
▼ ▲ displayvideo.floodlightGroups.patch
Parameter Order : floodlightGroupId
Parameters :
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Type : string
floodlightGroupId
Format : int64
Description : Output only. The unique ID of the Floodlight group. Assigned by the system.
Location : path
Type : string
Required : Yes
partnerId
Description : Required. The partner context by which the Floodlight group is being accessed.
Location : query
Type : string
Format : int64
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/floodlightGroups/{floodlightGroupId}
Description : Updates an existing Floodlight group. Returns the updated Floodlight group if successful.
HTTP Method : PATCH
Path : v5/floodlightGroups/{floodlightGroupId}
▼ ▲ displayvideo.floodlightGroups.get
Description : Gets a Floodlight group.
Parameter Order : floodlightGroupId
Parameters :
floodlightGroupId
Required : Yes
Description : Required. The ID of the Floodlight group to fetch.
Pattern : ^[^/]+$
Type : string
Location : path
Format : int64
partnerId
Format : int64
Type : string
Description : Required. The partner context by which the Floodlight group is being accessed.
Location : query
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/floodlightGroups/{floodlightGroupsId}
HTTP Method : GET
Path : v5/floodlightGroups/{+floodlightGroupId}
▼ ▲ displayvideo.floodlightGroups.floodlightActivities.get
HTTP Method : GET
Parameter Order :
Path : v5/floodlightGroups/{+floodlightGroupId}/floodlightActivities/{+floodlightActivityId}
Description : Gets a Floodlight activity.
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/floodlightGroups/{floodlightGroupsId}/floodlightActivities/{floodlightActivitiesId}
Parameters :
floodlightGroupId
Location : path
Required : Yes
Description : Required. The ID of the parent Floodlight group to which the requested Floodlight activity belongs.
Pattern : ^[^/]+$
Type : string
Format : int64
floodlightActivityId
Type : string
Description : Required. The ID of the Floodlight activity to fetch.
Pattern : ^[^/]+$
Format : int64
Required : Yes
Location : path
partnerId
Type : string
Format : int64
Description : Required. The ID of the partner through which the Floodlight activity is being accessed.
Location : query
▼ ▲ displayvideo.floodlightGroups.floodlightActivities.list
Parameters :
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`.
Location : query
Type : string
floodlightGroupId
Format : int64
Location : path
Description : Required. The ID of the parent Floodlight group to which the requested Floodlight activities belong.
Required : Yes
Type : string
Pattern : ^[^/]+$
partnerId
Type : string
Location : query
Description : Required. The ID of the partner through which the Floodlight activities are being accessed.
Format : int64
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 `ListFloodlightActivities` method. If not specified, the first page of results will be returned.
pageSize
Location : query
Type : integer
Format : int32
Description : Optional. Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Description : Lists Floodlight activities in a Floodlight group.
Path : v5/floodlightGroups/{+floodlightGroupId}/floodlightActivities
Flat Path : v5/floodlightGroups/{floodlightGroupsId}/floodlightActivities
Parameter Order : floodlightGroupId
HTTP Method : GET
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.list
Parameters :
partnerId
Type : string
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.
Format : int64
Location : query
inventorySourceGroupId
Required : Yes
Type : string
Description : Required. The ID of the inventory source group to which these assignments are assigned.
Pattern : ^[^/]+$
Location : path
Format : int64
pageSize
Location : query
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.
Type : integer
Format : int32
filter
Location : query
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.
Type : string
advertiserId
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.
Format : int64
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 `ListAssignedInventorySources` method. If not specified, the first page of results will be returned.
Location : query
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `assignedInventorySourceId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `assignedInventorySourceId desc`.
Flat Path : v5/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources
Description : Lists inventory sources assigned to an inventory source group.
Parameter Order : inventorySourceGroupId
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources
HTTP Method : GET
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.bulkEdit
HTTP Method : POST
Parameter Order : inventorySourceGroupId
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.
Path : v5/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources:bulkEdit
Parameters :
inventorySourceGroupId
Location : path
Required : Yes
Type : string
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the inventory source group to which the assignments are assigned.
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources:bulkEdit
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.create
Parameter Order : inventorySourceGroupId
Parameters :
inventorySourceGroupId
Pattern : ^[^/]+$
Type : string
Location : path
Required : Yes
Description : Required. The ID of the inventory source group to which the assignment will be assigned.
Format : int64
advertiserId
Format : int64
Type : string
Location : query
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.
partnerId
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.
Type : string
Location : query
Format : int64
Path : v5/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources
Flat Path : v5/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources
Description : Creates an assignment between an inventory source and an inventory source group.
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.delete
Path : v5/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources/{+assignedInventorySourceId}
Parameters :
inventorySourceGroupId
Format : int64
Location : path
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the inventory source group to which this assignment is assigned.
advertiserId
Location : query
Format : int64
Description : The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to this assigned inventory source.
Type : string
assignedInventorySourceId
Format : int64
Location : path
Description : Required. The ID of the assigned inventory source to delete.
Pattern : ^[^/]+$
Type : string
Required : Yes
partnerId
Type : string
Format : int64
Description : The ID of the partner that owns the parent inventory source group. Only this partner has write access to this assigned inventory source.
Location : query
Parameter Order :
Flat Path : v5/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources/{assignedInventorySourcesId}
HTTP Method : DELETE
Description : Deletes the assignment between an inventory source and an inventory source group.
▼ ▲ displayvideo.inventorySourceGroups.list
Parameters :
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.
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `displayName` (default) * `inventorySourceGroupId` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
partnerId
Format : int64
Location : query
Description : The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups.
Type : string
filter
Type : string
Location : query
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.
pageSize
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Type : integer
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 `ListInventorySources` method. If not specified, the first page of results will be returned.
Location : query
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/inventorySourceGroups
Path : v5/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.create
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.
Location : query
Type : string
advertiserId
Type : string
Description : The ID of the advertiser that owns the inventory source group. The parent partner will not have access to this group.
Format : int64
Location : query
Description : Creates a new inventory source group. Returns the newly created inventory source group if successful.
Path : v5/inventorySourceGroups
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/inventorySourceGroups
HTTP Method : POST
▼ ▲ displayvideo.inventorySourceGroups.delete
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : inventorySourceGroupId
Description : Deletes an inventory source group.
Parameters :
inventorySourceGroupId
Pattern : ^[^/]+$
Type : string
Format : int64
Required : Yes
Description : Required. The ID of the inventory source group to delete.
Location : path
partnerId
Location : query
Format : int64
Type : string
Description : The ID of the partner that owns the inventory source group. Only this partner has write access to this group.
advertiserId
Location : query
Type : string
Format : int64
Description : The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.
Path : v5/inventorySourceGroups/{+inventorySourceGroupId}
Flat Path : v5/inventorySourceGroups/{inventorySourceGroupsId}
▼ ▲ displayvideo.inventorySourceGroups.patch
Path : v5/inventorySourceGroups/{inventorySourceGroupId}
Flat Path : v5/inventorySourceGroups/{inventorySourceGroupId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Type : string
Format : google-fieldmask
partnerId
Description : The ID of the partner that owns the inventory source group. Only this partner has write access to this group.
Format : int64
Location : query
Type : string
inventorySourceGroupId
Description : Output only. The unique ID of the inventory source group. Assigned by the system.
Required : Yes
Type : string
Format : int64
Location : path
advertiserId
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.
Type : string
Description : Updates an inventory source group. Returns the updated inventory source group if successful.
HTTP Method : PATCH
Parameter Order : inventorySourceGroupId
▼ ▲ displayvideo.inventorySourceGroups.get
Path : v5/inventorySourceGroups/{+inventorySourceGroupId}
Parameters :
partnerId
Type : string
Description : The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group.
Format : int64
Location : query
inventorySourceGroupId
Type : string
Pattern : ^[^/]+$
Format : int64
Required : Yes
Location : path
Description : Required. The ID of the inventory source group to fetch.
advertiserId
Location : query
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.
Type : string
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/inventorySourceGroups/{inventorySourceGroupsId}
Parameter Order : inventorySourceGroupId
HTTP Method : GET
Description : Gets an inventory source group.
▼ ▲ displayvideo.guaranteedOrders.get
Parameter Order : guaranteedOrderId
Scopes : https://www.googleapis.com/auth/display-video
Description : Gets a guaranteed order.
Path : v5/guaranteedOrders/{+guaranteedOrderId}
HTTP Method : GET
Parameters :
advertiserId
Type : string
Description : The ID of the advertiser that has access to the guaranteed order.
Format : int64
Location : query
guaranteedOrderId
Description : Required. The ID of the guaranteed order to fetch. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
partnerId
Description : The ID of the partner that has access to the guaranteed order.
Type : string
Format : int64
Location : query
Flat Path : v5/guaranteedOrders/{guaranteedOrdersId}
▼ ▲ displayvideo.guaranteedOrders.editGuaranteedOrderReadAccessors
Parameter Order : guaranteedOrderId
Flat Path : v5/guaranteedOrders/{guaranteedOrdersId}:editGuaranteedOrderReadAccessors
Path : v5/guaranteedOrders/{+guaranteedOrderId}:editGuaranteedOrderReadAccessors
HTTP Method : POST
Description : Edits read advertisers of a guaranteed order.
Parameters :
guaranteedOrderId
Pattern : ^[^/]+$
Description : Required. The ID of the guaranteed order to edit. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`
Type : string
Location : path
Required : Yes
▼ ▲ displayvideo.guaranteedOrders.patch
Path : v5/guaranteedOrders/{+guaranteedOrderId}
Parameters :
advertiserId
Description : The ID of the advertiser that the request is being made within.
Location : query
Format : int64
Type : string
updateMask
Description : Required. The mask to control which fields to update.
Type : string
Location : query
Format : google-fieldmask
guaranteedOrderId
Pattern : ^[^/]+$
Description : Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
Type : string
Required : Yes
Location : path
partnerId
Type : string
Format : int64
Location : query
Description : The ID of the partner that the request is being made within.
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/guaranteedOrders/{guaranteedOrdersId}
Description : Updates an existing guaranteed order. Returns the updated guaranteed order if successful.
Parameter Order : guaranteedOrderId
HTTP Method : PATCH
▼ ▲ displayvideo.guaranteedOrders.list
Path : v5/guaranteedOrders
HTTP Method : GET
Parameters :
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
orderBy
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`.
Type : string
Location : query
partnerId
Format : int64
Type : string
Description : The ID of the partner that has access to the guaranteed order.
Location : query
pageSize
Type : integer
Format : int32
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Location : query
advertiserId
Format : int64
Description : The ID of the advertiser that has access to the guaranteed order.
Type : string
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.
Flat Path : v5/guaranteedOrders
Scopes : https://www.googleapis.com/auth/display-video
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.
▼ ▲ displayvideo.guaranteedOrders.create
HTTP Method : POST
Path : v5/guaranteedOrders
Description : Creates a new guaranteed order. Returns the newly created guaranteed order 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
Flat Path : v5/guaranteedOrders
▼ ▲ displayvideo.users.bulkEditAssignedUserRoles
Path : v5/users/{+userId}:bulkEditAssignedUserRoles
HTTP Method : POST
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.
Scopes : https://www.googleapis.com/auth/display-video-user-management
Parameters :
userId
Required : Yes
Pattern : ^[^/]+$
Description : Required. The ID of the user to which the assigned user roles belong.
Location : path
Type : string
Format : int64
Flat Path : v5/users/{usersId}:bulkEditAssignedUserRoles
▼ ▲ displayvideo.users.patch
Parameter Order : userId
Scopes : https://www.googleapis.com/auth/display-video-user-management
HTTP Method : PATCH
Flat Path : v5/users/{usersId}
Path : v5/users/{+userId}
Parameters :
updateMask
Format : google-fieldmask
Type : string
Location : query
Description : Required. The mask to control which fields to update.
userId
Location : path
Description : Output only. The unique ID of the user. Assigned by the system.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
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.
▼ ▲ displayvideo.users.create
Path : v5/users
Flat Path : v5/users
Scopes : https://www.googleapis.com/auth/display-video-user-management
HTTP Method : POST
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.delete
Scopes : https://www.googleapis.com/auth/display-video-user-management
Flat Path : v5/users/{usersId}
Parameters :
userId
Format : int64
Type : string
Location : path
Description : Required. The ID of the user to delete.
Pattern : ^[^/]+$
Required : Yes
HTTP Method : DELETE
Parameter Order : userId
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.
Path : v5/users/{+userId}
▼ ▲ displayvideo.users.list
Path : v5/users
HTTP Method : GET
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.
Scopes : https://www.googleapis.com/auth/display-video-user-management
Flat Path : v5/users
Parameters :
pageSize
Location : query
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Type : integer
Format : int32
orderBy
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`.
Type : string
Location : query
filter
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.
Location : query
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 `ListUsers` method. If not specified, the first page of results will be returned.
Location : query
Type : string
▼ ▲ displayvideo.users.get
Scopes : https://www.googleapis.com/auth/display-video-user-management
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.
HTTP Method : GET
Flat Path : v5/users/{usersId}
Parameters :
userId
Required : Yes
Location : path
Format : int64
Description : Required. The ID of the user to fetch.
Type : string
Pattern : ^[^/]+$
Parameter Order : userId
Path : v5/users/{+userId}
▼ ▲ displayvideo.customBiddingAlgorithms.rules.create
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules
HTTP Method : POST
Parameter Order : customBiddingAlgorithmId
Path : v5/customBiddingAlgorithms/{+customBiddingAlgorithmId}/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.
Parameters :
partnerId
Location : query
Format : int64
Description : The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this rules resource.
Type : string
customBiddingAlgorithmId
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Format : int64
advertiserId
Location : query
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Format : int64
Type : string
▼ ▲ displayvideo.customBiddingAlgorithms.rules.get
HTTP Method : GET
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Description : Retrieves a rules resource.
Flat Path : v5/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules/{rulesId}
Parameters :
partnerId
Description : The ID of the partner that owns the parent custom bidding algorithm.
Format : int64
Location : query
Type : string
advertiserId
Format : int64
Type : string
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Location : query
customBiddingAlgorithmRulesId
Required : Yes
Pattern : ^[^/]+$
Location : path
Format : int64
Description : Required. The ID of the rules resource to fetch.
Type : string
customBiddingAlgorithmId
Type : string
Format : int64
Location : path
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Required : Yes
Pattern : ^[^/]+$
Path : v5/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules/{+customBiddingAlgorithmRulesId}
▼ ▲ displayvideo.customBiddingAlgorithms.rules.list
Parameter Order : customBiddingAlgorithmId
Parameters :
orderBy
Location : query
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`.
Type : string
partnerId
Description : The ID of the partner that owns the parent custom bidding algorithm.
Type : string
Location : query
Format : int64
customBiddingAlgorithmId
Type : string
Required : Yes
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Format : int64
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 `ListCustomBiddingAlgorithmRules` method. If not specified, the first page of results will be returned.
advertiserId
Format : int64
Location : query
Type : string
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
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.
Type : integer
Format : int32
Location : query
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules
HTTP Method : GET
Description : Lists rules resources that belong to the given algorithm. The order is defined by the order_by parameter.
Path : v5/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules
▼ ▲ displayvideo.customBiddingAlgorithms.scripts.list
Flat Path : v5/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts
Parameters :
orderBy
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`.
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 `ListCustomBiddingScripts` method. If not specified, the first page of results will be returned.
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.
customBiddingAlgorithmId
Type : string
Location : path
Format : int64
Required : Yes
Pattern : ^[^/]+$
Description : Required. The ID of the custom bidding algorithm owns the script.
advertiserId
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Type : string
Location : query
Format : int64
partnerId
Format : int64
Description : The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
Type : string
Location : query
Path : v5/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts
Description : Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter.
Parameter Order : customBiddingAlgorithmId
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
▼ ▲ displayvideo.customBiddingAlgorithms.scripts.create
Parameters :
advertiserId
Type : string
Format : int64
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Location : query
partnerId
Location : query
Format : int64
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.
customBiddingAlgorithmId
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the custom bidding algorithm that owns the script.
Required : Yes
Type : string
Location : path
Parameter Order : customBiddingAlgorithmId
Path : v5/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts
Flat Path : v5/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts
HTTP Method : POST
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.
▼ ▲ displayvideo.customBiddingAlgorithms.scripts.get
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Description : Gets a custom bidding script.
Flat Path : v5/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts/{scriptsId}
Parameters :
customBiddingAlgorithmId
Pattern : ^[^/]+$
Required : Yes
Description : Required. The ID of the custom bidding algorithm owns the script.
Location : path
Type : string
Format : int64
customBiddingScriptId
Required : Yes
Pattern : ^[^/]+$
Format : int64
Type : string
Location : path
Description : Required. The ID of the custom bidding script to fetch.
advertiserId
Format : int64
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Type : string
Location : query
partnerId
Format : int64
Description : The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
Location : query
Type : string
Path : v5/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts/{+customBiddingScriptId}
▼ ▲ displayvideo.customBiddingAlgorithms.patch
Scopes : https://www.googleapis.com/auth/display-video
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.
HTTP Method : PATCH
Parameters :
updateMask
Type : string
Format : google-fieldmask
Location : query
Description : Required. The mask to control which fields to update.
customBiddingAlgorithmId
Format : int64
Pattern : ^[^/]+$
Type : string
Description : Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
Required : Yes
Location : path
Flat Path : v5/customBiddingAlgorithms/{customBiddingAlgorithmsId}
Path : v5/customBiddingAlgorithms/{+customBiddingAlgorithmId}
Parameter Order : customBiddingAlgorithmId
▼ ▲ displayvideo.customBiddingAlgorithms.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.
Parameters :
partnerId
Location : query
Type : string
Description : The ID of the partner that owns the parent custom bidding algorithm.
Format : int64
customBiddingAlgorithmId
Format : int64
Pattern : ^[^/]+$
Location : path
Type : string
Required : Yes
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
advertiserId
Location : query
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Format : int64
Type : string
HTTP Method : GET
Parameter Order : customBiddingAlgorithmId
Flat Path : v5/customBiddingAlgorithms/{customBiddingAlgorithmsId}:uploadRules
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadRules
▼ ▲ displayvideo.customBiddingAlgorithms.list
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
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.
Path : v5/customBiddingAlgorithms
Flat Path : v5/customBiddingAlgorithms
Parameters :
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.
Location : query
Type : integer
partnerId
Format : int64
Location : query
Type : string
Description : The ID of the DV360 partner that has access to the custom bidding algorithm.
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
orderBy
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`.
Location : query
Type : string
advertiserId
Description : The ID of the DV360 advertiser that has access to the custom bidding algorithm.
Location : query
Type : string
Format : int64
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 `ListCustomBiddingAlgorithms` method. If not specified, the first page of results will be returned.
Location : query
Type : string
▼ ▲ displayvideo.customBiddingAlgorithms.create
Description : Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.
HTTP Method : POST
Path : v5/customBiddingAlgorithms
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/customBiddingAlgorithms
▼ ▲ displayvideo.customBiddingAlgorithms.uploadScript
Parameter Order : customBiddingAlgorithmId
Parameters :
partnerId
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.
Format : int64
advertiserId
Type : string
Location : query
Format : int64
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
customBiddingAlgorithmId
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the custom bidding algorithm owns the script.
Pattern : ^[^/]+$
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.
Path : v5/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadScript
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/customBiddingAlgorithms/{customBiddingAlgorithmsId}:uploadScript
HTTP Method : GET
▼ ▲ displayvideo.customBiddingAlgorithms.get
Parameter Order : customBiddingAlgorithmId
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/customBiddingAlgorithms/{+customBiddingAlgorithmId}
HTTP Method : GET
Description : Gets a custom bidding algorithm.
Parameters :
partnerId
Location : query
Format : int64
Type : string
Description : The ID of the DV360 partner that has access to the custom bidding algorithm.
advertiserId
Location : query
Type : string
Format : int64
Description : The ID of the DV360 partner that has access to the custom bidding algorithm.
customBiddingAlgorithmId
Location : path
Description : Required. The ID of the custom bidding algorithm to fetch.
Required : Yes
Format : int64
Type : string
Pattern : ^[^/]+$
Flat Path : v5/customBiddingAlgorithms/{customBiddingAlgorithmsId}
▼ ▲ displayvideo.lookalikeAudiences.create
Parameters :
advertiserId
Description : Required. The ID of the advertiser under whom the LookalikeAudience will be created.
Type : string
Location : query
Format : int64
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Flat Path : v5/lookalikeAudiences
Path : v5/lookalikeAudiences
Description : Creates a new Lookalike audience. Returns the newly created Lookalike audience if successful.
▼ ▲ displayvideo.lookalikeAudiences.list
Path : v5/lookalikeAudiences
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.
Type : integer
Location : query
Format : int32
partnerId
Format : int64
Location : query
Type : string
Description : The ID of the partner that has access to the fetched Lookalike audiences.
advertiserId
Format : int64
Location : query
Description : The ID of the advertiser that has access to the fetched Lookalike audiences.
Type : string
orderBy
Description : Field by which to sort the list. Acceptable values are: * `lookalikeAudienceId` (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
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 `ListLookalikeAudiences` method. If not specified, the first page of results will be returned.
Type : string
filter
Type : string
Description : Allows filtering by Lookalike audience fields. Supported syntax: * Filter expressions for Lookalike 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 Lookalike audiences for which the display name contains "Lookalike": `displayName:"Lookalike"`. 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
Flat Path : v5/lookalikeAudiences
HTTP Method : GET
Description : Lists Lookalike audiences. The order is defined by the order_by parameter.
▼ ▲ displayvideo.lookalikeAudiences.get
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/lookalikeAudiences/{lookalikeAudiencesId}
Parameters :
partnerId
Location : query
Type : string
Description : The ID of the partner that has access to the fetched Lookalike audience.
Format : int64
advertiserId
Location : query
Description : The ID of the advertiser that has access to the fetched Lookalike audience.
Type : string
Format : int64
lookalikeAudienceId
Location : path
Type : string
Required : Yes
Description : Required. The ID of the Lookalike audience to fetch.
Format : int64
Pattern : ^[^/]+$
Description : Gets a Lookalike audience.
Path : v5/lookalikeAudiences/{+lookalikeAudienceId}
HTTP Method : GET
Parameter Order : lookalikeAudienceId
▼ ▲ displayvideo.customLists.get
Path : v5/customLists/{+customListId}
Description : Gets a custom list.
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameter Order : customListId
Flat Path : v5/customLists/{customListsId}
Parameters :
customListId
Type : string
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the custom list to fetch.
Location : path
Required : Yes
advertiserId
Format : int64
Description : The ID of the DV360 advertiser that has access to the fetched custom lists.
Location : query
Type : string
▼ ▲ displayvideo.customLists.list
HTTP Method : GET
Flat Path : v5/customLists
Parameters :
filter
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.
Location : query
Type : string
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
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 `ListCustomLists` method. If not specified, the first page of results will be returned.
Type : string
Location : query
advertiserId
Type : string
Description : The ID of the DV360 advertiser that has access to the fetched custom lists.
Format : int64
Location : query
Path : v5/customLists
Scopes : https://www.googleapis.com/auth/display-video
Description : Lists custom lists. The order is defined by the order_by parameter.
▼ ▲ displayvideo.advertisers.list
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.
HTTP Method : GET
Path : v5/advertisers
Parameters :
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `advertiserId` (default) * `displayName` * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
partnerId
Location : query
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.
Type : string
Format : int64
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 `ListAdvertisers` method. If not specified, the first page of results will be returned.
filter
Location : query
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.
Type : string
pageSize
Format : int32
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Location : query
Type : integer
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/advertisers
▼ ▲ displayvideo.advertisers.listAssignedTargetingOptions
Description : Lists assigned targeting options of an advertiser across targeting types.
Parameters :
advertiserId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Description : Required. The ID of the advertiser the line item belongs to.
Format : int64
pageToken
Type : string
Description : A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Location : query
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
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
filter
Location : query
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.
Type : string
Flat Path : v5/advertisers/{advertisersId}:listAssignedTargetingOptions
Path : v5/advertisers/{+advertiserId}:listAssignedTargetingOptions
Parameter Order : advertiserId
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
▼ ▲ displayvideo.advertisers.create
Flat Path : v5/advertisers
Scopes : https://www.googleapis.com/auth/display-video
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.
Path : v5/advertisers
HTTP Method : POST
▼ ▲ displayvideo.advertisers.delete
HTTP Method : DELETE
Path : v5/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.
Flat Path : v5/advertisers/{advertisersId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Type : string
Description : The ID of the advertiser we need to delete.
Format : int64
Pattern : ^[^/]+$
Location : path
Required : Yes
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.editAssignedTargetingOptions
Parameter Order : advertiserId
Parameters :
advertiserId
Format : int64
Location : path
Type : string
Required : Yes
Description : Required. The ID of the advertiser.
Pattern : ^[^/]+$
Path : v5/advertisers/{+advertiserId}: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 .
Flat Path : v5/advertisers/{advertisersId}:editAssignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
▼ ▲ displayvideo.advertisers.patch
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : PATCH
Path : v5/advertisers/{+advertiserId}
Parameters :
advertiserId
Description : Output only. The unique ID of the advertiser. Assigned by the system.
Format : int64
Type : string
Required : Yes
Pattern : ^[^/]+$
Location : path
updateMask
Type : string
Location : query
Format : google-fieldmask
Description : Required. The mask to control which fields to update.
Description : Updates an existing advertiser. Returns the updated advertiser if successful.
Parameter Order : advertiserId
Flat Path : v5/advertisers/{advertisersId}
▼ ▲ displayvideo.advertisers.get
Parameters :
advertiserId
Location : path
Type : string
Format : int64
Required : Yes
Description : Required. The ID of the advertiser to fetch.
Pattern : ^[^/]+$
Description : Gets an advertiser.
Path : v5/advertisers/{+advertiserId}
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/advertisers/{advertisersId}
Parameter Order : advertiserId
HTTP Method : GET
▼ ▲ displayvideo.advertisers.audit
HTTP Method : GET
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 : v5/advertisers/{advertisersId}:audit
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Path : v5/advertisers/{+advertiserId}:audit
Parameters :
readMask
Type : string
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
Location : query
Format : google-fieldmask
advertiserId
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser to audit.
Required : Yes
Type : string
Location : path
Format : int64
▼ ▲ displayvideo.advertisers.negativeKeywordLists.create
Path : v5/advertisers/{+advertiserId}/negativeKeywordLists
Parameters :
advertiserId
Pattern : ^[^/]+$
Required : Yes
Description : Required. The ID of the DV360 advertiser to which the negative keyword list will belong.
Location : path
Type : string
Format : int64
Parameter Order : advertiserId
Flat Path : v5/advertisers/{advertisersId}/negativeKeywordLists
Description : Creates a new negative keyword list. Returns the newly created negative keyword list if successful.
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
▼ ▲ displayvideo.advertisers.negativeKeywordLists.delete
Description : Deletes a negative keyword list given an advertiser ID and a negative keyword list ID.
HTTP Method : DELETE
Parameters :
advertiserId
Location : path
Description : Required. The ID of the DV360 advertiser to which the negative keyword list belongs.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Type : string
negativeKeywordListId
Type : string
Location : path
Required : Yes
Pattern : ^[^/]+$
Format : int64
Description : Required. The ID of the negative keyword list to delete.
Path : v5/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}
Parameter Order :
Flat Path : v5/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}
▼ ▲ displayvideo.advertisers.negativeKeywordLists.list
Path : v5/advertisers/{+advertiserId}/negativeKeywordLists
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Description : Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong.
Required : Yes
Location : path
Pattern : ^[^/]+$
Format : int64
Type : string
pageSize
Type : integer
Format : int32
Location : query
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.
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 `ListNegativeKeywordLists` method. If not specified, the first page of results will be returned.
Location : query
HTTP Method : GET
Description : Lists negative keyword lists based on a given advertiser id.
Parameter Order : advertiserId
Flat Path : v5/advertisers/{advertisersId}/negativeKeywordLists
▼ ▲ displayvideo.advertisers.negativeKeywordLists.get
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
negativeKeywordListId
Format : int64
Type : string
Required : Yes
Location : path
Description : Required. The ID of the negative keyword list to fetch.
Pattern : ^[^/]+$
advertiserId
Pattern : ^[^/]+$
Required : Yes
Type : string
Location : path
Description : Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs.
Format : int64
Path : v5/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}
Description : Gets a negative keyword list given an advertiser ID and a negative keyword list ID.
Flat Path : v5/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}
HTTP Method : GET
Parameter Order :
▼ ▲ displayvideo.advertisers.negativeKeywordLists.patch
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/advertisers/{+advertiserId}/negativeKeywordLists/{negativeKeywordListId}
Description : Updates a negative keyword list. Returns the updated negative keyword list if successful.
Parameters :
advertiserId
Type : string
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the DV360 advertiser to which the negative keyword list belongs.
Required : Yes
Location : path
updateMask
Type : string
Description : Required. The mask to control which fields to update.
Location : query
Format : google-fieldmask
negativeKeywordListId
Type : string
Description : Output only. The unique ID of the negative keyword list. Assigned by the system.
Location : path
Format : int64
Required : Yes
HTTP Method : PATCH
Flat Path : v5/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListId}
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.create
Description : Creates a negative keyword in a negative keyword list.
Flat Path : v5/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords
HTTP Method : POST
Parameter Order :
Parameters :
advertiserId
Format : int64
Type : string
Location : path
Required : Yes
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
negativeKeywordListId
Description : Required. The ID of the parent negative keyword list in which the negative keyword will be created.
Pattern : ^[^/]+$
Format : int64
Required : Yes
Type : string
Location : path
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.delete
Flat Path : v5/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords/{negativeKeywordsId}
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
negativeKeywordListId
Pattern : ^[^/]+$
Description : Required. The ID of the parent negative keyword list to which the negative keyword belongs.
Format : int64
Required : Yes
Location : path
Type : string
keywordValue
Type : string
Required : Yes
Location : path
Pattern : ^[^/]+$
Description : Required. The keyword value of the negative keyword to delete.
advertiserId
Type : string
Format : int64
Location : path
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Required : Yes
Path : v5/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords/{+keywordValue}
HTTP Method : DELETE
Description : Deletes a negative keyword from a negative keyword list.
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.replace
HTTP Method : POST
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.
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:replace
Parameter Order :
Flat Path : v5/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:replace
Parameters :
advertiserId
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Required : Yes
Format : int64
Location : path
Type : string
negativeKeywordListId
Required : Yes
Pattern : ^[^/]+$
Description : Required. The ID of the parent negative keyword list to which the negative keywords belong.
Location : path
Format : int64
Type : string
▼ ▲ displayvideo.advertisers.negativeKeywordLists.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.
Path : v5/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:bulkEdit
Parameters :
advertiserId
Location : path
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Type : string
Required : Yes
Format : int64
negativeKeywordListId
Location : path
Description : Required. The ID of the parent negative keyword list to which the negative keywords belong.
Required : Yes
Format : int64
Type : string
Pattern : ^[^/]+$
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Flat Path : v5/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:bulkEdit
Parameter Order :
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.list
HTTP Method : GET
Path : v5/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords
Parameter Order :
Parameters :
pageSize
Format : int32
Type : integer
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.
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 `ListNegativeKeywords` method. If not specified, the first page of results will be returned.
Type : string
Location : query
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
negativeKeywordListId
Required : Yes
Description : Required. The ID of the parent negative keyword list to which the requested negative keywords belong.
Location : path
Type : string
Format : int64
Pattern : ^[^/]+$
filter
Location : query
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.
Type : string
advertiserId
Required : Yes
Pattern : ^[^/]+$
Location : path
Format : int64
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Type : string
Scopes : https://www.googleapis.com/auth/display-video
Description : Lists negative keywords in a negative keyword list.
Flat Path : v5/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords
▼ ▲ displayvideo.advertisers.assets.upload
Parameters :
advertiserId
Type : string
Format : int64
Pattern : ^[^/]+$
Location : path
Required : Yes
Description : Required. The ID of the advertiser this asset belongs to.
Path : v5/advertisers/{+advertiserId}/assets
Mediaupload :
Accept : */*
Protocols :
Simple :
Multipart : Yes
Path : /upload/v5/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).
Flat Path : v5/advertisers/{advertisersId}/assets
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
HTTP Method : POST
Supportsmediaupload : Yes
▼ ▲ displayvideo.advertisers.creatives.get
Flat Path : v5/advertisers/{advertisersId}/creatives/{creativesId}
Parameter Order :
HTTP Method : GET
Path : v5/advertisers/{+advertiserId}/creatives/{+creativeId}
Description : Gets a creative.
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Required : Yes
Description : Required. The ID of the advertiser this creative belongs to.
Pattern : ^[^/]+$
Location : path
Format : int64
Type : string
creativeId
Description : Required. The ID of the creative to fetch.
Pattern : ^[^/]+$
Type : string
Required : Yes
Format : int64
Location : path
▼ ▲ displayvideo.advertisers.creatives.create
Parameter Order : advertiserId
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/advertisers/{+advertiserId}/creatives
Parameters :
advertiserId
Type : string
Format : int64
Description : Output only. The unique ID of the advertiser the creative belongs to.
Location : path
Required : Yes
Pattern : ^[^/]+$
Flat Path : v5/advertisers/{advertisersId}/creatives
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.
▼ ▲ displayvideo.advertisers.creatives.delete
Parameters :
creativeId
Location : path
Type : string
Format : int64
Required : Yes
Pattern : ^[^/]+$
Description : The ID of the creative to be deleted.
advertiserId
Format : int64
Required : Yes
Type : string
Location : path
Pattern : ^[^/]+$
Description : The ID of the advertiser this creative belongs to.
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/advertisers/{advertisersId}/creatives/{creativesId}
Path : v5/advertisers/{+advertiserId}/creatives/{+creativeId}
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 :
▼ ▲ displayvideo.advertisers.creatives.list
Path : v5/advertisers/{+advertiserId}/creatives
Flat Path : v5/advertisers/{advertisersId}/creatives
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameter Order : advertiserId
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.
Location : query
Format : int32
Type : integer
advertiserId
Type : string
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser to list creatives for.
Format : int64
Location : path
Required : Yes
orderBy
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`.
Location : query
Type : string
filter
Type : string
Description : Allows filtering by creative fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `lineItemIds` field must use the `HAS (:)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. * For `entityStatus`, `minDuration`, `maxDuration`, `updateTime`, and `dynamic` fields, there may be at most one restriction. Supported Fields: * `approvalStatus` * `creativeId` * `creativeType` * `dimensions` (input in the form of `{width}x{height}`) * `dynamic` * `entityStatus` * `exchangeReviewStatus` (input in the form of `{exchange}-{reviewStatus}`) * `lineItemIds` * `maxDuration` (input in the form of `{duration}s`. Only seconds are supported) * `minDuration` (input in the form of `{duration}s`. Only seconds are supported) * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Notes: * For `updateTime`, a creative resource's field value reflects the last time that a creative has been updated, which includes updates made by the system (e.g. creative review updates). Examples: * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms: `dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` * All video creatives that are associated with line item ID 1 or 2: `creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)` * Find creatives by multiple creative IDs: `creativeId=1 OR creativeId=2` * All creatives with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
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 `ListCreatives` method. If not specified, the first page of results will be returned.
Type : string
Location : query
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.
▼ ▲ displayvideo.advertisers.creatives.patch
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/advertisers/{+advertiserId}/creatives/{+creativeId}
Parameters :
advertiserId
Format : int64
Description : Output only. The unique ID of the advertiser the creative belongs to.
Type : string
Location : path
Pattern : ^[^/]+$
Required : Yes
updateMask
Type : string
Format : google-fieldmask
Location : query
Description : Required. The mask to control which fields to update.
creativeId
Pattern : ^[^/]+$
Type : string
Description : Output only. The unique ID of the creative. Assigned by the system.
Format : int64
Location : path
Required : Yes
Flat Path : v5/advertisers/{advertisersId}/creatives/{creativesId}
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.
Parameter Order :
HTTP Method : PATCH
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.get
Description : Gets a single targeting option assigned to an advertiser.
Flat Path : v5/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Parameters :
assignedTargetingOptionId
Type : string
Location : path
Required : Yes
Description : Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested.
Pattern : ^[^/]+$
advertiserId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : Required. The ID of the advertiser.
Required : Yes
Location : path
targetingType
Required : Yes
Type : string
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_YOUTUBE_VIDEO` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`
Enum :
Enum Descriptions :
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
HTTP Method : GET
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.create
Parameter Order :
HTTP Method : POST
Parameters :
advertiserId
Required : Yes
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
Description : Required. The ID of the advertiser.
targetingType
Location : path
Enum :
Required : Yes
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`
Enum Descriptions :
Type : string
Pattern : ^[^/]+$
Flat Path : v5/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Description : Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful.
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.delete
Description : Deletes an assigned targeting option from an advertiser.
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
targetingType
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`
Enum Descriptions :
Type : string
Enum :
Location : path
Required : Yes
advertiserId
Required : Yes
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser.
Location : path
Type : string
Format : int64
assignedTargetingOptionId
Description : Required. The ID of the assigned targeting option to delete.
Type : string
Pattern : ^[^/]+$
Required : Yes
Location : path
Path : v5/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
HTTP Method : DELETE
Flat Path : v5/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Parameter Order :
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.list
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Flat Path : v5/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Parameters :
advertiserId
Type : string
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser.
Required : Yes
Location : path
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.
Location : query
Type : string
targetingType
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`
Enum :
Pattern : ^[^/]+$
Type : string
Required : Yes
Enum Descriptions :
Location : path
pageSize
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
Format : int32
orderBy
Type : string
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`.
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 `ListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Type : string
Location : query
Parameter Order :
Description : Lists the targeting options assigned to an advertiser.
▼ ▲ displayvideo.advertisers.lineItems.list
Parameters :
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`.
filter
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.
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
advertiserId
Description : Required. The ID of the advertiser to list line items for.
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Type : string
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 `ListLineItems` method. If not specified, the first page of results will be returned.
Location : query
Flat Path : v5/advertisers/{advertisersId}/lineItems
Path : v5/advertisers/{+advertiserId}/lineItems
Scopes : https://www.googleapis.com/auth/display-video
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
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.lineItems.patch
Flat Path : v5/advertisers/{advertisersId}/lineItems/{lineItemsId}
HTTP Method : PATCH
Parameter Order :
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.
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Pattern : ^[^/]+$
Type : string
Location : path
Description : Output only. The unique ID of the advertiser the line item belongs to.
Required : Yes
Format : int64
lineItemId
Type : string
Location : path
Description : Output only. The unique ID of the line item. Assigned by the system.
Required : Yes
Pattern : ^[^/]+$
Format : int64
updateMask
Type : string
Format : google-fieldmask
Description : Required. The mask to control which fields to update.
Location : query
Path : v5/advertisers/{+advertiserId}/lineItems/{+lineItemId}
▼ ▲ displayvideo.advertisers.lineItems.get
Description : Gets a line item.
Flat Path : v5/advertisers/{advertisersId}/lineItems/{lineItemsId}
Path : v5/advertisers/{+advertiserId}/lineItems/{+lineItemId}
Parameters :
lineItemId
Type : string
Required : Yes
Format : int64
Location : path
Pattern : ^[^/]+$
Description : Required. The ID of the line item to fetch.
advertiserId
Location : path
Description : Required. The ID of the advertiser this line item belongs to.
Required : Yes
Type : string
Format : int64
Pattern : ^[^/]+$
Parameter Order :
HTTP Method : GET
▼ ▲ displayvideo.advertisers.lineItems.bulkEditAssignedTargetingOptions
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
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.
Parameters :
advertiserId
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of the advertiser the line items belong to.
Required : Yes
Format : int64
Location : path
Path : v5/advertisers/{+advertiserId}/lineItems:bulkEditAssignedTargetingOptions
Flat Path : v5/advertisers/{advertisersId}/lineItems:bulkEditAssignedTargetingOptions
▼ ▲ displayvideo.advertisers.lineItems.bulkUpdate
HTTP Method : POST
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.
Path : v5/advertisers/{+advertiserId}/lineItems:bulkUpdate
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Flat Path : v5/advertisers/{advertisersId}/lineItems:bulkUpdate
Parameters :
advertiserId
Format : int64
Required : Yes
Description : Required. The ID of the advertiser this line item belongs to.
Pattern : ^[^/]+$
Type : string
Location : path
▼ ▲ displayvideo.advertisers.lineItems.create
Parameters :
advertiserId
Location : path
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
Description : Output only. The unique ID of the advertiser the line item belongs to.
Parameter Order : advertiserId
Flat Path : v5/advertisers/{advertisersId}/lineItems
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/advertisers/{+advertiserId}/lineItems
HTTP Method : POST
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.
▼ ▲ displayvideo.advertisers.lineItems.delete
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/advertisers/{advertisersId}/lineItems/{lineItemsId}
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 : v5/advertisers/{+advertiserId}/lineItems/{+lineItemId}
Parameter Order :
Parameters :
lineItemId
Description : The ID of the line item to delete.
Format : int64
Type : string
Location : path
Required : Yes
Pattern : ^[^/]+$
advertiserId
Description : The ID of the advertiser this line item belongs to.
Location : path
Required : Yes
Type : string
Format : int64
Pattern : ^[^/]+$
▼ ▲ displayvideo.advertisers.lineItems.bulkListAssignedTargetingOptions
HTTP Method : GET
Parameter Order : advertiserId
Flat Path : v5/advertisers/{advertisersId}/lineItems:bulkListAssignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Description : Lists assigned targeting options for multiple line items across targeting types.
Parameters :
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 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.
Location : query
orderBy
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`.
Location : query
Type : string
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.
Format : int32
Type : integer
Location : query
pageToken
Location : query
Type : string
Description : A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
lineItemIds
Format : int64
Location : query
Description : Required. The IDs of the line items to list assigned targeting options for.
Type : string
Repeated : Yes
advertiserId
Location : path
Required : Yes
Type : string
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser the line items belongs to.
Path : v5/advertisers/{+advertiserId}/lineItems:bulkListAssignedTargetingOptions
▼ ▲ displayvideo.advertisers.lineItems.duplicate
HTTP Method : POST
Path : v5/advertisers/{+advertiserId}/lineItems/{+lineItemId}:duplicate
Scopes : https://www.googleapis.com/auth/display-video
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.
Parameter Order :
Flat Path : v5/advertisers/{advertisersId}/lineItems/{lineItemsId}:duplicate
Parameters :
lineItemId
Required : Yes
Type : string
Location : path
Description : Required. The ID of the line item to duplicate.
Pattern : ^[^/]+$
Format : int64
advertiserId
Required : Yes
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser this line item belongs to.
Type : string
Location : path
Format : int64
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get
Parameter Order :
Description : Gets a single targeting option assigned to a line item.
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
lineItemId
Description : Required. The ID of the line item the assigned targeting option belongs to.
Format : int64
Required : Yes
Type : string
Location : path
Pattern : ^[^/]+$
assignedTargetingOptionId
Type : string
Location : path
Description : Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.
Pattern : ^[^/]+$
Required : Yes
targetingType
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` * `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
Pattern : ^[^/]+$
Enum Descriptions :
Required : Yes
Enum :
advertiserId
Format : int64
Description : Required. The ID of the advertiser the line item belongs to.
Type : string
Pattern : ^[^/]+$
Required : Yes
Location : path
Path : v5/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
HTTP Method : GET
Flat Path : v5/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create
Parameters :
advertiserId
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of the advertiser the line item belongs to.
Location : path
Format : int64
targetingType
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`
Enum Descriptions :
Required : Yes
Location : path
Pattern : ^[^/]+$
Enum :
lineItemId
Description : Required. The ID of the line item the assigned targeting option will belong to.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Flat Path : v5/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
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.
Path : v5/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions
HTTP Method : POST
Parameter Order :
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete
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.
Path : v5/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Flat Path : v5/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Parameters :
lineItemId
Pattern : ^[^/]+$
Required : Yes
Description : Required. The ID of the line item the assigned targeting option belongs to.
Location : path
Type : string
Format : int64
targetingType
Enum Descriptions :
Enum :
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`
Type : string
Location : path
Pattern : ^[^/]+$
Required : Yes
advertiserId
Description : Required. The ID of the advertiser the line item belongs to.
Pattern : ^[^/]+$
Format : int64
Required : Yes
Type : string
Location : path
assignedTargetingOptionId
Type : string
Location : path
Pattern : ^[^/]+$
Description : Required. The ID of the assigned targeting option to delete.
Required : Yes
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
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 `ListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Type : string
advertiserId
Type : string
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the advertiser the line item belongs to.
Required : Yes
Format : int64
orderBy
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
Type : string
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.
Location : query
Type : string
lineItemId
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
Format : int64
Description : Required. The ID of the line item to list assigned targeting options for.
pageSize
Type : integer
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.
targetingType
Required : Yes
Pattern : ^[^/]+$
Type : string
Location : path
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)
Enum :
Enum Descriptions :
Flat Path : v5/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Description : Lists the targeting options assigned to a line item.
HTTP Method : GET
Path : v5/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions
▼ ▲ displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.create
Flat Path : v5/advertisers/{advertisersId}/lineItems/{lineItemsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations
Path : v5/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
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.
Parameters :
lineItemId
Type : string
Format : int64
Description : The ID of a line item.
Location : path
Pattern : ^[^/]+$
Required : Yes
youtubeAssetType
Location : path
Required : Yes
Enum :
Enum Descriptions :
Description : Required. The type of YouTube asset associated with the resource.
Type : string
Pattern : ^[^/]+$
linkedEntity.adGroupId
Format : int64
Description : The ID of an ad group.
Location : query
Type : string
advertiserId
Pattern : ^[^/]+$
Required : Yes
Description : Required. The ID of the advertiser that the linked entity belongs to.
Location : path
Type : string
Format : int64
▼ ▲ displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.delete
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.
Parameters :
lineItemId
Location : path
Description : The ID of a line item.
Format : int64
Required : Yes
Type : string
Pattern : ^[^/]+$
advertiserId
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser that the linked entity belongs to.
Required : Yes
Format : int64
Location : path
Type : string
youtubeAssetType
Location : path
Enum :
Required : Yes
Description : Required. The type of YouTube asset associated with the resource.
Pattern : ^[^/]+$
Type : string
Enum Descriptions :
linkedEntity.adGroupId
Type : string
Format : int64
Description : The ID of an ad group.
Location : query
youtubeAssetAssociationId
Required : Yes
Format : int64
Location : path
Pattern : ^[^/]+$
Type : string
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.
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations/{+youtubeAssetAssociationId}
Parameter Order :
Flat Path : v5/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.
orderBy
Location : query
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
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 `ListYoutubeAssetAssociations` method. If not specified, the first page of results will be returned.
pageSize
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.
Type : integer
Format : int32
Location : query
advertiserId
Required : Yes
Type : string
Description : Required. The ID of the advertiser that the linked entity belongs to.
Format : int64
Pattern : ^[^/]+$
Location : path
lineItemId
Type : string
Pattern : ^[^/]+$
Description : The ID of a line item.
Location : path
Required : Yes
Format : int64
youtubeAssetType
Enum Descriptions :
Location : path
Enum :
Required : Yes
Description : Required. The type of YouTube asset being associated with the resource.
Type : string
Pattern : ^[^/]+$
Path : v5/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations
Description : Lists the YouTube asset associations linked to the given resource.
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/advertisers/{advertisersId}/lineItems/{lineItemsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations
HTTP Method : GET
Parameter Order :
▼ ▲ displayvideo.advertisers.reachForecast.retrievePlannableLocations
Parameter Order : advertiserId
Flat Path : v5/advertisers/{advertisersId}/reachForecast:retrievePlannableLocations
HTTP Method : GET
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.
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/advertisers/{+advertiserId}/reachForecast:retrievePlannableLocations
Parameters :
advertiserId
Type : string
Location : path
Pattern : ^[^/]+$
Required : Yes
Description : Required. The ID of the advertiser to list plannable locations for.
Format : int64
▼ ▲ displayvideo.advertisers.reachForecast.generateReachForecast
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/advertisers/{advertisersId}/reachForecast:generateReachForecast
Parameter Order : advertiserId
Parameters :
advertiserId
Required : Yes
Pattern : ^[^/]+$
Location : path
Format : int64
Type : string
Description : Required. The ID of the advertiser that will run the planned campaign.
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.
HTTP Method : POST
Path : v5/advertisers/{+advertiserId}/reachForecast:generateReachForecast
▼ ▲ displayvideo.advertisers.reachForecast.retrievePlannableProducts
Flat Path : v5/advertisers/{advertisersId}/reachForecast:retrievePlannableProducts
Path : v5/advertisers/{+advertiserId}/reachForecast:retrievePlannableProducts
Parameters :
plannableLocationId
Type : string
Location : query
Description : Required. The ID of the plannable location.
advertiserId
Description : Required. The ID of the advertiser to list plannable products for.
Format : int64
Type : string
Pattern : ^[^/]+$
Required : Yes
Location : path
Parameter Order : advertiserId
Scopes : https://www.googleapis.com/auth/display-video
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.
HTTP Method : GET
▼ ▲ displayvideo.advertisers.reachForecast.retrievePlannableUserInterests
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/advertisers/{+advertiserId}/reachForecast:retrievePlannableUserInterests
HTTP Method : GET
Flat Path : v5/advertisers/{advertisersId}/reachForecast:retrievePlannableUserInterests
Parameters :
advertiserId
Location : path
Description : Required. The ID of the advertiser to list plannable user interests for.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Type : string
productCategory
Enum :
Location : query
Enum Descriptions :
Type : string
Description : Required. The product category to retrieve plannable user interests for.
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
▼ ▲ displayvideo.advertisers.reachForecast.retrievePlannableUserLists
Parameter Order : advertiserId
HTTP Method : GET
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.
Flat Path : v5/advertisers/{advertisersId}/reachForecast:retrievePlannableUserLists
Path : v5/advertisers/{+advertiserId}/reachForecast:retrievePlannableUserLists
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Pattern : ^[^/]+$
Type : string
Location : path
Required : Yes
Description : Required. The ID of the advertiser to retrieve plannable user lists for.
Format : int64
pageSize
Format : int32
Type : integer
Description : Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `5000`.
Location : query
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.
filter
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
Type : string
▼ ▲ displayvideo.advertisers.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`.
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Flat Path : v5/advertisers/{advertisersId}/adAssets:bulkCreate
Path : v5/advertisers/{+advertiserId}/adAssets:bulkCreate
Parameters :
advertiserId
Required : Yes
Format : int64
Location : path
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser these ad assets belong to.
Type : string
▼ ▲ displayvideo.advertisers.adAssets.upload
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Format : int64
Required : Yes
Location : path
Type : string
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser this ad asset belongs to.
Flat Path : v5/advertisers/{advertisersId}/adAssets:uploadAdAsset
Mediaupload :
Protocols :
Simple :
Multipart : Yes
Path : /upload/v5/advertisers/{+advertiserId}/adAssets:uploadAdAsset
Accept : */*
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`.
Parameter Order : advertiserId
Supportsmediaupload : Yes
HTTP Method : POST
Path : v5/advertisers/{+advertiserId}/adAssets:uploadAdAsset
▼ ▲ displayvideo.advertisers.adAssets.get
Flat Path : v5/advertisers/{advertisersId}/adAssets/{adAssetsId}
Description : Gets an ad asset. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
Parameters :
adAssetId
Pattern : ^[^/]+$
Required : Yes
Description : Required. The ID of the ad asset to fetch. Only supports assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`
Format : int64
Type : string
Location : path
advertiserId
Location : path
Description : Required. The ID of the advertiser this ad asset belongs to.
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
Path : v5/advertisers/{+advertiserId}/adAssets/{+adAssetId}
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameter Order :
▼ ▲ displayvideo.advertisers.adAssets.patch
Scopes : https://www.googleapis.com/auth/display-video
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 : v5/advertisers/{advertisersId}/adAssets/{adAssetsId}
HTTP Method : PATCH
Path : v5/advertisers/{+advertiserId}/adAssets/{+adAssetId}
Parameters :
advertiserId
Description : Required. The ID of the advertiser this ad asset belongs to.
Required : Yes
Location : path
Type : string
Pattern : ^[^/]+$
Format : int64
adAssetId
Description : Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad.
Type : string
Location : path
Format : int64
Required : Yes
Pattern : ^[^/]+$
updateMask
Location : query
Type : string
Description : Required. The list of fields to update. Only AdAsset.synthetic_content_attestation_status is mutable.
Format : google-fieldmask
Parameter Order :
▼ ▲ displayvideo.advertisers.adAssets.list
Description : Lists ad assets under an advertiser ID. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
Parameters :
pageSize
Format : int32
Type : integer
Location : query
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.
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
filter
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
Location : query
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 `ListAdAssets` method. If not specified, the first page of results will be returned.
Type : string
advertiserId
Type : string
Required : Yes
Description : Required. The ID of the advertiser the ad assets belong to.
Format : int64
Location : path
Pattern : ^[^/]+$
Path : v5/advertisers/{+advertiserId}/adAssets
Flat Path : v5/advertisers/{advertisersId}/adAssets
Parameter Order : advertiserId
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
▼ ▲ displayvideo.advertisers.adAssets.create
Flat Path : v5/advertisers/{advertisersId}/adAssets
Scopes : https://www.googleapis.com/auth/display-video
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`.
Parameters :
advertiserId
Type : string
Required : Yes
Location : path
Pattern : ^[^/]+$
Format : int64
Description : Required. The ID of the advertiser this ad asset belongs to.
Parameter Order : advertiserId
HTTP Method : POST
Path : v5/advertisers/{+advertiserId}/adAssets
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.list
Parameters :
advertiserId
Location : path
Format : int64
Required : Yes
Description : Required. The ID of the advertiser the ad group belongs to.
Type : string
Pattern : ^[^/]+$
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.
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.
Format : int32
Type : integer
Location : query
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: * `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.
Location : query
adGroupId
Type : string
Format : int64
Pattern : ^[^/]+$
Required : Yes
Location : path
Description : Required. The ID of the ad group to list assigned targeting options for.
targetingType
Type : string
Required : Yes
Pattern : ^[^/]+$
Location : path
Enum Descriptions :
Enum :
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`
orderBy
Type : string
Description : Optional. Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`.
Location : query
Scopes : https://www.googleapis.com/auth/display-video
Description : Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included.
Flat Path : v5/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Path : v5/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions
HTTP Method : GET
Parameter Order :
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.create
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
HTTP Method : POST
Parameter Order :
Path : v5/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Parameters :
advertiserId
Location : path
Format : int64
Required : Yes
Type : string
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser the ad group belongs to.
targetingType
Type : string
Pattern : ^[^/]+$
Required : Yes
Enum Descriptions :
Location : path
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`
Enum :
adGroupId
Type : string
Required : Yes
Description : Required. The ID of the ad group the assigned targeting option will belong to.
Format : int64
Location : path
Pattern : ^[^/]+$
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.
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.delete
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Location : path
Format : int64
Description : Required. The ID of the advertiser the ad group belongs to.
Required : Yes
Type : string
Pattern : ^[^/]+$
targetingType
Location : path
Type : string
Required : Yes
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`
Enum Descriptions :
Pattern : ^[^/]+$
Enum :
adGroupId
Format : int64
Description : Required. The ID of the ad group the assigned targeting option belongs to.
Pattern : ^[^/]+$
Location : path
Required : Yes
Type : string
assignedTargetingOptionId
Description : Required. The ID of the assigned targeting option to delete.
Location : path
Type : string
Required : Yes
Pattern : ^[^/]+$
Parameter Order :
HTTP Method : DELETE
Path : v5/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
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`.
Flat Path : v5/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.get
Path : v5/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
HTTP Method : GET
Description : Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Parameters :
adGroupId
Format : int64
Description : Required. The ID of the ad group the assigned targeting option belongs to.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
advertiserId
Format : int64
Type : string
Required : Yes
Location : path
Description : Required. The ID of the advertiser the ad group belongs to.
Pattern : ^[^/]+$
targetingType
Required : Yes
Location : path
Pattern : ^[^/]+$
Enum :
Type : string
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`
assignedTargetingOptionId
Pattern : ^[^/]+$
Description : Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.
Required : Yes
Type : string
Location : path
Parameter Order :
▼ ▲ displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.create
Path : v5/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations
Flat Path : v5/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
youtubeAssetType
Pattern : ^[^/]+$
Enum Descriptions :
Type : string
Enum :
Description : Required. The type of YouTube asset associated with the resource.
Location : path
Required : Yes
linkedEntity.lineItemId
Format : int64
Location : query
Type : string
Description : The ID of a line item.
adGroupId
Required : Yes
Pattern : ^[^/]+$
Location : path
Format : int64
Type : string
Description : The ID of an ad group.
advertiserId
Type : string
Location : path
Format : int64
Required : Yes
Description : Required. The ID of the advertiser that the linked entity belongs to.
Pattern : ^[^/]+$
HTTP Method : POST
Parameter Order :
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.adGroups.youtubeAssetTypes.youtubeAssetAssociations.delete
Parameters :
adGroupId
Type : string
Format : int64
Location : path
Description : The ID of an ad group.
Required : Yes
Pattern : ^[^/]+$
advertiserId
Pattern : ^[^/]+$
Format : int64
Description : Required. The ID of the advertiser that the linked entity belongs to.
Type : string
Required : Yes
Location : path
youtubeAssetAssociationId
Pattern : ^[^/]+$
Type : string
Required : Yes
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.
Location : path
youtubeAssetType
Enum Descriptions :
Type : string
Pattern : ^[^/]+$
Description : Required. The type of YouTube asset associated with the resource.
Location : path
Enum :
Required : Yes
linkedEntity.lineItemId
Format : int64
Type : string
Location : query
Description : The ID of a line item.
Parameter Order :
Path : v5/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations/{+youtubeAssetAssociationId}
Flat Path : v5/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations/{youtubeAssetAssociationsId}
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.
HTTP Method : DELETE
▼ ▲ displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.list
Parameters :
advertiserId
Description : Required. The ID of the advertiser that the linked entity belongs to.
Pattern : ^[^/]+$
Format : int64
Type : string
Required : Yes
Location : path
orderBy
Location : query
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
pageSize
Format : int32
Type : integer
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.
adGroupId
Pattern : ^[^/]+$
Format : int64
Location : path
Required : Yes
Type : string
Description : The ID of an ad group.
youtubeAssetType
Location : path
Type : string
Enum Descriptions :
Required : Yes
Enum :
Description : Required. The type of YouTube asset being associated with the resource.
Pattern : ^[^/]+$
linkedEntity.lineItemId
Location : query
Description : The ID of a line item.
Type : string
Format : int64
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 `ListYoutubeAssetAssociations` method. If not specified, the first page of results will be returned.
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Description : Lists the YouTube asset associations linked to the given resource.
Flat Path : v5/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations
HTTP Method : GET
Path : v5/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations
▼ ▲ displayvideo.advertisers.adGroups.patch
Flat Path : v5/advertisers/{advertisersId}/adGroups/{adGroupsId}
Parameter Order :
HTTP Method : PATCH
Path : v5/advertisers/{+advertiserId}/adGroups/{+adGroupId}
Description : Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups.
Parameters :
adGroupId
Type : string
Required : Yes
Location : path
Description : Output only. The unique ID of the ad group. Assigned by the system.
Format : int64
Pattern : ^[^/]+$
advertiserId
Location : path
Format : int64
Required : Yes
Type : string
Description : Output only. The unique ID of the advertiser the ad group belongs to.
Pattern : ^[^/]+$
updateMask
Type : string
Description : Required. The mask to control which fields to update.
Location : query
Format : google-fieldmask
▼ ▲ displayvideo.advertisers.adGroups.get
Parameter Order :
Parameters :
advertiserId
Pattern : ^[^/]+$
Location : path
Required : Yes
Type : string
Description : Required. The ID of the advertiser this ad group belongs to.
Format : int64
adGroupId
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Description : Required. The ID of the ad group to fetch.
Format : int64
Scopes : https://www.googleapis.com/auth/display-video
Description : Gets an ad group.
HTTP Method : GET
Path : v5/advertisers/{+advertiserId}/adGroups/{+adGroupId}
Flat Path : v5/advertisers/{advertisersId}/adGroups/{adGroupsId}
▼ ▲ displayvideo.advertisers.adGroups.create
Parameters :
advertiserId
Pattern : ^[^/]+$
Description : Output only. The unique ID of the advertiser the ad group belongs to.
Type : string
Required : Yes
Format : int64
Location : path
Flat Path : v5/advertisers/{advertisersId}/adGroups
Parameter Order : advertiserId
Description : Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups.
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/advertisers/{+advertiserId}/adGroups
HTTP Method : POST
▼ ▲ displayvideo.advertisers.adGroups.delete
HTTP Method : DELETE
Flat Path : v5/advertisers/{advertisersId}/adGroups/{adGroupsId}
Path : v5/advertisers/{+advertiserId}/adGroups/{+adGroupId}
Parameter Order :
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.
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
adGroupId
Required : Yes
Pattern : ^[^/]+$
Location : path
Format : int64
Type : string
Description : Required. The ID of the ad group to delete.
advertiserId
Required : Yes
Description : Required. The ID of the advertiser this ad group belongs to.
Pattern : ^[^/]+$
Type : string
Location : path
Format : int64
▼ ▲ displayvideo.advertisers.adGroups.bulkListAssignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/advertisers/{advertisersId}/adGroups:bulkListAssignedTargetingOptions
Parameters :
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
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.
Location : query
filter
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.
Type : string
Location : query
pageToken
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.
Type : string
Location : query
advertiserId
Format : int64
Type : string
Location : path
Required : Yes
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser the line items belongs to.
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
Path : v5/advertisers/{+advertiserId}/adGroups:bulkListAssignedTargetingOptions
HTTP Method : GET
Parameter Order : advertiserId
Description : Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.
▼ ▲ displayvideo.advertisers.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.
Parameters :
advertiserId
Location : path
Required : Yes
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser the ad groups belong to.
Type : string
Format : int64
HTTP Method : POST
Path : v5/advertisers/{+advertiserId}/adGroups:bulkEditAssignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/advertisers/{advertisersId}/adGroups:bulkEditAssignedTargetingOptions
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.adGroups.list
Parameters :
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 `ListAdGroups` method. If not specified, the first page of results will be returned.
pageSize
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
Type : integer
Format : int32
orderBy
Type : string
Description : Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
Location : query
advertiserId
Description : Required. The ID of the advertiser the ad groups belongs to.
Required : Yes
Pattern : ^[^/]+$
Location : path
Format : int64
Type : string
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
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Flat Path : v5/advertisers/{advertisersId}/adGroups
Path : v5/advertisers/{+advertiserId}/adGroups
Description : Lists ad groups.
HTTP Method : GET
▼ ▲ displayvideo.advertisers.locationLists.get
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/advertisers/{+advertiserId}/locationLists/{+locationListId}
Flat Path : v5/advertisers/{advertisersId}/locationLists/{locationListsId}
Parameter Order :
Description : Gets a location list.
Parameters :
advertiserId
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of the DV360 advertiser to which the fetched location list belongs.
Format : int64
locationListId
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the location list to fetch.
Required : Yes
Type : string
Format : int64
▼ ▲ displayvideo.advertisers.locationLists.create
Flat Path : v5/advertisers/{advertisersId}/locationLists
HTTP Method : POST
Parameters :
advertiserId
Location : path
Format : int64
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Required : Yes
Type : string
Pattern : ^[^/]+$
Parameter Order : advertiserId
Path : v5/advertisers/{+advertiserId}/locationLists
Description : Creates a new location list. Returns the newly created location list if successful.
▼ ▲ displayvideo.advertisers.locationLists.list
Path : v5/advertisers/{+advertiserId}/locationLists
Parameters :
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
advertiserId
Type : string
Pattern : ^[^/]+$
Description : Required. The ID of the DV360 advertiser to which the fetched location lists belong.
Format : int64
Required : Yes
Location : path
filter
Type : string
Description : Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `locationType` Examples: * All regional location list: `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
orderBy
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`.
Location : query
Type : string
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 `ListLocationLists` method. If not specified, the first page of results will be returned.
Location : query
Description : Lists location lists based on a given advertiser id.
HTTP Method : GET
Parameter Order : advertiserId
Flat Path : v5/advertisers/{advertisersId}/locationLists
▼ ▲ displayvideo.advertisers.locationLists.patch
Description : Updates a location list. Returns the updated location list if successful.
Flat Path : v5/advertisers/{advertisersId}/locationLists/{locationListId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the DV360 advertiser to which the location lists belongs.
Location : path
Type : string
Required : Yes
locationListId
Description : Output only. The unique ID of the location list. Assigned by the system.
Type : string
Format : int64
Location : path
Required : Yes
updateMask
Type : string
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Location : query
HTTP Method : PATCH
Path : v5/advertisers/{+advertiserId}/locationLists/{locationListId}
Parameter Order :
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.bulkEdit
Parameter Order :
HTTP Method : POST
Path : v5/advertisers/{advertiserId}/locationLists/{+locationListId}/assignedLocations:bulkEdit
Flat Path : v5/advertisers/{advertiserId}/locationLists/{locationListsId}/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.
Parameters :
locationListId
Format : int64
Description : Required. The ID of the location list to which these assignments are assigned.
Location : path
Type : string
Pattern : ^[^/]+$
Required : Yes
advertiserId
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Required : Yes
Format : int64
Location : path
Type : string
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.create
Description : Creates an assignment between a location and a location list.
Flat Path : v5/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
HTTP Method : POST
Parameters :
advertiserId
Format : int64
Type : string
Location : path
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Required : Yes
locationListId
Location : path
Required : Yes
Type : string
Description : Required. The ID of the location list for which the assignment will be created.
Format : int64
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.delete
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
advertiserId
Required : Yes
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Location : path
Format : int64
Type : string
locationListId
Required : Yes
Description : Required. The ID of the location list to which this assignment is assigned.
Location : path
Type : string
Format : int64
assignedLocationId
Location : path
Type : string
Format : int64
Description : Required. The ID of the assigned location to delete.
Required : Yes
Pattern : ^[^/]+$
Flat Path : v5/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{assignedLocationsId}
HTTP Method : DELETE
Description : Deletes the assignment between a location and a location list.
Path : v5/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{+assignedLocationId}
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.list
Flat Path : v5/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
HTTP Method : GET
Path : v5/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
Description : Lists locations assigned to a location list.
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
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
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 `ListAssignedLocations` method. If not specified, the first page of results will be returned.
Location : query
advertiserId
Required : Yes
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Location : path
Type : string
Format : int64
locationListId
Type : string
Required : Yes
Format : int64
Description : Required. The ID of the location list to which these assignments are assigned.
Location : path
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
filter
Location : query
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.
Type : string
▼ ▲ displayvideo.advertisers.inventorySources.get
Path : v5/advertisers/{+advertiserId}/inventorySources/{+inventorySourceId}
Parameters :
partnerId
Location : query
Description : The ID of the DV360 partner.
Type : string
Format : int64
inventorySourceId
Required : Yes
Type : string
Location : path
Description : Required. The ID of the inventory source deal to fetch.
Format : int64
Pattern : ^[^/]+$
advertiserId
Type : string
Description : The ID of the DV360 advertiser.
Format : int64
Location : path
Pattern : ^[^/]+$
Required : Yes
Flat Path : v5/advertisers/{advertisersId}/inventorySources/{inventorySourcesId}
Description : Gets an inventory source deal.
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameter Order :
▼ ▲ displayvideo.advertisers.inventorySources.list
Parameters :
partnerId
Location : query
Format : int64
Description : The ID of the DV360 partner.
Type : string
filter
Description : Optional. 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.
Location : query
Type : string
advertiserId
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
Type : string
Description : The ID of the DV360 advertiser.
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 `ListInventorySources` method. If not specified, the first page of results will be returned.
Type : string
pageSize
Type : integer
Description : Optional. Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Format : int32
Location : query
orderBy
Location : query
Type : string
Description : Optional. 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`.
Flat Path : v5/advertisers/{advertisersId}/inventorySources
Description : Lists inventory source deals.
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Path : v5/advertisers/{+advertiserId}/inventorySources
HTTP Method : GET
▼ ▲ displayvideo.advertisers.channels.list
Path : v5/advertisers/{+advertiserId}/channels
Flat Path : v5/advertisers/{advertisersId}/channels
HTTP Method : GET
Description : Lists channels for a partner or advertiser.
Scopes : https://www.googleapis.com/auth/display-video
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.
Type : string
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.
Format : int32
Location : query
Type : integer
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 `ListChannels` method. If not specified, the first page of results will be returned.
orderBy
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
Type : string
advertiserId
Format : int64
Type : string
Location : path
Description : The ID of the advertiser that owns the channels.
Pattern : ^[^/]+$
Required : Yes
partnerId
Description : The ID of the partner that owns the channels.
Type : string
Format : int64
Location : query
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.channels.create
Parameter Order : advertiserId
Parameters :
partnerId
Format : int64
Type : string
Location : query
Description : The ID of the partner that owns the created channel.
advertiserId
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
Description : The ID of the advertiser that owns the created channel.
Description : Creates a new channel. Returns the newly created channel if successful.
HTTP Method : POST
Flat Path : v5/advertisers/{advertisersId}/channels
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/advertisers/{+advertiserId}/channels
▼ ▲ displayvideo.advertisers.channels.get
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/advertisers/{advertisersId}/channels/{channelsId}
Path : v5/advertisers/{+advertiserId}/channels/{+channelId}
HTTP Method : GET
Parameters :
channelId
Location : path
Required : Yes
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the channel to fetch.
Type : string
advertiserId
Pattern : ^[^/]+$
Description : The ID of the advertiser that owns the fetched channel.
Location : path
Format : int64
Required : Yes
Type : string
partnerId
Format : int64
Location : query
Description : The ID of the partner that owns the fetched channel.
Type : string
Parameter Order :
Description : Gets a channel for a partner or advertiser.
▼ ▲ displayvideo.advertisers.channels.patch
Parameter Order :
Path : v5/advertisers/{+advertiserId}/channels/{channelId}
Parameters :
partnerId
Description : The ID of the partner that owns the created channel.
Type : string
Format : int64
Location : query
channelId
Format : int64
Required : Yes
Description : Output only. The unique ID of the channel. Assigned by the system.
Location : path
Type : string
advertiserId
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : The ID of the advertiser that owns the created channel.
Location : path
Format : int64
updateMask
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Location : query
Type : string
Description : Updates a channel. Returns the updated channel if successful.
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/advertisers/{advertisersId}/channels/{channelId}
▼ ▲ displayvideo.advertisers.channels.sites.bulkEdit
Parameters :
channelId
Description : Required. The ID of the parent channel to which the sites belong.
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
advertiserId
Required : Yes
Type : string
Location : path
Description : The ID of the advertiser that owns the parent channel.
Format : int64
Flat Path : v5/advertisers/{advertiserId}/channels/{channelsId}/sites:bulkEdit
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/advertisers/{advertiserId}/channels/{+channelId}/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.
Parameter Order :
HTTP Method : POST
▼ ▲ displayvideo.advertisers.channels.sites.replace
Parameters :
advertiserId
Description : The ID of the advertiser that owns the parent channel.
Type : string
Required : Yes
Format : int64
Location : path
channelId
Required : Yes
Pattern : ^[^/]+$
Description : Required. The ID of the parent channel whose sites will be replaced.
Location : path
Format : int64
Type : string
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/advertisers/{advertiserId}/channels/{channelsId}/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.
HTTP Method : POST
Path : v5/advertisers/{advertiserId}/channels/{+channelId}/sites:replace
▼ ▲ displayvideo.advertisers.channels.sites.create
HTTP Method : POST
Path : v5/advertisers/{advertiserId}/channels/{+channelId}/sites
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Flat Path : v5/advertisers/{advertiserId}/channels/{channelsId}/sites
Description : Creates a site in a channel.
Parameters :
partnerId
Type : string
Format : int64
Location : query
Description : The ID of the partner that owns the parent channel.
advertiserId
Location : path
Required : Yes
Type : string
Format : int64
Description : The ID of the advertiser that owns the parent channel.
channelId
Required : Yes
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the parent channel in which the site will be created.
Format : int64
Type : string
▼ ▲ displayvideo.advertisers.channels.sites.delete
Path : v5/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}
Parameter Order :
HTTP Method : DELETE
Description : Deletes a site from a channel.
Parameters :
urlOrAppId
Description : Required. The URL or app ID of the site to delete.
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
advertiserId
Format : int64
Description : The ID of the advertiser that owns the parent channel.
Required : Yes
Type : string
Location : path
partnerId
Format : int64
Location : query
Description : The ID of the partner that owns the parent channel.
Type : string
channelId
Format : int64
Location : path
Type : string
Pattern : ^[^/]+$
Description : Required. The ID of the parent channel to which the site belongs.
Required : Yes
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/advertisers/{advertiserId}/channels/{channelsId}/sites/{sitesId}
▼ ▲ displayvideo.advertisers.channels.sites.list
Description : Lists sites in a channel.
HTTP Method : GET
Flat Path : v5/advertisers/{advertisersId}/channels/{channelsId}/sites
Parameter Order :
Parameters :
filter
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.
Location : query
advertiserId
Type : string
Description : The ID of the advertiser that owns the parent channel.
Pattern : ^[^/]+$
Location : path
Format : int64
Required : Yes
orderBy
Location : query
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
partnerId
Type : string
Location : query
Description : The ID of the partner that owns the parent channel.
Format : int64
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.
Location : query
Type : string
channelId
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
Description : Required. The ID of the parent channel to which the requested sites belong.
Required : Yes
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.
Format : int32
Location : query
Type : integer
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/advertisers/{+advertiserId}/channels/{+channelId}/sites
▼ ▲ displayvideo.advertisers.insertionOrders.create
Parameter Order : advertiserId
Flat Path : v5/advertisers/{advertisersId}/insertionOrders
Parameters :
advertiserId
Location : path
Required : Yes
Description : Output only. The unique ID of the advertiser the insertion order belongs to.
Type : string
Pattern : ^[^/]+$
Format : int64
Path : v5/advertisers/{+advertiserId}/insertionOrders
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Description : Creates a new insertion order. Returns the newly created insertion order if successful.
▼ ▲ displayvideo.advertisers.insertionOrders.delete
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.
HTTP Method : DELETE
Flat Path : v5/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}
Parameters :
insertionOrderId
Location : path
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Description : The ID of the insertion order to delete.
advertiserId
Required : Yes
Format : int64
Location : path
Description : The ID of the advertiser this insertion order belongs to.
Pattern : ^[^/]+$
Type : string
Parameter Order :
▼ ▲ displayvideo.advertisers.insertionOrders.list
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/advertisers/{advertisersId}/insertionOrders
Parameter Order : advertiserId
HTTP Method : GET
Path : v5/advertisers/{+advertiserId}/insertionOrders
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.
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 `ListInsertionOrders` method. If not specified, the first page of results will be returned.
Location : query
filter
Location : query
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.
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`.
pageSize
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.
Type : integer
Location : query
advertiserId
Description : Required. The ID of the advertiser to list insertion orders for.
Pattern : ^[^/]+$
Type : string
Required : Yes
Format : int64
Location : path
▼ ▲ displayvideo.advertisers.insertionOrders.patch
Parameters :
insertionOrderId
Type : string
Format : int64
Location : path
Description : Output only. The unique ID of the insertion order. Assigned by the system.
Pattern : ^[^/]+$
Required : Yes
advertiserId
Location : path
Required : Yes
Format : int64
Description : Output only. The unique ID of the advertiser the insertion order belongs to.
Type : string
Pattern : ^[^/]+$
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Type : string
Format : google-fieldmask
Description : Updates an existing insertion order. Returns the updated insertion order if successful.
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}
HTTP Method : PATCH
Parameter Order :
Flat Path : v5/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}
▼ ▲ displayvideo.advertisers.insertionOrders.get
Path : v5/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameter Order :
Parameters :
advertiserId
Format : int64
Required : Yes
Type : string
Location : path
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser this insertion order belongs to.
insertionOrderId
Location : path
Description : Required. The ID of the insertion order to fetch.
Required : Yes
Format : int64
Type : string
Pattern : ^[^/]+$
Description : Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist.
Flat Path : v5/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}
▼ ▲ displayvideo.advertisers.invoices.list
Path : v5/advertisers/{+advertiserId}/invoices
Scopes :
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.
Type : integer
Location : query
Format : int32
issueMonth
Type : string
Location : query
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.
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 `ListInvoices` method. If not specified, the first page of results will be returned.
Type : string
loiSapinInvoiceType
Description : Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise.
Type : string
Enum :
Enum Descriptions :
Location : query
advertiserId
Type : string
Format : int64
Description : Required. The ID of the advertiser to list invoices for.
Location : path
Pattern : ^[^/]+$
Required : Yes
Flat Path : v5/advertisers/{advertisersId}/invoices
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.invoices.lookupInvoiceCurrency
Flat Path : v5/advertisers/{advertisersId}/invoices:lookupInvoiceCurrency
HTTP Method : GET
Path : v5/advertisers/{+advertiserId}/invoices:lookupInvoiceCurrency
Parameter Order : advertiserId
Description : Retrieves the invoice currency used by an advertiser in a given month.
Scopes :
Parameters :
advertiserId
Required : Yes
Location : path
Pattern : ^[^/]+$
Format : int64
Type : string
Description : Required. The ID of the advertiser to lookup currency for.
invoiceMonth
Location : query
Type : string
Description : Month for which the currency is needed. If not set, the request will return existing currency settings for the advertiser. Must be in the format YYYYMM.
▼ ▲ displayvideo.advertisers.campaigns.list
Parameters :
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
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Location : path
Description : The ID of the advertiser to list campaigns for.
pageSize
Type : integer
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Location : query
Format : int32
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 `ListCampaigns` method. If not specified, the first page of results will be returned.
filter
Location : query
Type : string
Description : Allows filtering by campaign fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All campaigns with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Flat Path : v5/advertisers/{advertisersId}/campaigns
Scopes :
Path : v5/advertisers/{+advertiserId}/campaigns
Parameter Order : advertiserId
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.
HTTP Method : GET
▼ ▲ displayvideo.advertisers.campaigns.patch
Parameter Order :
HTTP Method : PATCH
Scopes :
Flat Path : v5/advertisers/{advertisersId}/campaigns/{campaignsId}
Path : v5/advertisers/{+advertiserId}/campaigns/{+campaignId}
Parameters :
campaignId
Required : Yes
Type : string
Format : int64
Pattern : ^[^/]+$
Location : path
Description : Output only. The unique ID of the campaign. Assigned by the system.
advertiserId
Location : path
Type : string
Format : int64
Required : Yes
Pattern : ^[^/]+$
Description : Output only. The unique ID of the advertiser the campaign belongs to.
updateMask
Description : Required. The mask to control which fields to update.
Type : string
Location : query
Format : google-fieldmask
Description : Updates an existing campaign. Returns the updated campaign if successful.
▼ ▲ displayvideo.advertisers.campaigns.get
Path : v5/advertisers/{+advertiserId}/campaigns/{+campaignId}
Scopes :
HTTP Method : GET
Description : Gets a campaign.
Flat Path : v5/advertisers/{advertisersId}/campaigns/{campaignsId}
Parameters :
campaignId
Pattern : ^[^/]+$
Type : string
Format : int64
Required : Yes
Location : path
Description : Required. The ID of the campaign to fetch.
advertiserId
Required : Yes
Format : int64
Location : path
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser this campaign belongs to.
Type : string
Parameter Order :
▼ ▲ displayvideo.advertisers.campaigns.create
Path : v5/advertisers/{+advertiserId}/campaigns
Scopes :
Parameter Order : advertiserId
Parameters :
advertiserId
Format : int64
Type : string
Pattern : ^[^/]+$
Required : Yes
Location : path
Description : Output only. The unique ID of the advertiser the campaign belongs to.
HTTP Method : POST
Flat Path : v5/advertisers/{advertisersId}/campaigns
Description : Creates a new campaign. Returns the newly created campaign if successful.
▼ ▲ displayvideo.advertisers.campaigns.delete
Path : v5/advertisers/{+advertiserId}/campaigns/{+campaignId}
HTTP Method : DELETE
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 :
Parameters :
advertiserId
Pattern : ^[^/]+$
Description : The ID of the advertiser this campaign belongs to.
Required : Yes
Format : int64
Location : path
Type : string
campaignId
Description : The ID of the campaign we need to delete.
Pattern : ^[^/]+$
Type : string
Required : Yes
Format : int64
Location : path
Flat Path : v5/advertisers/{advertisersId}/campaigns/{campaignsId}
Parameter Order :
▼ ▲ displayvideo.advertisers.adGroupAds.list
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
Type : string
Required : Yes
Format : int64
Description : Required. The ID of the advertiser the ads belong to.
Pattern : ^[^/]+$
Location : path
orderBy
Type : string
Location : query
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`.
pageSize
Location : query
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.
Format : int32
Type : integer
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 `ListAdGroupAds` method. If not specified, the first page of results will be returned.
Type : string
Scopes : https://www.googleapis.com/auth/display-video
Path : v5/advertisers/{+advertiserId}/adGroupAds
Description : Lists ad group ads.
Parameter Order : advertiserId
HTTP Method : GET
Flat Path : v5/advertisers/{advertisersId}/adGroupAds
▼ ▲ displayvideo.advertisers.adGroupAds.get
Description : Gets an ad group ad.
Parameters :
adGroupAdId
Pattern : ^[^/]+$
Format : int64
Location : path
Required : Yes
Type : string
Description : Required. The ID of the ad to fetch.
advertiserId
Pattern : ^[^/]+$
Location : path
Required : Yes
Description : Required. The ID of the advertiser this ad group ad belongs to.
Type : string
Format : int64
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Flat Path : v5/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}
HTTP Method : GET
Path : v5/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}
▼ ▲ displayvideo.advertisers.adGroupAds.patch
HTTP Method : PATCH
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}
Path : v5/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}
Description : Updates an ad group ad.
Parameters :
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Type : string
advertiserId
Format : int64
Required : Yes
Description : Output only. The unique ID of the advertiser the ad belongs to.
Location : path
Pattern : ^[^/]+$
Type : string
adGroupAdId
Pattern : ^[^/]+$
Type : string
Format : int64
Required : Yes
Location : path
Description : Output only. The unique ID of the ad. Assigned by the system.
▼ ▲ displayvideo.advertisers.adGroupAds.create
Flat Path : v5/advertisers/{advertisersId}/adGroupAds
Parameters :
advertiserId
Required : Yes
Pattern : ^[^/]+$
Location : path
Format : int64
Type : string
Description : Output only. The unique ID of the advertiser the ad belongs to.
Path : v5/advertisers/{+advertiserId}/adGroupAds
Description : Creates an ad group ad.
Parameter Order : advertiserId
HTTP Method : POST
▼ ▲ displayvideo.advertisers.adGroupAds.delete
Description : Deletes an ad group ad.
HTTP Method : DELETE
Parameter Order :
Path : v5/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}
Parameters :
advertiserId
Location : path
Type : string
Format : int64
Required : Yes
Description : Required. The ID of the advertiser the ad belongs to.
Pattern : ^[^/]+$
adGroupAdId
Pattern : ^[^/]+$
Type : string
Format : int64
Required : Yes
Description : Required. The ID of the ad to delete.
Location : path
▼ ▲ displayvideo.firstPartyAndPartnerAudiences.list
Path : v5/firstPartyAndPartnerAudiences
Description : Lists first party and partner audiences. The order is defined by the order_by parameter.
HTTP Method : GET
Parameters :
partnerId
Description : The ID of the partner that has access to the fetched first party and partner audiences.
Type : string
Location : query
Format : int64
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
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.
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.
Type : string
Location : query
orderBy
Location : query
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`.
advertiserId
Format : int64
Location : query
Type : string
Description : The ID of the advertiser that has access to the fetched first party and partner audiences.
Flat Path : v5/firstPartyAndPartnerAudiences
▼ ▲ displayvideo.firstPartyAndPartnerAudiences.get
Parameters :
partnerId
Format : int64
Description : The ID of the partner that has access to the fetched first party and partner audience.
Location : query
Type : string
firstPartyAndPartnerAudienceId
Location : path
Description : Required. The ID of the first party and partner audience to fetch.
Format : int64
Required : Yes
Type : string
Pattern : ^[^/]+$
advertiserId
Format : int64
Location : query
Type : string
Description : The ID of the advertiser that has access to the fetched first party and partner audience.
Description : Gets a first party or partner audience.
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v5/firstPartyAndPartnerAudiences/{firstPartyAndPartnerAudiencesId}
Parameter Order : firstPartyAndPartnerAudienceId
HTTP Method : GET
Path : v5/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}
▼ ▲ displayvideo.googleAudiences.list
Description : Lists Google audiences. The order is defined by the order_by parameter.
Parameters :
filter
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.
Location : query
orderBy
Location : query
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
partnerId
Location : query
Type : string
Description : The ID of the partner that has access to the fetched Google audiences.
Format : int64
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 `ListGoogleAudiences` method. If not specified, the first page of results will be returned.
Location : query
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
advertiserId
Type : string
Description : The ID of the advertiser that has access to the fetched Google audiences.
Location : query
Format : int64
Flat Path : v5/googleAudiences
Path : v5/googleAudiences
HTTP Method : GET
▼ ▲ displayvideo.googleAudiences.get
Parameters :
googleAudienceId
Type : string
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : Required. The ID of the Google audience to fetch.
Location : path
partnerId
Format : int64
Location : query
Description : The ID of the partner that has access to the fetched Google audience.
Type : string
advertiserId
Format : int64
Description : The ID of the advertiser that has access to the fetched Google audience.
Location : query
Type : string
Flat Path : v5/googleAudiences/{googleAudiencesId}
Scopes : https://www.googleapis.com/auth/display-video
Description : Gets a Google audience.
Parameter Order : googleAudienceId
Path : v5/googleAudiences/{+googleAudienceId}
HTTP Method : GET
▼ ▲ displayvideo.sdfdownloadtasks.create
Scopes : https://www.googleapis.com/auth/display-video
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 : v5/sdfdownloadtasks
HTTP Method : POST
Flat Path : v5/sdfdownloadtasks