2026-11-10
▼ ▲ displayvideo.customLists.get
Parameter Order : customListId
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/customLists/{customListsId}
Path : v4/customLists/{+customListId}
Parameters :
customListId
Type : string
Required : Yes
Pattern : ^[^/]+$
Format : int64
Location : path
Description : Required. The ID of the custom list to fetch.
advertiserId
Type : string
Format : int64
Description : The ID of the DV360 advertiser that has access to the fetched custom lists.
Location : query
Description : Gets a custom list.
▼ ▲ displayvideo.customLists.list
Flat Path : v4/customLists
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Path : v4/customLists
Description : Lists custom lists. The order is defined by the order_by parameter.
Parameters :
pageSize
Type : integer
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Location : query
Format : int32
pageToken
Type : string
Location : query
Description : A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomLists` method. If not specified, the first page of results will be returned.
advertiserId
Description : The ID of the DV360 advertiser that has access to the fetched custom lists.
Type : string
Format : int64
Location : query
filter
Location : query
Description : Allows filtering by custom list fields. Supported syntax: * Filter expressions for custom lists can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All custom lists for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Type : string
orderBy
Type : string
Description : Field by which to sort the list. Acceptable values are: * `customListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
Location : query
▼ ▲ displayvideo.targetingTypes.targetingOptions.search
Parameters :
targetingType
Required : Yes
Enum :
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`
Pattern : ^[^/]+$
Enum Descriptions :
Type : string
Path : v4/targetingTypes/{+targetingType}/targetingOptions:search
Parameter Order : targetingType
Flat Path : v4/targetingTypes/{targetingTypesId}/targetingOptions:search
Description : Searches for targeting options of a given type based on the given search terms.
HTTP Method : POST
▼ ▲ displayvideo.targetingTypes.targetingOptions.get
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Description : Gets a single targeting option.
Path : v4/targetingTypes/{+targetingType}/targetingOptions/{+targetingOptionId}
Parameter Order :
Flat Path : v4/targetingTypes/{targetingTypesId}/targetingOptions/{targetingOptionsId}
Parameters :
advertiserId
Description : Required. The Advertiser this request is being made in the context of.
Location : query
Type : string
Format : int64
targetingType
Location : path
Enum Descriptions :
Type : string
Pattern : ^[^/]+$
Description : Required. The type of targeting option to retrieve. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUCTION_PACKAGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID`
Enum :
Required : Yes
targetingOptionId
Location : path
Description : Required. The ID of the of targeting option to retrieve.
Pattern : ^[^/]+$
Required : Yes
Type : string
▼ ▲ displayvideo.targetingTypes.targetingOptions.list
Path : v4/targetingTypes/{+targetingType}/targetingOptions
Parameters :
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `targetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingOptionId desc`.
pageToken
Description : A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListTargetingOptions` method. If not specified, the first page of results will be returned.
Type : string
Location : query
pageSize
Type : integer
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Location : query
Format : int32
filter
Description : Allows filtering by targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `carrierAndIspDetails.type` * `geoRegionDetails.geoRegionType` * `targetingOptionId` Examples: * All `GEO REGION` targeting options that belong to sub type `GEO_REGION_TYPE_COUNTRY` or `GEO_REGION_TYPE_STATE`: `geoRegionDetails.geoRegionType="GEO_REGION_TYPE_COUNTRY" OR geoRegionDetails.geoRegionType="GEO_REGION_TYPE_STATE"` * All `CARRIER AND ISP` targeting options that belong to sub type `CARRIER_AND_ISP_TYPE_CARRIER`: `carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
Type : string
advertiserId
Type : string
Format : int64
Description : Required. The Advertiser this request is being made in the context of.
Location : query
targetingType
Enum :
Location : path
Pattern : ^[^/]+$
Description : Required. The type of targeting option to be listed. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUCTION_PACKAGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID`
Enum Descriptions :
Type : string
Required : Yes
Flat Path : v4/targetingTypes/{targetingTypesId}/targetingOptions
Description : Lists targeting options of a given type.
Parameter Order : targetingType
HTTP Method : GET
▼ ▲ displayvideo.partners.channels.list
HTTP Method : GET
Parameter Order : partnerId
Path : v4/partners/{+partnerId}/channels
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Description : The ID of the advertiser that owns the channels.
Format : int64
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 `ListChannels` method. If not specified, the first page of results will be returned.
Type : string
Location : query
filter
Location : query
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
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
partnerId
Location : path
Description : The ID of the partner that owns the channels.
Type : string
Pattern : ^[^/]+$
Format : int64
Required : Yes
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
Description : Lists channels for a partner or advertiser.
Flat Path : v4/partners/{partnersId}/channels
▼ ▲ displayvideo.partners.channels.create
Parameter Order : partnerId
Parameters :
partnerId
Pattern : ^[^/]+$
Description : The ID of the partner that owns the created channel.
Format : int64
Location : path
Type : string
Required : Yes
advertiserId
Format : int64
Location : query
Description : The ID of the advertiser that owns the created channel.
Type : string
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/partners/{+partnerId}/channels
Description : Creates a new channel. Returns the newly created channel if successful.
HTTP Method : POST
Flat Path : v4/partners/{partnersId}/channels
▼ ▲ displayvideo.partners.channels.patch
Parameters :
partnerId
Location : path
Description : The ID of the partner that owns the created channel.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Type : string
advertiserId
Location : query
Format : int64
Type : string
Description : The ID of the advertiser that owns the created channel.
updateMask
Type : string
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Location : query
channelId
Format : int64
Location : path
Required : Yes
Type : string
Description : Output only. The unique ID of the channel. Assigned by the system.
Parameter Order :
Path : v4/partners/{+partnerId}/channels/{channelId}
Description : Updates a channel. Returns the updated channel if successful.
HTTP Method : PATCH
Flat Path : v4/partners/{partnersId}/channels/{channelId}
▼ ▲ displayvideo.partners.channels.get
Description : Gets a channel for a partner or advertiser.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Flat Path : v4/partners/{partnersId}/channels/{channelsId}
Path : v4/partners/{+partnerId}/channels/{+channelId}
Parameters :
partnerId
Required : Yes
Description : The ID of the partner that owns the fetched channel.
Type : string
Format : int64
Pattern : ^[^/]+$
Location : path
advertiserId
Type : string
Location : query
Format : int64
Description : The ID of the advertiser that owns the fetched channel.
channelId
Pattern : ^[^/]+$
Required : Yes
Description : Required. The ID of the channel to fetch.
Format : int64
Location : path
Type : string
▼ ▲ displayvideo.partners.channels.sites.list
Path : v4/partners/{+partnerId}/channels/{+channelId}/sites
Flat Path : v4/partners/{partnersId}/channels/{channelsId}/sites
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
partnerId
Description : The ID of the partner that owns the parent channel.
Type : string
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
advertiserId
Type : string
Location : query
Format : int64
Description : The ID of the advertiser that owns the parent channel.
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`.
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
Type : integer
Location : query
pageToken
Description : A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned.
Location : query
Type : string
channelId
Description : Required. The ID of the parent channel to which the requested sites belong.
Location : path
Format : int64
Type : string
Required : Yes
Pattern : ^[^/]+$
Description : Lists sites in a channel.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
▼ ▲ displayvideo.partners.channels.sites.replace
Parameters :
channelId
Description : Required. The ID of the parent channel whose sites will be replaced.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
partnerId
Required : Yes
Type : string
Format : int64
Location : path
Description : The ID of the partner that owns the parent channel.
Path : v4/partners/{partnerId}/channels/{+channelId}/sites:replace
Parameter Order :
Description : Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/partners/{partnerId}/channels/{channelsId}/sites:replace
HTTP Method : POST
▼ ▲ displayvideo.partners.channels.sites.create
Parameter Order :
Parameters :
channelId
Required : Yes
Type : string
Pattern : ^[^/]+$
Location : path
Format : int64
Description : Required. The ID of the parent channel in which the site will be created.
partnerId
Required : Yes
Type : string
Description : The ID of the partner that owns the parent channel.
Format : int64
Location : path
advertiserId
Format : int64
Description : The ID of the advertiser that owns the parent channel.
Location : query
Type : string
Flat Path : v4/partners/{partnerId}/channels/{channelsId}/sites
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/partners/{partnerId}/channels/{+channelId}/sites
HTTP Method : POST
Description : Creates a site in a channel.
▼ ▲ displayvideo.partners.channels.sites.delete
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : DELETE
Parameter Order :
Path : v4/partners/{partnerId}/channels/{+channelId}/sites/{+urlOrAppId}
Parameters :
channelId
Format : int64
Type : string
Required : Yes
Description : Required. The ID of the parent channel to which the site belongs.
Pattern : ^[^/]+$
Location : path
urlOrAppId
Description : Required. The URL or app ID of the site to delete.
Location : path
Pattern : ^[^/]+$
Required : Yes
Type : string
advertiserId
Description : The ID of the advertiser that owns the parent channel.
Type : string
Format : int64
Location : query
partnerId
Location : path
Description : The ID of the partner that owns the parent channel.
Format : int64
Type : string
Required : Yes
Description : Deletes a site from a channel.
Flat Path : v4/partners/{partnerId}/channels/{channelsId}/sites/{sitesId}
▼ ▲ displayvideo.partners.channels.sites.bulkEdit
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/partners/{partnerId}/channels/{+channelId}/sites:bulkEdit
Parameters :
channelId
Description : Required. The ID of the parent channel to which the sites belong.
Type : string
Location : path
Format : int64
Required : Yes
Pattern : ^[^/]+$
partnerId
Location : path
Description : The ID of the partner that owns the parent channel.
Type : string
Required : Yes
Format : int64
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
Flat Path : v4/partners/{partnerId}/channels/{channelsId}/sites:bulkEdit
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.list
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`. * 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.
Location : query
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 `ListPartnerAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Type : string
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`.
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
partnerId
Location : path
Format : int64
Description : Required. The ID of the partner.
Pattern : ^[^/]+$
Type : string
Required : Yes
targetingType
Enum :
Required : Yes
Description : Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Pattern : ^[^/]+$
Type : string
Enum Descriptions :
Location : path
Parameter Order :
Path : v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions
HTTP Method : GET
Flat Path : v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Description : Lists the targeting options assigned to a partner.
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.create
Flat Path : v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Path : v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Description : Required. The ID of the partner.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
Required : Yes
targetingType
Type : string
Pattern : ^[^/]+$
Required : Yes
Enum :
Location : path
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Enum Descriptions :
Parameter Order :
HTTP Method : POST
Description : Assigns a targeting option to a partner. Returns the assigned targeting option if successful.
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.delete
Path : v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Description : Deletes an assigned targeting option from a partner.
Parameters :
assignedTargetingOptionId
Required : Yes
Description : Required. The ID of the assigned targeting option to delete.
Location : path
Pattern : ^[^/]+$
Type : string
partnerId
Description : Required. The ID of the partner.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
Type : string
targetingType
Enum :
Required : Yes
Type : string
Enum Descriptions :
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Pattern : ^[^/]+$
Location : path
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Flat Path : v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.get
Path : v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
HTTP Method : GET
Description : Gets a single targeting option assigned to a partner.
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the partner.
Type : string
Required : Yes
targetingType
Enum :
Enum Descriptions :
Pattern : ^[^/]+$
Location : path
Type : string
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Required : Yes
assignedTargetingOptionId
Location : path
Pattern : ^[^/]+$
Description : Required. An identifier unique to the targeting type in this partner that identifies the assigned targeting option being requested.
Type : string
Required : Yes
Flat Path : v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
▼ ▲ displayvideo.partners.list
Path : v4/partners
Parameters :
filter
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.
Location : query
Type : string
orderBy
Type : string
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`.
pageToken
Description : A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListPartners` method. If not specified, the first page of results will be returned.
Location : query
Type : string
pageSize
Location : query
Format : int32
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Type : integer
Description : Lists partners that are accessible to the current user. The order is defined by the order_by parameter.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/partners
▼ ▲ displayvideo.partners.get
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : partnerId
HTTP Method : GET
Description : Gets a partner.
Path : v4/partners/{+partnerId}
Flat Path : v4/partners/{partnersId}
Parameters :
partnerId
Required : Yes
Pattern : ^[^/]+$
Format : int64
Description : Required. The ID of the partner to fetch.
Location : path
Type : string
▼ ▲ displayvideo.partners.editAssignedTargetingOptions
Parameter Order : partnerId
Path : v4/partners/{+partnerId}:editAssignedTargetingOptions
Parameters :
partnerId
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Location : path
Description : Required. The ID of the partner.
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/partners/{partnersId}:editAssignedTargetingOptions
HTTP Method : POST
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 .
▼ ▲ displayvideo.customBiddingAlgorithms.rules.list
Parameters :
pageToken
Type : string
Location : query
Description : A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingAlgorithmRules` method. If not specified, the first page of results will be returned.
orderBy
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
Type : string
advertiserId
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Format : int64
Location : query
Type : string
pageSize
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Location : query
Type : integer
Format : int32
customBiddingAlgorithmId
Pattern : ^[^/]+$
Type : string
Required : Yes
Format : int64
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Location : path
partnerId
Location : query
Type : string
Description : The ID of the partner that owns the parent custom bidding algorithm.
Format : int64
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules
Flat Path : v4/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.
Parameter Order : customBiddingAlgorithmId
▼ ▲ displayvideo.customBiddingAlgorithms.rules.get
Description : Retrieves a rules resource.
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
partnerId
Location : query
Description : The ID of the partner that owns the parent custom bidding algorithm.
Format : int64
Type : string
customBiddingAlgorithmRulesId
Description : Required. The ID of the rules resource to fetch.
Format : int64
Type : string
Location : path
Pattern : ^[^/]+$
Required : Yes
advertiserId
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Format : int64
Location : query
Type : string
customBiddingAlgorithmId
Required : Yes
Pattern : ^[^/]+$
Format : int64
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Location : path
Type : string
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules/{+customBiddingAlgorithmRulesId}
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules/{rulesId}
HTTP Method : GET
▼ ▲ displayvideo.customBiddingAlgorithms.rules.create
HTTP Method : POST
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules
Parameter Order : customBiddingAlgorithmId
Parameters :
customBiddingAlgorithmId
Required : Yes
Type : string
Format : int64
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Pattern : ^[^/]+$
Location : path
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 rules resource.
advertiserId
Location : query
Type : string
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Format : int64
Scopes : https://www.googleapis.com/auth/display-video
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.
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules
▼ ▲ displayvideo.customBiddingAlgorithms.scripts.list
Parameters :
advertiserId
Location : query
Format : int64
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Type : string
partnerId
Location : query
Description : The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
Format : int64
Type : string
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
customBiddingAlgorithmId
Required : Yes
Pattern : ^[^/]+$
Type : string
Format : int64
Description : Required. The ID of the custom bidding algorithm owns the script.
Location : path
orderBy
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
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 `ListCustomBiddingScripts` method. If not specified, the first page of results will be returned.
Location : query
Parameter Order : customBiddingAlgorithmId
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts
HTTP Method : GET
Description : Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter.
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts
▼ ▲ displayvideo.customBiddingAlgorithms.scripts.create
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
customBiddingAlgorithmId
Description : Required. The ID of the custom bidding algorithm that owns the script.
Type : string
Location : path
Required : Yes
Format : int64
Pattern : ^[^/]+$
advertiserId
Location : query
Type : string
Format : int64
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts
Parameter Order : customBiddingAlgorithmId
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/display-video
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.
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts
▼ ▲ displayvideo.customBiddingAlgorithms.scripts.get
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts/{+customBiddingScriptId}
Parameter Order :
HTTP Method : GET
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts/{scriptsId}
Parameters :
advertiserId
Format : int64
Type : string
Location : query
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
customBiddingAlgorithmId
Required : Yes
Description : Required. The ID of the custom bidding algorithm owns the script.
Type : string
Pattern : ^[^/]+$
Location : path
Format : int64
partnerId
Location : query
Description : The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
Type : string
Format : int64
customBiddingScriptId
Required : Yes
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the custom bidding script to fetch.
Type : string
Format : int64
Description : Gets a custom bidding script.
▼ ▲ displayvideo.customBiddingAlgorithms.list
Flat Path : v4/customBiddingAlgorithms
Parameters :
advertiserId
Description : The ID of the DV360 advertiser that has access to the custom bidding algorithm.
Location : query
Format : int64
Type : string
filter
Location : query
Description : Allows filtering by custom bidding algorithm fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `customBiddingAlgorithmType` field must use the `EQUALS (=)` operator. * The `displayName` field must use the `HAS (:)` operator. Supported fields: * `customBiddingAlgorithmType` * `displayName` Examples: * All custom bidding algorithms for which the display name contains "politics": `displayName:"politics"`. * All custom bidding algorithms for which the type is "SCRIPT_BASED": `customBiddingAlgorithmType=SCRIPT_BASED` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Type : string
partnerId
Type : string
Location : query
Description : The ID of the DV360 partner that has access to the custom bidding algorithm.
Format : int64
orderBy
Type : string
Location : query
Description : Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
pageSize
Format : int32
Type : integer
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Location : query
pageToken
Type : string
Location : query
Description : A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingAlgorithms` method. If not specified, the first page of results will be returned.
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 : v4/customBiddingAlgorithms
HTTP Method : GET
▼ ▲ displayvideo.customBiddingAlgorithms.create
Flat Path : v4/customBiddingAlgorithms
Description : Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Path : v4/customBiddingAlgorithms
▼ ▲ displayvideo.customBiddingAlgorithms.uploadRules
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}:uploadRules
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}: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.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : customBiddingAlgorithmId
Parameters :
advertiserId
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Location : query
Format : int64
Type : string
partnerId
Format : int64
Location : query
Type : string
Description : The ID of the partner that owns the parent custom bidding algorithm.
customBiddingAlgorithmId
Location : path
Type : string
Pattern : ^[^/]+$
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Required : Yes
Format : int64
▼ ▲ displayvideo.customBiddingAlgorithms.patch
Description : Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. Requests updating a custom bidding algorithm assigned to a line item will return an error.
Parameters :
customBiddingAlgorithmId
Required : Yes
Description : Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
updateMask
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Location : query
Type : string
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}
Parameter Order : customBiddingAlgorithmId
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : PATCH
▼ ▲ displayvideo.customBiddingAlgorithms.get
Description : Gets a custom bidding algorithm.
HTTP Method : GET
Parameter Order : customBiddingAlgorithmId
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}
Parameters :
advertiserId
Description : The ID of the DV360 partner that has access to the custom bidding algorithm.
Type : string
Format : int64
Location : query
partnerId
Description : The ID of the DV360 partner that has access to the custom bidding algorithm.
Type : string
Format : int64
Location : query
customBiddingAlgorithmId
Pattern : ^[^/]+$
Required : Yes
Description : Required. The ID of the custom bidding algorithm to fetch.
Type : string
Location : path
Format : int64
▼ ▲ displayvideo.customBiddingAlgorithms.uploadScript
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.
HTTP Method : GET
Parameter Order : customBiddingAlgorithmId
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadScript
Parameters :
advertiserId
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Type : string
Location : query
Format : int64
partnerId
Description : The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
Format : int64
Location : query
Type : string
customBiddingAlgorithmId
Required : Yes
Type : string
Pattern : ^[^/]+$
Description : Required. The ID of the custom bidding algorithm owns the script.
Location : path
Format : int64
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}:uploadScript
▼ ▲ displayvideo.firstPartyAndPartnerAudiences.get
Parameters :
advertiserId
Location : query
Description : The ID of the advertiser that has access to the fetched first party and partner audience.
Type : string
Format : int64
firstPartyAndPartnerAudienceId
Location : path
Format : int64
Description : Required. The ID of the first party and partner audience to fetch.
Type : string
Pattern : ^[^/]+$
Required : Yes
partnerId
Location : query
Type : string
Description : The ID of the partner that has access to the fetched first party and partner audience.
Format : int64
Path : v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}
Flat Path : v4/firstPartyAndPartnerAudiences/{firstPartyAndPartnerAudiencesId}
Parameter Order : firstPartyAndPartnerAudienceId
Scopes : https://www.googleapis.com/auth/display-video
Description : Gets a first party or partner audience.
HTTP Method : GET
▼ ▲ displayvideo.firstPartyAndPartnerAudiences.editCustomerMatchMembers
Parameter Order : firstPartyAndPartnerAudienceId
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Flat Path : v4/firstPartyAndPartnerAudiences/{firstPartyAndPartnerAudiencesId}:editCustomerMatchMembers
Path : v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}:editCustomerMatchMembers
Description : Updates the member list of a Customer Match audience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
Parameters :
firstPartyAndPartnerAudienceId
Type : string
Description : Required. The ID of the Customer Match FirstPartyAndPartnerAudience whose members will be edited.
Pattern : ^[^/]+$
Required : Yes
Format : int64
Location : path
▼ ▲ displayvideo.firstPartyAndPartnerAudiences.create
Path : v4/firstPartyAndPartnerAudiences
Description : Creates a FirstPartyAndPartnerAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
HTTP Method : POST
Flat Path : v4/firstPartyAndPartnerAudiences
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Location : query
Format : int64
Type : string
Description : Required. The ID of the advertiser under whom the FirstPartyAndPartnerAudience will be created.
▼ ▲ displayvideo.firstPartyAndPartnerAudiences.list
Parameters :
advertiserId
Location : query
Description : The ID of the advertiser that has access to the fetched first party and partner audiences.
Format : int64
Type : string
pageToken
Description : Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFirstPartyAndPartnerAudiences` method. If not specified, the first page of results will be returned.
Location : query
Type : string
pageSize
Location : query
Format : int32
Type : integer
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.
orderBy
Location : query
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`.
Type : string
filter
Location : query
Type : string
Description : Optional. Allows filtering by first party and partner audience fields. Supported syntax: * Filter expressions for first party and partner audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All first party and partner audiences for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
partnerId
Location : query
Type : string
Format : int64
Description : The ID of the partner that has access to the fetched first party and partner audiences.
Description : Lists first party and partner audiences. The order is defined by the order_by parameter.
HTTP Method : GET
Path : v4/firstPartyAndPartnerAudiences
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/firstPartyAndPartnerAudiences
▼ ▲ displayvideo.firstPartyAndPartnerAudiences.patch
Path : v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}
Parameters :
firstPartyAndPartnerAudienceId
Pattern : ^[^/]+$
Location : path
Description : Identifier. The unique ID of the first party and partner audience. Assigned by the system.
Format : int64
Type : string
Required : Yes
updateMask
Type : string
Location : query
Format : google-fieldmask
Description : Required. The mask to control which fields to update. Updates are only supported for the following fields: * `displayName` * `description` * `membershipDurationDays`
advertiserId
Description : Required. The ID of the owner advertiser of the updated FirstPartyAndPartnerAudience.
Format : int64
Location : query
Type : string
Parameter Order : firstPartyAndPartnerAudienceId
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : PATCH
Description : Updates an existing FirstPartyAndPartnerAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
Flat Path : v4/firstPartyAndPartnerAudiences/{firstPartyAndPartnerAudiencesId}
▼ ▲ displayvideo.combinedAudiences.get
Scopes : https://www.googleapis.com/auth/display-video
Description : Gets a combined audience.
Flat Path : v4/combinedAudiences/{combinedAudiencesId}
HTTP Method : GET
Path : v4/combinedAudiences/{+combinedAudienceId}
Parameters :
partnerId
Type : string
Location : query
Format : int64
Description : The ID of the partner that has access to the fetched combined audience.
combinedAudienceId
Pattern : ^[^/]+$
Required : Yes
Description : Required. The ID of the combined audience to fetch.
Type : string
Format : int64
Location : path
advertiserId
Type : string
Format : int64
Description : The ID of the advertiser that has access to the fetched combined audience.
Location : query
Parameter Order : combinedAudienceId
▼ ▲ displayvideo.combinedAudiences.list
Path : v4/combinedAudiences
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/combinedAudiences
HTTP Method : GET
Parameters :
partnerId
Type : string
Description : The ID of the partner that has access to the fetched combined audiences.
Location : query
Format : int64
advertiserId
Location : query
Type : string
Description : The ID of the advertiser that has access to the fetched combined audiences.
Format : int64
pageSize
Type : integer
Format : int32
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Location : query
orderBy
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`.
Location : query
filter
Location : query
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
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 `ListCombinedAudiences` method. If not specified, the first page of results will be returned.
Description : Lists combined audiences. The order is defined by the order_by parameter.
▼ ▲ displayvideo.inventorySources.editInventorySourceReadWriteAccessors
Path : v4/inventorySources/{+inventorySourceId}:editInventorySourceReadWriteAccessors
Description : Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.
Flat Path : v4/inventorySources/{inventorySourcesId}:editInventorySourceReadWriteAccessors
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Parameter Order : inventorySourceId
Parameters :
inventorySourceId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of inventory source to update.
Type : string
Required : Yes
▼ ▲ displayvideo.inventorySources.get
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/display-video
Description : Gets an inventory source.
Parameter Order : inventorySourceId
Parameters :
partnerId
Location : query
Format : int64
Description : Required. The ID of the DV360 partner to which the fetched inventory source is permissioned.
Type : string
inventorySourceId
Description : Required. The ID of the inventory source to fetch.
Location : path
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
advertiserId
Description : Optional. The ID of the DV360 advertiser to which the fetched inventory source is permissioned. If the user only has access to the advertiser and not the parent partner, use this field to specify the relevant advertiser.
Location : query
Format : int64
Type : string
Flat Path : v4/inventorySources/{inventorySourcesId}
Path : v4/inventorySources/{+inventorySourceId}
▼ ▲ displayvideo.inventorySources.list
HTTP Method : GET
Description : Lists inventory sources that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.
Parameters :
filter
Type : string
Location : query
Description : Allows filtering by inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `status.entityStatus` * `commitment` * `deliveryMethod` * `rateDetails.rateType` * `exchange` Examples: * All active inventory sources: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
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
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
pageSize
Type : integer
Format : int32
Location : query
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
partnerId
Description : The ID of the partner that has access to the inventory source.
Location : query
Type : string
Format : int64
advertiserId
Type : string
Description : The ID of the advertiser that has access to the inventory source.
Format : int64
Location : query
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/inventorySources
Path : v4/inventorySources
▼ ▲ displayvideo.inventorySources.create
Description : Creates a new inventory source. Returns the newly created inventory source if successful.
HTTP Method : POST
Path : v4/inventorySources
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Description : The ID of the advertiser that the request is being made within.
Type : string
Format : int64
Location : query
partnerId
Format : int64
Type : string
Description : The ID of the partner that the request is being made within.
Location : query
Flat Path : v4/inventorySources
▼ ▲ displayvideo.inventorySources.patch
Parameters :
partnerId
Description : The ID of the partner that the request is being made within.
Type : string
Format : int64
Location : query
updateMask
Description : Required. The mask to control which fields to update.
Location : query
Type : string
Format : google-fieldmask
advertiserId
Type : string
Location : query
Format : int64
Description : The ID of the advertiser that the request is being made within.
inventorySourceId
Description : Output only. The unique ID of the inventory source. Assigned by the system.
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
Scopes : https://www.googleapis.com/auth/display-video
Description : Updates an existing inventory source. Returns the updated inventory source if successful.
HTTP Method : PATCH
Flat Path : v4/inventorySources/{inventorySourcesId}
Path : v4/inventorySources/{+inventorySourceId}
Parameter Order : inventorySourceId
▼ ▲ displayvideo.guaranteedOrders.patch
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/guaranteedOrders/{+guaranteedOrderId}
Parameters :
advertiserId
Description : The ID of the advertiser that the request is being made within.
Location : query
Format : int64
Type : string
partnerId
Type : string
Description : The ID of the partner that the request is being made within.
Format : int64
Location : query
guaranteedOrderId
Required : Yes
Type : string
Description : Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
Location : path
Pattern : ^[^/]+$
updateMask
Format : google-fieldmask
Type : string
Location : query
Description : Required. The mask to control which fields to update.
Description : Updates an existing guaranteed order. Returns the updated guaranteed order if successful.
HTTP Method : PATCH
Parameter Order : guaranteedOrderId
Flat Path : v4/guaranteedOrders/{guaranteedOrdersId}
▼ ▲ displayvideo.guaranteedOrders.get
Parameters :
guaranteedOrderId
Description : Required. The ID of the guaranteed order to fetch. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`
Required : Yes
Pattern : ^[^/]+$
Type : string
Location : path
partnerId
Type : string
Location : query
Description : The ID of the partner that has access to the guaranteed order.
Format : int64
advertiserId
Type : string
Description : The ID of the advertiser that has access to the guaranteed order.
Location : query
Format : int64
Description : Gets a guaranteed order.
Flat Path : v4/guaranteedOrders/{guaranteedOrdersId}
HTTP Method : GET
Path : v4/guaranteedOrders/{+guaranteedOrderId}
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : guaranteedOrderId
▼ ▲ displayvideo.guaranteedOrders.editGuaranteedOrderReadAccessors
Path : v4/guaranteedOrders/{+guaranteedOrderId}:editGuaranteedOrderReadAccessors
Flat Path : v4/guaranteedOrders/{guaranteedOrdersId}:editGuaranteedOrderReadAccessors
Parameters :
guaranteedOrderId
Type : string
Location : path
Required : Yes
Description : Required. The ID of the guaranteed order to edit. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`
Pattern : ^[^/]+$
HTTP Method : POST
Parameter Order : guaranteedOrderId
Scopes : https://www.googleapis.com/auth/display-video
Description : Edits read advertisers of a guaranteed order.
▼ ▲ displayvideo.guaranteedOrders.list
Parameters :
orderBy
Location : query
Description : Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
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 `ListGuaranteedOrders` method. If not specified, the first page of results will be returned.
Type : string
Location : query
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.
Type : string
Location : query
pageSize
Location : query
Format : int32
Type : integer
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
advertiserId
Description : The ID of the advertiser that has access to the guaranteed order.
Format : int64
Location : query
Type : string
partnerId
Location : query
Description : The ID of the partner that has access to the guaranteed order.
Format : int64
Type : string
Path : v4/guaranteedOrders
Flat Path : v4/guaranteedOrders
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.
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
▼ ▲ displayvideo.guaranteedOrders.create
Parameters :
partnerId
Description : The ID of the partner that the request is being made within.
Format : int64
Type : string
Location : query
advertiserId
Description : The ID of the advertiser that the request is being made within.
Location : query
Type : string
Format : int64
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/guaranteedOrders
HTTP Method : POST
Path : v4/guaranteedOrders
Description : Creates a new guaranteed order. Returns the newly created guaranteed order if successful.
▼ ▲ displayvideo.sdfdownloadtasks.operations.get
Flat Path : v4/sdfdownloadtasks/operations/{operationsId}
Description : Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.
Parameters :
name
Type : string
Required : Yes
Pattern : ^sdfdownloadtasks/operations/[^/]+$
Description : The name of the operation resource.
Location : path
Scopes :
Parameter Order : name
Path : v4/{+name}
HTTP Method : GET
▼ ▲ displayvideo.sdfdownloadtasks.create
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/sdfdownloadtasks
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.
HTTP Method : POST
Path : v4/sdfdownloadtasks
▼ ▲ displayvideo.googleAudiences.get
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/googleAudiences/{+googleAudienceId}
Parameters :
partnerId
Type : string
Format : int64
Description : The ID of the partner that has access to the fetched Google audience.
Location : query
googleAudienceId
Required : Yes
Pattern : ^[^/]+$
Description : Required. The ID of the Google audience to fetch.
Location : path
Type : string
Format : int64
advertiserId
Format : int64
Description : The ID of the advertiser that has access to the fetched Google audience.
Location : query
Type : string
Description : Gets a Google audience.
Parameter Order : googleAudienceId
HTTP Method : GET
Flat Path : v4/googleAudiences/{googleAudiencesId}
▼ ▲ displayvideo.googleAudiences.list
HTTP Method : GET
Flat Path : v4/googleAudiences
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Type : string
Description : The ID of the partner that has access to the fetched Google audiences.
Format : int64
Location : query
advertiserId
Format : int64
Type : string
Location : query
Description : The ID of the advertiser that has access to the fetched Google audiences.
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
Type : integer
Format : int32
filter
Location : query
Type : string
Description : Allows filtering by Google audience fields. Supported syntax: * Filter expressions for Google audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All Google audiences for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
orderBy
Type : string
Description : Field by which to sort the list. Acceptable values are: * `googleAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
Location : query
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 `ListGoogleAudiences` method. If not specified, the first page of results will be returned.
Path : v4/googleAudiences
Description : Lists Google audiences. The order is defined by the order_by parameter.
▼ ▲ displayvideo.inventorySourceGroups.get
Path : v4/inventorySourceGroups/{+inventorySourceGroupId}
Parameter Order : inventorySourceGroupId
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupsId}
Parameters :
partnerId
Description : The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group.
Location : query
Type : string
Format : int64
advertiserId
Description : The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.
Location : query
Type : string
Format : int64
inventorySourceGroupId
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
Description : Required. The ID of the inventory source group to fetch.
Required : Yes
Scopes : https://www.googleapis.com/auth/display-video
Description : Gets an inventory source group.
HTTP Method : GET
▼ ▲ displayvideo.inventorySourceGroups.create
Parameters :
partnerId
Location : query
Description : The ID of the partner that owns the inventory source group. Only this partner will have write access to this group. Only advertisers to which this group is explicitly shared will have read access to this group.
Type : string
Format : int64
advertiserId
Description : The ID of the advertiser that owns the inventory source group. The parent partner will not have access to this group.
Location : query
Format : int64
Type : string
Flat Path : v4/inventorySourceGroups
Path : v4/inventorySourceGroups
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Description : Creates a new inventory source group. Returns the newly created inventory source group if successful.
▼ ▲ displayvideo.inventorySourceGroups.delete
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupsId}
HTTP Method : DELETE
Parameter Order : inventorySourceGroupId
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/inventorySourceGroups/{+inventorySourceGroupId}
Parameters :
inventorySourceGroupId
Type : string
Description : Required. The ID of the inventory source group to delete.
Location : path
Pattern : ^[^/]+$
Format : int64
Required : Yes
partnerId
Description : The ID of the partner that owns the inventory source group. Only this partner has write access to this group.
Location : query
Type : string
Format : int64
advertiserId
Format : int64
Description : The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.
Location : query
Type : string
Description : Deletes an inventory source group.
▼ ▲ displayvideo.inventorySourceGroups.patch
Path : v4/inventorySourceGroups/{inventorySourceGroupId}
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : inventorySourceGroupId
Description : Updates an inventory source group. Returns the updated inventory source group if successful.
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupId}
Parameters :
inventorySourceGroupId
Location : path
Description : Output only. The unique ID of the inventory source group. Assigned by the system.
Type : string
Format : int64
Required : Yes
advertiserId
Description : The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.
Type : string
Format : int64
Location : query
updateMask
Location : query
Format : google-fieldmask
Type : string
Description : Required. The mask to control which fields to update.
partnerId
Location : query
Format : int64
Description : The ID of the partner that owns the inventory source group. Only this partner has write access to this group.
Type : string
▼ ▲ displayvideo.inventorySourceGroups.list
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameters :
filter
Location : query
Type : string
Description : Allows filtering by inventory source group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `inventorySourceGroupId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
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
advertiserId
Location : query
Type : string
Format : int64
Description : The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.
pageSize
Location : query
Type : integer
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Format : int32
pageToken
Description : A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned.
Location : query
Type : string
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`.
Description : Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter.
Flat Path : v4/inventorySourceGroups
Path : v4/inventorySourceGroups
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.create
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources
Parameters :
partnerId
Location : query
Format : int64
Type : string
Description : The ID of the partner that owns the parent inventory source group. Only this partner will have write access to this assigned inventory source.
inventorySourceGroupId
Type : string
Location : path
Pattern : ^[^/]+$
Required : Yes
Description : Required. The ID of the inventory source group to which the assignment will be assigned.
Format : int64
advertiserId
Description : The ID of the advertiser that owns the parent inventory source group. The parent partner will not have access to this assigned inventory source.
Type : string
Location : query
Format : int64
Description : Creates an assignment between an inventory source and an inventory source group.
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources
Parameter Order : inventorySourceGroupId
HTTP Method : POST
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.delete
HTTP Method : DELETE
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources/{assignedInventorySourcesId}
Path : v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources/{+assignedInventorySourceId}
Description : Deletes the assignment between an inventory source and an inventory source group.
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Type : string
Format : int64
Description : The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to this assigned inventory source.
Location : query
assignedInventorySourceId
Format : int64
Location : path
Description : Required. The ID of the assigned inventory source to delete.
Type : string
Pattern : ^[^/]+$
Required : Yes
partnerId
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
Type : string
inventorySourceGroupId
Required : Yes
Description : Required. The ID of the inventory source group to which this assignment is assigned.
Pattern : ^[^/]+$
Format : int64
Location : path
Type : string
Parameter Order :
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.bulkEdit
Parameters :
inventorySourceGroupId
Location : path
Format : int64
Description : Required. The ID of the inventory source group to which the assignments are assigned.
Pattern : ^[^/]+$
Type : string
Required : Yes
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 : v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources:bulkEdit
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources:bulkEdit
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : inventorySourceGroupId
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.list
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 `ListAssignedInventorySources` method. If not specified, the first page of results will be returned.
Type : string
advertiserId
Location : query
Description : The ID of the advertiser that has access to the assignment. If the parent inventory source group is partner-owned, only advertisers to which the parent group is explicitly shared can access the assigned inventory source.
Type : string
Format : int64
orderBy
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`.
Location : query
inventorySourceGroupId
Description : Required. The ID of the inventory source group to which these assignments are assigned.
Type : string
Format : int64
Location : path
Required : Yes
Pattern : ^[^/]+$
pageSize
Location : query
Format : int32
Type : integer
Description : Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
partnerId
Description : The ID of the partner that has access to the assignment. If the parent inventory source group is advertiser-owned, the assignment cannot be accessed via a partner.
Location : query
Type : string
Format : int64
filter
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
Location : query
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : inventorySourceGroupId
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources
HTTP Method : GET
Description : Lists inventory sources assigned to an inventory source group.
Path : v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources
▼ ▲ displayvideo.media.download
Supportsmediadownload : Yes
Parameter Order : resourceName
HTTP Method : GET
Path : download/{+resourceName}
Description : Downloads media. Download is supported on the URI `/download/{resource_name=**}?alt=media.` **Note**: Download requests will not be successful without including `alt=media` query string.
Flat Path : download/{downloadId}
Parameters :
resourceName
Location : path
Type : string
Description : Name of the media that is being downloaded. See ReadRequest.resource_name.
Required : Yes
Pattern : ^.*$
Scopes :
▼ ▲ displayvideo.media.upload
Flat Path : media/{mediaId}
Path : media/{+resourceName}
Mediaupload :
Protocols :
Simple :
Multipart : Yes
Path : /upload/media/{+resourceName}
Accept : */*
Scopes :
Supportsmediaupload : Yes
Description : Uploads media. Upload is supported on the URI `/upload/media/{resource_name=**}?upload_type=media.` **Note**: Upload requests will not be successful without including `upload_type=media` query string.
HTTP Method : POST
Parameter Order : resourceName
Parameters :
resourceName
Type : string
Required : Yes
Location : path
Description : Name of the media that is being downloaded. See ReadRequest.resource_name.
Pattern : ^.*$
▼ ▲ displayvideo.advertisers.patch
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}
Flat Path : v4/advertisers/{advertisersId}
Parameters :
advertiserId
Type : string
Format : int64
Required : Yes
Pattern : ^[^/]+$
Location : path
Description : Output only. The unique ID of the advertiser. Assigned by the system.
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Type : string
Format : google-fieldmask
Description : Updates an existing advertiser. Returns the updated advertiser if successful.
Parameter Order : advertiserId
HTTP Method : PATCH
▼ ▲ displayvideo.advertisers.create
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers
HTTP Method : POST
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.
Flat Path : v4/advertisers
▼ ▲ displayvideo.advertisers.delete
Path : v4/advertisers/{+advertiserId}
Flat Path : v4/advertisers/{advertisersId}
HTTP Method : DELETE
Parameter Order : 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.
Parameters :
advertiserId
Pattern : ^[^/]+$
Location : path
Required : Yes
Description : The ID of the advertiser we need to delete.
Format : int64
Type : string
▼ ▲ displayvideo.advertisers.list
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers
HTTP Method : GET
Flat Path : v4/advertisers
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.
Parameters :
partnerId
Format : int64
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
pageSize
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Location : query
Format : int32
Type : integer
filter
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.
Location : query
Type : string
orderBy
Location : query
Description : Field by which to sort the list. Acceptable values are: * `advertiserId` (default) * `displayName` * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
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 `ListAdvertisers` method. If not specified, the first page of results will be returned.
Type : string
Location : query
▼ ▲ displayvideo.advertisers.get
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}
Flat Path : v4/advertisers/{advertisersId}
Parameter Order : advertiserId
Description : Gets an advertiser.
Parameters :
advertiserId
Format : int64
Required : Yes
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the advertiser to fetch.
Type : string
▼ ▲ displayvideo.advertisers.audit
Parameters :
readMask
Type : string
Location : query
Format : google-fieldmask
Description : Optional. The specific fields to return. If no mask is specified, all fields in the response proto will be filled. Valid values are: * usedLineItemsCount * usedInsertionOrdersCount * usedCampaignsCount * channelsCount * negativelyTargetedChannelsCount * negativeKeywordListsCount * adGroupCriteriaCount * campaignCriteriaCount
advertiserId
Location : path
Type : string
Format : int64
Description : Required. The ID of the advertiser to audit.
Pattern : ^[^/]+$
Required : Yes
Flat Path : v4/advertisers/{advertisersId}:audit
Path : v4/advertisers/{+advertiserId}:audit
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
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.
▼ ▲ displayvideo.advertisers.listAssignedTargetingOptions
Flat Path : v4/advertisers/{advertisersId}:listAssignedTargetingOptions
Parameters :
filter
Type : string
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.
advertiserId
Pattern : ^[^/]+$
Location : path
Format : int64
Description : Required. The ID of the advertiser the line item belongs to.
Required : Yes
Type : string
pageSize
Location : query
Description : Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Type : integer
Format : int32
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`.
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 `BulkListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}:listAssignedTargetingOptions
Description : Lists assigned targeting options of an advertiser across targeting types.
Parameter Order : advertiserId
HTTP Method : GET
▼ ▲ displayvideo.advertisers.editAssignedTargetingOptions
HTTP Method : POST
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 .
Parameters :
advertiserId
Required : Yes
Pattern : ^[^/]+$
Format : int64
Type : string
Description : Required. The ID of the advertiser.
Location : path
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}:editAssignedTargetingOptions
Path : v4/advertisers/{+advertiserId}:editAssignedTargetingOptions
▼ ▲ displayvideo.advertisers.adGroupAds.create
HTTP Method : POST
Flat Path : v4/advertisers/{advertisersId}/adGroupAds
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : Output only. The unique ID of the advertiser the ad belongs to.
Location : path
Format : int64
Parameter Order : advertiserId
Description : Creates an ad group ad.
Path : v4/advertisers/{+advertiserId}/adGroupAds
▼ ▲ displayvideo.advertisers.adGroupAds.delete
HTTP Method : DELETE
Description : Deletes an ad group ad.
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
adGroupAdId
Required : Yes
Description : Required. The ID of the ad to delete.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
advertiserId
Description : Required. The ID of the advertiser the ad belongs to.
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Parameter Order :
Flat Path : v4/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}
Path : v4/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}
▼ ▲ displayvideo.advertisers.adGroupAds.get
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Format : int64
Required : Yes
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser this ad group ad belongs to.
Location : path
Type : string
adGroupAdId
Description : Required. The ID of the ad to fetch.
Required : Yes
Type : string
Format : int64
Pattern : ^[^/]+$
Location : path
Parameter Order :
Path : v4/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}
Flat Path : v4/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}
HTTP Method : GET
Description : Gets an ad group ad.
▼ ▲ displayvideo.advertisers.adGroupAds.patch
HTTP Method : PATCH
Path : v4/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}
Description : Updates an ad group ad.
Parameter Order :
Flat Path : v4/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}
Parameters :
adGroupAdId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Output only. The unique ID of the ad. Assigned by the system.
Type : string
Required : Yes
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Description : Output only. The unique ID of the advertiser the ad belongs to.
Type : string
updateMask
Location : query
Format : google-fieldmask
Type : string
Description : Required. The mask to control which fields to update.
▼ ▲ displayvideo.advertisers.adGroupAds.list
HTTP Method : GET
Description : Lists ad group ads.
Path : v4/advertisers/{+advertiserId}/adGroupAds
Flat Path : v4/advertisers/{advertisersId}/adGroupAds
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
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 ads belong to.
Location : path
Type : string
Format : int64
Pattern : ^[^/]+$
Required : Yes
filter
Location : query
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.
Type : string
pageSize
Type : integer
Format : int32
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.
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 `ListAdGroupAds` method. If not specified, the first page of results will be returned.
Type : string
Location : query
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.insertionOrders.get
Parameter Order :
Parameters :
advertiserId
Location : path
Pattern : ^[^/]+$
Format : int64
Required : Yes
Description : Required. The ID of the advertiser this insertion order belongs to.
Type : string
insertionOrderId
Required : Yes
Pattern : ^[^/]+$
Description : Required. The ID of the insertion order to fetch.
Location : path
Format : int64
Type : string
Path : v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}
HTTP Method : GET
Description : Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist.
▼ ▲ displayvideo.advertisers.insertionOrders.patch
Parameters :
advertiserId
Description : Output only. The unique ID of the advertiser the insertion order belongs to.
Required : Yes
Type : string
Pattern : ^[^/]+$
Location : path
Format : int64
insertionOrderId
Location : path
Format : int64
Description : Output only. The unique ID of the insertion order. Assigned by the system.
Pattern : ^[^/]+$
Type : string
Required : Yes
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Type : string
Path : v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : PATCH
Flat Path : v4/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}
Description : Updates an existing insertion order. Returns the updated insertion order if successful.
▼ ▲ displayvideo.advertisers.insertionOrders.create
HTTP Method : POST
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}/insertionOrders
Parameters :
advertiserId
Required : Yes
Type : string
Format : int64
Pattern : ^[^/]+$
Location : path
Description : Output only. The unique ID of the advertiser the insertion order belongs to.
Scopes : https://www.googleapis.com/auth/display-video
Description : Creates a new insertion order. Returns the newly created insertion order if successful.
Path : v4/advertisers/{+advertiserId}/insertionOrders
▼ ▲ 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.
Parameter Order :
HTTP Method : DELETE
Path : v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}
Flat Path : v4/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Required : Yes
Description : The ID of the advertiser this insertion order belongs to.
Type : string
Format : int64
Pattern : ^[^/]+$
Location : path
insertionOrderId
Location : path
Pattern : ^[^/]+$
Format : int64
Description : The ID of the insertion order to delete.
Required : Yes
Type : string
▼ ▲ displayvideo.advertisers.insertionOrders.list
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
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
Description : Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" * "updateTime" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
Location : query
advertiserId
Required : Yes
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser to list insertion orders for.
Format : int64
Location : path
Type : string
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.
Location : query
Type : integer
pageToken
Description : A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrders` method. If not specified, the first page of results will be returned.
Location : query
Type : string
Path : v4/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.
Flat Path : v4/advertisers/{advertisersId}/insertionOrders
HTTP Method : GET
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.invoices.list
Parameter Order : advertiserId
Scopes :
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 `ListInvoices` method. If not specified, the first page of results will be returned.
Location : query
Type : string
loiSapinInvoiceType
Enum :
Description : Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise.
Enum Descriptions :
Type : string
Location : query
issueMonth
Description : The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM.
Type : string
Location : query
pageSize
Type : integer
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Location : query
Format : int32
advertiserId
Type : string
Format : int64
Pattern : ^[^/]+$
Required : Yes
Location : path
Description : Required. The ID of the advertiser to list invoices for.
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.
Path : v4/advertisers/{+advertiserId}/invoices
HTTP Method : GET
Flat Path : v4/advertisers/{advertisersId}/invoices
▼ ▲ displayvideo.advertisers.invoices.lookupInvoiceCurrency
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/invoices:lookupInvoiceCurrency
Scopes :
Parameters :
invoiceMonth
Type : string
Location : query
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.
advertiserId
Location : path
Pattern : ^[^/]+$
Format : int64
Description : Required. The ID of the advertiser to lookup currency for.
Required : Yes
Type : string
Description : Retrieves the invoice currency used by an advertiser in a given month.
HTTP Method : GET
Flat Path : v4/advertisers/{advertisersId}/invoices:lookupInvoiceCurrency
▼ ▲ displayvideo.advertisers.campaigns.get
Parameters :
campaignId
Pattern : ^[^/]+$
Description : Required. The ID of the campaign to fetch.
Required : Yes
Format : int64
Location : path
Type : string
advertiserId
Description : Required. The ID of the advertiser this campaign belongs to.
Type : string
Required : Yes
Format : int64
Location : path
Pattern : ^[^/]+$
Scopes :
Parameter Order :
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/campaigns/{+campaignId}
Flat Path : v4/advertisers/{advertisersId}/campaigns/{campaignsId}
Description : Gets a campaign.
▼ ▲ displayvideo.advertisers.campaigns.list
Path : v4/advertisers/{+advertiserId}/campaigns
Scopes :
Parameter Order : advertiserId
HTTP Method : GET
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.
Flat Path : v4/advertisers/{advertisersId}/campaigns
Parameters :
advertiserId
Pattern : ^[^/]+$
Location : path
Format : int64
Type : string
Description : The ID of the advertiser to list campaigns for.
Required : Yes
pageToken
Location : query
Type : string
Description : A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaigns` method. If not specified, the first page of results will be returned.
pageSize
Location : query
Format : int32
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Type : integer
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.
orderBy
Type : string
Description : Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
Location : query
▼ ▲ displayvideo.advertisers.campaigns.create
Path : v4/advertisers/{+advertiserId}/campaigns
Parameters :
advertiserId
Required : Yes
Description : Output only. The unique ID of the advertiser the campaign belongs to.
Location : path
Type : string
Pattern : ^[^/]+$
Format : int64
Scopes :
Flat Path : v4/advertisers/{advertisersId}/campaigns
Parameter Order : advertiserId
HTTP Method : POST
Description : Creates a new campaign. Returns the newly created campaign if successful.
▼ ▲ displayvideo.advertisers.campaigns.delete
Parameter Order :
HTTP Method : DELETE
Scopes :
Path : v4/advertisers/{+advertiserId}/campaigns/{+campaignId}
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.
Parameters :
advertiserId
Location : path
Type : string
Pattern : ^[^/]+$
Format : int64
Required : Yes
Description : The ID of the advertiser this campaign belongs to.
campaignId
Description : The ID of the campaign we need to delete.
Type : string
Required : Yes
Pattern : ^[^/]+$
Location : path
Format : int64
Flat Path : v4/advertisers/{advertisersId}/campaigns/{campaignsId}
▼ ▲ displayvideo.advertisers.campaigns.patch
Description : Updates an existing campaign. Returns the updated campaign if successful.
Parameter Order :
Scopes :
Parameters :
advertiserId
Required : Yes
Type : string
Description : Output only. The unique ID of the advertiser the campaign belongs to.
Pattern : ^[^/]+$
Format : int64
Location : path
updateMask
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Location : query
Type : string
campaignId
Format : int64
Required : Yes
Type : string
Location : path
Description : Output only. The unique ID of the campaign. Assigned by the system.
Pattern : ^[^/]+$
Path : v4/advertisers/{+advertiserId}/campaigns/{+campaignId}
Flat Path : v4/advertisers/{advertisersId}/campaigns/{campaignsId}
HTTP Method : PATCH
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
targetingType
Type : string
Location : path
Enum :
Pattern : ^[^/]+$
Description : Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_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 Descriptions :
Required : Yes
pageSize
Location : query
Format : int32
Type : integer
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.
advertiserId
Format : int64
Location : path
Type : string
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser the line item belongs to.
Required : Yes
pageToken
Type : string
Location : query
Description : A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
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`.
Type : string
Location : query
lineItemId
Required : Yes
Type : string
Location : path
Description : Required. The ID of the line item to list assigned targeting options for.
Pattern : ^[^/]+$
Format : int64
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
Parameter Order :
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions
HTTP Method : GET
Description : Lists the targeting options assigned to a line item.
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
targetingType
Location : path
Pattern : ^[^/]+$
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
Enum :
advertiserId
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Location : path
Description : Required. The ID of the advertiser the line item belongs to.
lineItemId
Required : Yes
Type : string
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the line item the assigned targeting option will belong to.
Format : int64
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 : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Parameter Order :
HTTP Method : POST
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
HTTP Method : DELETE
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Parameters :
targetingType
Required : Yes
Enum :
Pattern : ^[^/]+$
Enum Descriptions :
Location : path
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUCTION_PACKAGE` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE_DEAL` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`
Type : string
assignedTargetingOptionId
Location : path
Pattern : ^[^/]+$
Type : string
Required : Yes
Description : Required. The ID of the assigned targeting option to delete.
advertiserId
Location : path
Description : Required. The ID of the advertiser the line item belongs to.
Format : int64
Pattern : ^[^/]+$
Type : string
Required : Yes
lineItemId
Required : Yes
Pattern : ^[^/]+$
Type : string
Location : path
Description : Required. The ID of the line item the assigned targeting option belongs to.
Format : int64
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.
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Parameters :
advertiserId
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the advertiser the line item belongs to.
Required : Yes
Type : string
Format : int64
assignedTargetingOptionId
Location : path
Pattern : ^[^/]+$
Type : string
Required : Yes
Description : Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.
targetingType
Enum Descriptions :
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_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)
Type : string
Required : Yes
Enum :
Pattern : ^[^/]+$
Location : path
lineItemId
Required : Yes
Description : Required. The ID of the line item the assigned targeting option belongs to.
Format : int64
Pattern : ^[^/]+$
Location : path
Type : string
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Description : Gets a single targeting option assigned to a line item.
▼ ▲ displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.list
Parameter Order :
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations
Parameters :
pageSize
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.
Format : int32
lineItemId
Required : Yes
Type : string
Format : int64
Pattern : ^[^/]+$
Description : The ID of a line item.
Location : path
linkedEntity.adGroupId
Location : query
Type : string
Format : int64
Description : The ID of an ad group.
orderBy
Type : string
Description : Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`.
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 `ListYoutubeAssetAssociations` method. If not specified, the first page of results will be returned.
Type : string
youtubeAssetType
Enum Descriptions :
Location : path
Pattern : ^[^/]+$
Description : Required. The type of YouTube asset being associated with the resource.
Enum :
Required : Yes
Type : string
advertiserId
Format : int64
Required : Yes
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser that the linked entity belongs to.
Location : path
Type : string
Description : Lists the YouTube asset associations linked to the given resource.
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations
HTTP Method : GET
▼ ▲ displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.create
Parameters :
advertiserId
Location : path
Pattern : ^[^/]+$
Type : string
Required : Yes
Format : int64
Description : Required. The ID of the advertiser that the linked entity belongs to.
linkedEntity.adGroupId
Format : int64
Type : string
Description : The ID of an ad group.
Location : query
youtubeAssetType
Enum Descriptions :
Location : path
Enum :
Pattern : ^[^/]+$
Description : Required. The type of YouTube asset associated with the resource.
Type : string
Required : Yes
lineItemId
Required : Yes
Pattern : ^[^/]+$
Description : The ID of a line item.
Location : path
Type : string
Format : int64
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
HTTP Method : POST
Description : Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users.
▼ ▲ displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.delete
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
youtubeAssetType
Required : Yes
Enum :
Location : path
Type : string
Pattern : ^[^/]+$
Enum Descriptions :
Description : Required. The type of YouTube asset associated with the resource.
lineItemId
Type : string
Required : Yes
Format : int64
Description : The ID of a line item.
Pattern : ^[^/]+$
Location : path
advertiserId
Location : path
Description : Required. The ID of the advertiser that the linked entity belongs to.
Format : int64
Type : string
Required : Yes
Pattern : ^[^/]+$
linkedEntity.adGroupId
Format : int64
Location : query
Type : string
Description : The ID of an ad group.
youtubeAssetAssociationId
Format : int64
Pattern : ^[^/]+$
Required : Yes
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.
Location : path
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations/{youtubeAssetAssociationsId}
Parameter Order :
HTTP Method : 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.
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations/{+youtubeAssetAssociationId}
▼ ▲ displayvideo.advertisers.lineItems.bulkEditAssignedTargetingOptions
Description : Bulk edits targeting options under multiple line items. The operation will delete the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.create_requests. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkUpdate * lineItems.patch * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API.
Parameters :
advertiserId
Type : string
Pattern : ^[^/]+$
Required : Yes
Description : Required. The ID of the advertiser the line items belong to.
Format : int64
Location : path
HTTP Method : POST
Path : v4/advertisers/{+advertiserId}/lineItems:bulkEditAssignedTargetingOptions
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}/lineItems:bulkEditAssignedTargetingOptions
▼ ▲ displayvideo.advertisers.lineItems.create
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Description : Output only. The unique ID of the advertiser the line item belongs to.
Format : int64
Required : Yes
Pattern : ^[^/]+$
Location : path
Type : string
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.
Flat Path : v4/advertisers/{advertisersId}/lineItems
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/lineItems
▼ ▲ displayvideo.advertisers.lineItems.bulkListAssignedTargetingOptions
Parameters :
pageSize
Format : int32
Description : Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Location : query
Type : integer
advertiserId
Format : int64
Required : Yes
Type : string
Location : path
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser the line items belongs to.
lineItemIds
Location : query
Repeated : Yes
Type : string
Format : int64
Description : Required. The IDs of the line items to list assigned targeting options for.
filter
Description : Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR` on the same field. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Type : string
Location : query
pageToken
Type : string
Location : query
Description : A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
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
Flat Path : v4/advertisers/{advertisersId}/lineItems:bulkListAssignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/lineItems:bulkListAssignedTargetingOptions
HTTP Method : GET
Description : Lists assigned targeting options for multiple line items across targeting types.
▼ ▲ displayvideo.advertisers.lineItems.list
HTTP Method : GET
Flat Path : v4/advertisers/{advertisersId}/lineItems
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
pageToken
Type : string
Description : A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItems` method. If not specified, the first page of results will be returned.
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
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
advertiserId
Type : string
Location : path
Description : Required. The ID of the advertiser to list line items for.
Required : Yes
Pattern : ^[^/]+$
Format : int64
orderBy
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`.
Type : string
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.
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/lineItems
▼ ▲ displayvideo.advertisers.lineItems.patch
Parameter Order :
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}
Parameters :
lineItemId
Description : Output only. The unique ID of the line item. Assigned by the system.
Required : Yes
Format : int64
Type : string
Location : path
Pattern : ^[^/]+$
updateMask
Format : google-fieldmask
Location : query
Type : string
Description : Required. The mask to control which fields to update.
advertiserId
Location : path
Format : int64
Type : string
Description : Output only. The unique ID of the advertiser the line item belongs to.
Pattern : ^[^/]+$
Required : Yes
HTTP Method : PATCH
Description : Updates an existing line item. Returns the updated line item if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * BulkUpdateLineItems * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
▼ ▲ displayvideo.advertisers.lineItems.get
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
lineItemId
Required : Yes
Description : Required. The ID of the line item to fetch.
Type : string
Format : int64
Location : path
Pattern : ^[^/]+$
advertiserId
Pattern : ^[^/]+$
Required : Yes
Format : int64
Location : path
Type : string
Description : Required. The ID of the advertiser this line item belongs to.
Parameter Order :
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}
Description : Gets a line item.
HTTP Method : GET
▼ ▲ displayvideo.advertisers.lineItems.bulkUpdate
Path : v4/advertisers/{+advertiserId}/lineItems:bulkUpdate
Parameters :
advertiserId
Location : path
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser this line item belongs to.
Type : string
Required : Yes
Format : int64
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.
Flat Path : v4/advertisers/{advertisersId}/lineItems:bulkUpdate
Parameter Order : advertiserId
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
▼ ▲ displayvideo.advertisers.lineItems.duplicate
Parameter Order :
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}:duplicate
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}:duplicate
Parameters :
lineItemId
Required : Yes
Description : Required. The ID of the line item to duplicate.
Pattern : ^[^/]+$
Type : string
Location : path
Format : int64
advertiserId
Required : Yes
Pattern : ^[^/]+$
Type : string
Location : path
Description : Required. The ID of the advertiser this line item belongs to.
Format : int64
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
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.
▼ ▲ displayvideo.advertisers.lineItems.delete
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}
Parameter Order :
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}
HTTP Method : DELETE
Description : Deletes a line item. Returns error code `NOT_FOUND` if the line item does not exist. The line item should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. YouTube & Partners line items cannot be created or updated using the API.
Parameters :
advertiserId
Location : path
Format : int64
Description : The ID of the advertiser this line item belongs to.
Pattern : ^[^/]+$
Type : string
Required : Yes
lineItemId
Type : string
Format : int64
Description : The ID of the line item to delete.
Required : Yes
Pattern : ^[^/]+$
Location : path
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.create
Parameters :
targetingType
Type : string
Pattern : ^[^/]+$
Required : Yes
Enum Descriptions :
Location : path
Enum :
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_YOUTUBE_VIDEO` * `TARGETING_TYPE_YOUTUBE_CHANNEL`
advertiserId
Required : Yes
Format : int64
Description : Required. The ID of the advertiser.
Location : path
Type : string
Pattern : ^[^/]+$
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
HTTP Method : POST
Flat Path : v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Description : Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful.
Path : v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.delete
Path : v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Flat Path : v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
assignedTargetingOptionId
Pattern : ^[^/]+$
Required : Yes
Type : string
Location : path
Description : Required. The ID of the assigned targeting option to delete.
targetingType
Enum :
Pattern : ^[^/]+$
Required : Yes
Type : string
Enum Descriptions :
Location : path
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`
advertiserId
Description : Required. The ID of the advertiser.
Location : path
Type : string
Format : int64
Required : Yes
Pattern : ^[^/]+$
Description : Deletes an assigned targeting option from an advertiser.
Parameter Order :
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.list
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
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`
Pattern : ^[^/]+$
Enum Descriptions :
Type : string
Location : path
Required : Yes
Enum :
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 `ListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Type : string
advertiserId
Location : path
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser.
Type : string
Required : Yes
Format : int64
pageSize
Location : query
Format : int32
Description : Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Type : integer
filter
Type : string
Description : Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `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
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
Flat Path : v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Path : v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions
HTTP Method : GET
Description : Lists the targeting options assigned to an advertiser.
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.get
Description : Gets a single targeting option assigned to an advertiser.
Flat Path : v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Path : v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
HTTP Method : GET
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the advertiser.
Location : path
Pattern : ^[^/]+$
assignedTargetingOptionId
Description : Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested.
Required : Yes
Type : string
Location : path
Pattern : ^[^/]+$
targetingType
Required : Yes
Type : string
Location : path
Pattern : ^[^/]+$
Enum :
Enum Descriptions :
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`
▼ ▲ displayvideo.advertisers.creatives.create
Parameters :
advertiserId
Required : Yes
Description : Output only. The unique ID of the advertiser the creative belongs to.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/creatives
HTTP Method : POST
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.
Path : v4/advertisers/{+advertiserId}/creatives
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.creatives.delete
Flat Path : v4/advertisers/{advertisersId}/creatives/{creativesId}
Parameters :
creativeId
Location : path
Type : string
Description : The ID of the creative to be deleted.
Pattern : ^[^/]+$
Required : Yes
Format : int64
advertiserId
Required : Yes
Type : string
Pattern : ^[^/]+$
Location : path
Format : int64
Description : The ID of the advertiser this creative belongs to.
Parameter Order :
Path : v4/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.
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : DELETE
▼ ▲ displayvideo.advertisers.creatives.get
Parameters :
advertiserId
Required : Yes
Description : Required. The ID of the advertiser this creative belongs to.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
creativeId
Pattern : ^[^/]+$
Description : Required. The ID of the creative to fetch.
Type : string
Required : Yes
Format : int64
Location : path
Parameter Order :
Path : v4/advertisers/{+advertiserId}/creatives/{+creativeId}
Flat Path : v4/advertisers/{advertisersId}/creatives/{creativesId}
HTTP Method : GET
Description : Gets a creative.
▼ ▲ displayvideo.advertisers.creatives.list
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}/creatives
Parameters :
pageSize
Location : query
Format : int32
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.
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 `ListCreatives` method. If not specified, the first page of results will be returned.
advertiserId
Required : Yes
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the advertiser to list creatives for.
Format : int64
Type : string
filter
Description : Allows filtering by creative fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `lineItemIds` field must use the `HAS (:)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. * For `entityStatus`, `minDuration`, `maxDuration`, `updateTime`, and `dynamic` fields, there may be at most one restriction. Supported Fields: * `approvalStatus` * `creativeId` * `creativeType` * `dimensions` (input in the form of `{width}x{height}`) * `dynamic` * `entityStatus` * `exchangeReviewStatus` (input in the form of `{exchange}-{reviewStatus}`) * `lineItemIds` * `maxDuration` (input in the form of `{duration}s`. Only seconds are supported) * `minDuration` (input in the form of `{duration}s`. Only seconds are supported) * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Notes: * For `updateTime`, a creative resource's field value reflects the last time that a creative has been updated, which includes updates made by the system (e.g. creative review updates). Examples: * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms: `dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` * All video creatives that are associated with line item ID 1 or 2: `creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)` * Find creatives by multiple creative IDs: `creativeId=1 OR creativeId=2` * All creatives with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
Type : string
orderBy
Location : query
Description : Field by which to sort the list. Acceptable values are: * `creativeId` (default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `createTime desc`.
Type : string
Description : Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/creatives
HTTP Method : GET
▼ ▲ displayvideo.advertisers.creatives.patch
Flat Path : v4/advertisers/{advertisersId}/creatives/{creativesId}
HTTP Method : PATCH
Description : Updates an existing creative. Returns the updated creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.
Path : v4/advertisers/{+advertiserId}/creatives/{+creativeId}
Parameter Order :
Parameters :
creativeId
Pattern : ^[^/]+$
Description : Output only. The unique ID of the creative. Assigned by the system.
Location : path
Required : Yes
Type : string
Format : int64
updateMask
Description : Required. The mask to control which fields to update.
Type : string
Location : query
Format : google-fieldmask
advertiserId
Description : Output only. The unique ID of the advertiser the creative belongs to.
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
▼ ▲ displayvideo.advertisers.reachForecast.retrievePlannableProducts
Flat Path : v4/advertisers/{advertisersId}/reachForecast:retrievePlannableProducts
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Pattern : ^[^/]+$
Location : path
Format : int64
Description : Required. The ID of the advertiser to list plannable products for.
Type : string
Required : Yes
plannableLocationId
Type : string
Location : query
Description : Required. The ID of the plannable location.
Description : Retrieves the list of products that can be planned for a location. API support for generating reach forecasts and retrieving related metadata is in beta. This method is only available to allowlisted users.
HTTP Method : GET
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/reachForecast:retrievePlannableProducts
▼ ▲ displayvideo.advertisers.reachForecast.retrievePlannableLocations
Description : Retrieves the list of countries where reach forecasting is supported. API support for generating reach forecasts and retrieving related metadata is in beta. This method is only available to allowlisted users.
HTTP Method : GET
Parameter Order : advertiserId
Parameters :
advertiserId
Format : int64
Type : string
Required : Yes
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the advertiser to list plannable locations for.
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/reachForecast:retrievePlannableLocations
Flat Path : v4/advertisers/{advertisersId}/reachForecast:retrievePlannableLocations
▼ ▲ displayvideo.advertisers.reachForecast.retrievePlannableUserInterests
Parameter Order : advertiserId
Parameters :
productCategory
Enum :
Location : query
Enum Descriptions :
Type : string
Description : Required. The product category to retrieve plannable user interests for.
advertiserId
Type : string
Location : path
Format : int64
Required : Yes
Description : Required. The ID of the advertiser to list plannable user interests for.
Pattern : ^[^/]+$
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.
Flat Path : v4/advertisers/{advertisersId}/reachForecast:retrievePlannableUserInterests
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/reachForecast:retrievePlannableUserInterests
▼ ▲ displayvideo.advertisers.reachForecast.generateReachForecast
HTTP Method : POST
Path : v4/advertisers/{+advertiserId}/reachForecast:generateReachForecast
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}/reachForecast:generateReachForecast
Description : Generates a reach forecast for a given advertiser and targeting configuration. API support for generating reach forecasts and retrieving related metadata is in beta. This method is only available to allowlisted users.
Parameters :
advertiserId
Location : path
Type : string
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : Required. The ID of the advertiser that will run the planned campaign.
▼ ▲ displayvideo.advertisers.reachForecast.retrievePlannableUserLists
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/reachForecast:retrievePlannableUserLists
Parameters :
filter
Location : query
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.
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 `RetrievePlannableUserLists` method. If not specified, the first page of results will be returned.
pageSize
Format : int32
Location : query
Description : Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `5000`.
Type : integer
advertiserId
Description : Required. The ID of the advertiser to retrieve plannable user lists for.
Type : string
Format : int64
Required : Yes
Pattern : ^[^/]+$
Location : path
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/reachForecast:retrievePlannableUserLists
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.
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.create
Description : Creates an assignment between a location and a location list.
Parameters :
advertiserId
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Type : string
Format : int64
Location : path
Required : Yes
locationListId
Location : path
Description : Required. The ID of the location list for which the assignment will be created.
Type : string
Required : Yes
Format : int64
Flat Path : v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
Parameter Order :
HTTP Method : POST
Path : v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.delete
Description : Deletes the assignment between a location and a location list.
Flat Path : v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{assignedLocationsId}
Parameters :
advertiserId
Required : Yes
Format : int64
Type : string
Location : path
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
locationListId
Format : int64
Location : path
Type : string
Description : Required. The ID of the location list to which this assignment is assigned.
Required : Yes
assignedLocationId
Format : int64
Description : Required. The ID of the assigned location to delete.
Pattern : ^[^/]+$
Required : Yes
Type : string
Location : path
Path : v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{+assignedLocationId}
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
HTTP Method : DELETE
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.list
Parameters :
locationListId
Type : string
Description : Required. The ID of the location list to which these assignments are assigned.
Location : path
Format : int64
Required : Yes
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
orderBy
Type : string
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`.
filter
Type : string
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.
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.
advertiserId
Type : string
Location : path
Format : int64
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Required : Yes
Description : Lists locations assigned to a location list.
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
Flat Path : v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
HTTP Method : GET
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.bulkEdit
Path : v4/advertisers/{advertiserId}/locationLists/{+locationListId}/assignedLocations:bulkEdit
HTTP Method : POST
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.
Flat Path : v4/advertisers/{advertiserId}/locationLists/{locationListsId}/assignedLocations:bulkEdit
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
locationListId
Description : Required. The ID of the location list to which these assignments are assigned.
Required : Yes
Type : string
Format : int64
Pattern : ^[^/]+$
Location : path
advertiserId
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Required : Yes
Format : int64
Type : string
Location : path
▼ ▲ displayvideo.advertisers.locationLists.get
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameter Order :
Description : Gets a location list.
Parameters :
locationListId
Type : string
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : Required. The ID of the location list to fetch.
advertiserId
Location : path
Pattern : ^[^/]+$
Description : Required. The ID of the DV360 advertiser to which the fetched location list belongs.
Required : Yes
Type : string
Format : int64
Path : v4/advertisers/{+advertiserId}/locationLists/{+locationListId}
Flat Path : v4/advertisers/{advertisersId}/locationLists/{locationListsId}
▼ ▲ displayvideo.advertisers.locationLists.create
Parameters :
advertiserId
Type : string
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Required : Yes
Pattern : ^[^/]+$
Format : int64
Location : path
Path : v4/advertisers/{+advertiserId}/locationLists
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Flat Path : v4/advertisers/{advertisersId}/locationLists
Description : Creates a new location list. Returns the newly created location list if successful.
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.locationLists.list
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}/locationLists
HTTP Method : GET
Description : Lists location lists based on a given advertiser id.
Path : v4/advertisers/{+advertiserId}/locationLists
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
orderBy
Type : string
Location : query
Description : Field by which to sort the list. Acceptable values are: * `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`.
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 `ListLocationLists` method. If not specified, the first page of results will be returned.
Type : string
Location : query
pageSize
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.
Type : integer
advertiserId
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of the DV360 advertiser to which the fetched location lists belong.
Format : int64
Location : path
filter
Description : Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `locationType` Examples: * All regional location list: `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Type : string
Location : query
▼ ▲ displayvideo.advertisers.locationLists.patch
HTTP Method : PATCH
Path : v4/advertisers/{+advertiserId}/locationLists/{locationListId}
Flat Path : v4/advertisers/{advertisersId}/locationLists/{locationListId}
Parameter Order :
Parameters :
advertiserId
Location : path
Pattern : ^[^/]+$
Description : Required. The ID of the DV360 advertiser to which the location lists belongs.
Format : int64
Required : Yes
Type : string
updateMask
Type : string
Location : query
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
locationListId
Required : Yes
Type : string
Format : int64
Location : path
Description : Output only. The unique ID of the location list. Assigned by the system.
Scopes : https://www.googleapis.com/auth/display-video
Description : Updates a location list. Returns the updated location list if successful.
▼ ▲ displayvideo.advertisers.adAssets.bulkCreate
HTTP Method : POST
Flat Path : v4/advertisers/{advertisersId}/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`.
Parameters :
advertiserId
Type : string
Location : path
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser these ad assets belong to.
Required : Yes
Format : int64
Path : v4/advertisers/{+advertiserId}/adAssets:bulkCreate
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.adAssets.patch
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/adAssets/{adAssetsId}
Parameters :
updateMask
Format : google-fieldmask
Location : query
Type : string
Description : Required. The list of fields to update. Only AdAsset.synthetic_content_attestation_status is mutable.
advertiserId
Type : string
Required : Yes
Description : Required. The ID of the advertiser this ad asset belongs to.
Format : int64
Location : path
Pattern : ^[^/]+$
adAssetId
Location : path
Pattern : ^[^/]+$
Type : string
Required : Yes
Description : Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad.
Format : int64
Path : v4/advertisers/{+advertiserId}/adAssets/{+adAssetId}
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.
HTTP Method : PATCH
Parameter Order :
▼ ▲ displayvideo.advertisers.adAssets.list
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/adAssets
Parameters :
advertiserId
Description : Required. The ID of the advertiser the ad assets belong to.
Type : string
Location : path
Pattern : ^[^/]+$
Required : Yes
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 `ListAdAssets` method. If not specified, the first page of results will be returned.
pageSize
Description : Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Type : integer
Format : int32
Location : query
orderBy
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`.
Location : query
Type : string
filter
Location : query
Type : string
Description : Optional. Allows filtering of the results by ad asset fields. Supported syntax: * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `youtubeVideoAsset.youtubeVideoId` * `entityStatus` Examples: * All active YouTube video ad assets under an advertiser: `entityStatus=ENTITY_STATUS_ACTIVE`
Parameter Order : advertiserId
Description : Lists ad assets under an advertiser ID. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
Path : v4/advertisers/{+advertiserId}/adAssets
HTTP Method : GET
▼ ▲ displayvideo.advertisers.adAssets.upload
Description : Uploads and creates an ad asset. Returns the ID of the newly-created ad asset if successful. Only supports the uploading of assets with the AdAssetType `AD_ASSET_TYPE_IMAGE`.
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/adAssets:uploadAdAsset
Mediaupload :
Accept : */*
Protocols :
Simple :
Path : /upload/v4/advertisers/{+advertiserId}/adAssets:uploadAdAsset
Multipart : Yes
Parameter Order : advertiserId
Parameters :
advertiserId
Description : Required. The ID of the advertiser this ad asset belongs to.
Location : path
Format : int64
Pattern : ^[^/]+$
Type : string
Required : Yes
Path : v4/advertisers/{+advertiserId}/adAssets:uploadAdAsset
Supportsmediaupload : Yes
▼ ▲ displayvideo.advertisers.adAssets.create
Path : v4/advertisers/{+advertiserId}/adAssets
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`.
HTTP Method : POST
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}/adAssets
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Location : path
Pattern : ^[^/]+$
Type : string
Required : Yes
Format : int64
Description : Required. The ID of the advertiser this ad asset belongs to.
▼ ▲ displayvideo.advertisers.adAssets.get
Description : Gets an ad asset. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser this ad asset belongs to.
Type : string
Required : Yes
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
Location : path
Type : string
Path : v4/advertisers/{+advertiserId}/adAssets/{+adAssetId}
Flat Path : v4/advertisers/{advertisersId}/adAssets/{adAssetsId}
▼ ▲ displayvideo.advertisers.negativeKeywordLists.list
Parameter Order : advertiserId
HTTP Method : GET
Description : Lists negative keyword lists based on a given advertiser id.
Path : v4/advertisers/{+advertiserId}/negativeKeywordLists
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Location : path
Description : Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong.
Type : string
Pattern : ^[^/]+$
Required : Yes
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 `ListNegativeKeywordLists` method. If not specified, the first page of results will be returned.
pageSize
Type : integer
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
Format : int32
Flat Path : v4/advertisers/{advertisersId}/negativeKeywordLists
▼ ▲ displayvideo.advertisers.negativeKeywordLists.create
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/negativeKeywordLists
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Description : Creates a new negative keyword list. Returns the newly created negative keyword list if successful.
Flat Path : v4/advertisers/{advertisersId}/negativeKeywordLists
Parameters :
advertiserId
Location : path
Description : Required. The ID of the DV360 advertiser to which the negative keyword list will belong.
Pattern : ^[^/]+$
Type : string
Required : Yes
Format : int64
▼ ▲ displayvideo.advertisers.negativeKeywordLists.delete
Flat Path : v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}
Path : v4/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}
Parameters :
negativeKeywordListId
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
Description : Required. The ID of the negative keyword list to delete.
advertiserId
Description : Required. The ID of the DV360 advertiser to which the negative keyword list belongs.
Location : path
Type : string
Pattern : ^[^/]+$
Format : int64
Required : Yes
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Description : Deletes a negative keyword list given an advertiser ID and a negative keyword list ID.
HTTP Method : DELETE
▼ ▲ displayvideo.advertisers.negativeKeywordLists.get
Parameters :
advertiserId
Required : Yes
Description : Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
negativeKeywordListId
Location : path
Pattern : ^[^/]+$
Description : Required. The ID of the negative keyword list to fetch.
Format : int64
Type : string
Required : Yes
Flat Path : v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}
Description : Gets a negative keyword list given an advertiser ID and a negative keyword list ID.
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
▼ ▲ displayvideo.advertisers.negativeKeywordLists.patch
Path : v4/advertisers/{+advertiserId}/negativeKeywordLists/{negativeKeywordListId}
Parameters :
negativeKeywordListId
Location : path
Format : int64
Description : Output only. The unique ID of the negative keyword list. Assigned by the system.
Required : Yes
Type : string
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Type : string
advertiserId
Format : int64
Location : path
Description : Required. The ID of the DV360 advertiser to which the negative keyword list belongs.
Type : string
Pattern : ^[^/]+$
Required : Yes
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
HTTP Method : PATCH
Flat Path : v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListId}
Description : Updates a negative keyword list. Returns the updated negative keyword list if successful.
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.list
Parameter Order :
HTTP Method : GET
Description : Lists negative keywords in a negative keyword list.
Path : v4/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords
Flat Path : v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
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
negativeKeywordListId
Required : Yes
Type : string
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the parent negative keyword list to which the requested negative keywords belong.
Location : path
orderBy
Type : string
Description : Field by which to sort the list. Acceptable values are: * `keywordValue` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `keywordValue desc`.
Location : query
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 `ListNegativeKeywords` method. If not specified, the first page of results will be returned.
Type : string
advertiserId
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Format : int64
Location : path
pageSize
Format : int32
Location : query
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.
Type : integer
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.replace
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Format : int64
Type : string
Location : path
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Required : Yes
negativeKeywordListId
Description : Required. The ID of the parent negative keyword list to which the negative keywords belong.
Required : Yes
Type : string
Pattern : ^[^/]+$
Location : path
Format : int64
Flat Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:replace
Description : Replaces all negative keywords in a single negative keyword list. The operation will replace the keywords in a negative keyword list with keywords provided in ReplaceNegativeKeywordsRequest.new_negative_keywords.
HTTP Method : POST
Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:replace
Parameter Order :
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.create
Description : Creates a negative keyword in a negative keyword list.
Flat Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords
HTTP Method : POST
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Required : Yes
Type : string
Format : int64
Location : path
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
negativeKeywordListId
Location : path
Pattern : ^[^/]+$
Required : Yes
Description : Required. The ID of the parent negative keyword list in which the negative keyword will be created.
Format : int64
Type : string
Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.delete
Flat Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords/{negativeKeywordsId}
Parameter Order :
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/display-video
Description : Deletes a negative keyword from a negative keyword list.
Parameters :
negativeKeywordListId
Format : int64
Description : Required. The ID of the parent negative keyword list to which the negative keyword belongs.
Required : Yes
Pattern : ^[^/]+$
Type : string
Location : path
keywordValue
Location : path
Type : string
Description : Required. The keyword value of the negative keyword to delete.
Pattern : ^[^/]+$
Required : Yes
advertiserId
Location : path
Format : int64
Type : string
Required : Yes
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords/{+keywordValue}
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.bulkEdit
Flat Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:bulkEdit
Scopes : https://www.googleapis.com/auth/display-video
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.
Parameters :
negativeKeywordListId
Format : int64
Location : path
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the parent negative keyword list to which the negative keywords belong.
advertiserId
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Format : int64
Type : string
Required : Yes
Location : path
Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:bulkEdit
Parameter Order :
HTTP Method : POST
▼ ▲ displayvideo.advertisers.adGroups.bulkListAssignedTargetingOptions
Parameter Order : advertiserId
Parameters :
pageSize
Type : integer
Format : int32
Description : Optional. Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
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
adGroupIds
Type : string
Repeated : Yes
Description : Required. The IDs of the ad groups to list assigned targeting options for.
Location : query
Format : int64
advertiserId
Description : Required. The ID of the advertiser the line items belongs to.
Location : path
Format : int64
Pattern : ^[^/]+$
Type : string
Required : Yes
filter
Location : query
Description : Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `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
orderBy
Location : query
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`.
Type : string
Path : v4/advertisers/{+advertiserId}/adGroups:bulkListAssignedTargetingOptions
Flat Path : v4/advertisers/{advertisersId}/adGroups:bulkListAssignedTargetingOptions
Description : Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.
HTTP Method : GET
▼ ▲ displayvideo.advertisers.adGroups.patch
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}
Parameters :
adGroupId
Required : Yes
Location : path
Format : int64
Pattern : ^[^/]+$
Type : string
Description : Output only. The unique ID of the ad group. Assigned by the system.
advertiserId
Pattern : ^[^/]+$
Required : Yes
Description : Output only. The unique ID of the advertiser the ad group belongs to.
Format : int64
Location : path
Type : string
updateMask
Format : google-fieldmask
Type : string
Description : Required. The mask to control which fields to update.
Location : query
Description : Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups.
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : PATCH
▼ ▲ displayvideo.advertisers.adGroups.create
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}/adGroups
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Path : v4/advertisers/{+advertiserId}/adGroups
Description : Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups.
Parameters :
advertiserId
Location : path
Pattern : ^[^/]+$
Description : Output only. The unique ID of the advertiser the ad group belongs to.
Format : int64
Required : Yes
Type : string
▼ ▲ displayvideo.advertisers.adGroups.delete
Parameter Order :
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}
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.
HTTP Method : DELETE
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Required : Yes
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser this ad group belongs to.
Location : path
Type : string
Format : int64
adGroupId
Description : Required. The ID of the ad group to delete.
Pattern : ^[^/]+$
Required : Yes
Format : int64
Location : path
Type : string
▼ ▲ displayvideo.advertisers.adGroups.bulkEditAssignedTargetingOptions
Parameters :
advertiserId
Required : Yes
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser the ad groups belong to.
Location : path
Type : string
Format : int64
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}/adGroups:bulkEditAssignedTargetingOptions
Path : v4/advertisers/{+advertiserId}/adGroups:bulkEditAssignedTargetingOptions
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/display-video
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.
▼ ▲ displayvideo.advertisers.adGroups.list
Parameters :
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 `ListAdGroups` method. If not specified, the first page of results will be returned.
Location : query
Type : string
advertiserId
Type : string
Pattern : ^[^/]+$
Location : path
Format : int64
Required : Yes
Description : Required. The ID of the advertiser the ad groups belongs to.
filter
Location : query
Type : string
Description : Optional. Allows filtering by custom ad group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported properties: * `adGroupId` * `displayName` * `entityStatus` * `lineItemId` * `adGroupFormat` Examples: * All ad groups under an line item: `lineItemId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` `AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
pageSize
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.
Location : query
Type : integer
orderBy
Description : Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
Location : query
Type : string
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/adGroups
Parameter Order : advertiserId
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/adGroups
Description : Lists ad groups.
▼ ▲ displayvideo.advertisers.adGroups.get
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
adGroupId
Location : path
Description : Required. The ID of the ad group to fetch.
Type : string
Required : Yes
Pattern : ^[^/]+$
Format : int64
advertiserId
Location : path
Pattern : ^[^/]+$
Required : Yes
Description : Required. The ID of the advertiser this ad group belongs to.
Type : string
Format : int64
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}
HTTP Method : GET
Description : Gets an ad group.
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.get
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Parameter Order :
Parameters :
adGroupId
Format : int64
Location : path
Description : Required. The ID of the ad group the assigned targeting option belongs to.
Type : string
Pattern : ^[^/]+$
Required : Yes
assignedTargetingOptionId
Required : Yes
Type : string
Pattern : ^[^/]+$
Location : path
Description : Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.
targetingType
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`
Required : Yes
Enum :
Pattern : ^[^/]+$
Location : path
advertiserId
Type : string
Location : path
Pattern : ^[^/]+$
Required : Yes
Description : Required. The ID of the advertiser the ad group belongs to.
Format : int64
Scopes : https://www.googleapis.com/auth/display-video
Description : Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.
HTTP Method : GET
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.list
HTTP Method : GET
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.
Parameters :
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: * `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.
Type : string
Location : query
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
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.
Location : query
Type : integer
Format : int32
adGroupId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the ad group to list assigned targeting options for.
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 `ListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Location : query
Type : string
advertiserId
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the advertiser the ad group belongs to.
Format : int64
Type : string
Required : Yes
targetingType
Pattern : ^[^/]+$
Enum :
Location : path
Enum Descriptions :
Description : Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_COMBINED_AUDIENCE` * `TARGETING_TYPE_CUSTOM_LIST` * `TARGETING_TYPE_FIRST_PARTY_AND_PARTNER_AUDIENCE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_GOOGLE_AUDIENCE` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_LOOKALIKE_AUDIENCE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`
Type : string
Required : Yes
Parameter Order :
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.create
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Parameters :
advertiserId
Format : int64
Location : path
Pattern : ^[^/]+$
Type : string
Required : Yes
Description : Required. The ID of the advertiser the ad group belongs to.
targetingType
Required : Yes
Type : string
Enum :
Enum Descriptions :
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_COMBINED_AUDIENCE` * `TARGETING_TYPE_CUSTOM_LIST` * `TARGETING_TYPE_FIRST_PARTY_AND_PARTNER_AUDIENCE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_GOOGLE_AUDIENCE` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_LOOKALIKE_AUDIENCE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`
Location : path
Pattern : ^[^/]+$
adGroupId
Type : string
Format : int64
Location : path
Description : Required. The ID of the ad group the assigned targeting option will belong to.
Pattern : ^[^/]+$
Required : Yes
Description : Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. This method is only supported for Demand Gen ad groups.
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.delete
Parameter Order :
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`.
Parameters :
advertiserId
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of the advertiser the ad group belongs to.
Location : path
Format : int64
adGroupId
Type : string
Pattern : ^[^/]+$
Description : Required. The ID of the ad group the assigned targeting option belongs to.
Required : Yes
Format : int64
Location : path
targetingType
Enum :
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 Descriptions :
Type : string
Required : Yes
Pattern : ^[^/]+$
assignedTargetingOptionId
Type : string
Description : Required. The ID of the assigned targeting option to delete.
Location : path
Pattern : ^[^/]+$
Required : Yes
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
HTTP Method : DELETE
▼ ▲ displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.list
Description : Lists the YouTube asset associations linked to the given resource.
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations
Parameters :
orderBy
Description : Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`.
Type : string
Location : query
adGroupId
Required : Yes
Description : The ID of an ad group.
Type : string
Pattern : ^[^/]+$
Location : path
Format : int64
youtubeAssetType
Pattern : ^[^/]+$
Required : Yes
Enum :
Description : Required. The type of YouTube asset being associated with the resource.
Location : path
Type : string
Enum Descriptions :
pageSize
Location : query
Type : integer
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.
Format : int32
advertiserId
Pattern : ^[^/]+$
Type : string
Required : Yes
Format : int64
Location : path
Description : Required. The ID of the advertiser that the linked entity belongs to.
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 `ListYoutubeAssetAssociations` method. If not specified, the first page of results will be returned.
Location : query
Type : string
linkedEntity.lineItemId
Location : query
Type : string
Format : int64
Description : The ID of a line item.
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
HTTP Method : GET
▼ ▲ displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.create
Parameters :
youtubeAssetType
Type : string
Location : path
Enum Descriptions :
Description : Required. The type of YouTube asset associated with the resource.
Enum :
Required : Yes
Pattern : ^[^/]+$
adGroupId
Format : int64
Pattern : ^[^/]+$
Required : Yes
Description : The ID of an ad group.
Type : string
Location : path
advertiserId
Type : string
Location : path
Description : Required. The ID of the advertiser that the linked entity belongs to.
Required : Yes
Format : int64
Pattern : ^[^/]+$
linkedEntity.lineItemId
Type : string
Description : The ID of a line item.
Location : query
Format : int64
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations
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.
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations
▼ ▲ displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.delete
Parameters :
youtubeAssetType
Type : string
Description : Required. The type of YouTube asset associated with the resource.
Location : path
Enum :
Pattern : ^[^/]+$
Required : Yes
Enum Descriptions :
youtubeAssetAssociationId
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
Pattern : ^[^/]+$
Type : string
Required : Yes
linkedEntity.lineItemId
Location : query
Description : The ID of a line item.
Type : string
Format : int64
advertiserId
Location : path
Format : int64
Type : string
Description : Required. The ID of the advertiser that the linked entity belongs to.
Pattern : ^[^/]+$
Required : Yes
adGroupId
Type : string
Format : int64
Location : path
Pattern : ^[^/]+$
Description : The ID of an ad group.
Required : Yes
Description : Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users.
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations/{+youtubeAssetAssociationId}
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
HTTP Method : DELETE
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations/{youtubeAssetAssociationsId}
▼ ▲ displayvideo.advertisers.channels.get
Parameter Order :
Parameters :
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Type : string
Required : Yes
Description : The ID of the advertiser that owns the fetched channel.
partnerId
Format : int64
Description : The ID of the partner that owns the fetched channel.
Location : query
Type : string
channelId
Required : Yes
Description : Required. The ID of the channel to fetch.
Type : string
Location : path
Pattern : ^[^/]+$
Format : int64
Description : Gets a channel for a partner or advertiser.
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/channels/{+channelId}
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/channels/{channelsId}
▼ ▲ displayvideo.advertisers.channels.create
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Description : Creates a new channel. Returns the newly created channel if successful.
Flat Path : v4/advertisers/{advertisersId}/channels
Parameters :
advertiserId
Description : The ID of the advertiser that owns the created channel.
Type : string
Location : path
Required : Yes
Format : int64
Pattern : ^[^/]+$
partnerId
Description : The ID of the partner that owns the created channel.
Format : int64
Type : string
Location : query
Path : v4/advertisers/{+advertiserId}/channels
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.channels.patch
Path : v4/advertisers/{+advertiserId}/channels/{channelId}
HTTP Method : PATCH
Flat Path : v4/advertisers/{advertisersId}/channels/{channelId}
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
partnerId
Description : The ID of the partner that owns the created channel.
Format : int64
Location : query
Type : string
advertiserId
Type : string
Location : path
Pattern : ^[^/]+$
Format : int64
Required : Yes
Description : The ID of the advertiser that owns the created channel.
updateMask
Format : google-fieldmask
Location : query
Type : string
Description : Required. The mask to control which fields to update.
channelId
Location : path
Description : Output only. The unique ID of the channel. Assigned by the system.
Required : Yes
Type : string
Format : int64
Description : Updates a channel. Returns the updated channel if successful.
▼ ▲ displayvideo.advertisers.channels.list
Description : Lists channels for a partner or advertiser.
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}/channels
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/channels
Parameters :
advertiserId
Required : Yes
Type : string
Pattern : ^[^/]+$
Description : The ID of the advertiser that owns the channels.
Format : int64
Location : path
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 `ListChannels` method. If not specified, the first page of results will be returned.
Location : query
Type : string
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
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.
partnerId
Location : query
Description : The ID of the partner that owns the channels.
Format : int64
Type : string
filter
Type : string
Description : Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
▼ ▲ displayvideo.advertisers.channels.sites.create
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{advertiserId}/channels/{+channelId}/sites
Description : Creates a site in a channel.
Parameters :
advertiserId
Format : int64
Description : The ID of the advertiser that owns the parent channel.
Required : Yes
Type : string
Location : path
channelId
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : Required. The ID of the parent channel in which the site will be created.
Location : path
Type : string
partnerId
Type : string
Description : The ID of the partner that owns the parent channel.
Format : int64
Location : query
Parameter Order :
Flat Path : v4/advertisers/{advertiserId}/channels/{channelsId}/sites
▼ ▲ displayvideo.advertisers.channels.sites.delete
Flat Path : v4/advertisers/{advertiserId}/channels/{channelsId}/sites/{sitesId}
Parameter Order :
Description : Deletes a site from a channel.
HTTP Method : DELETE
Path : v4/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Location : query
Description : The ID of the partner that owns the parent channel.
Format : int64
Type : string
advertiserId
Location : path
Type : string
Format : int64
Description : The ID of the advertiser that owns the parent channel.
Required : Yes
urlOrAppId
Pattern : ^[^/]+$
Location : path
Type : string
Required : Yes
Description : Required. The URL or app ID of the site to delete.
channelId
Location : path
Description : Required. The ID of the parent channel to which the site belongs.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
▼ ▲ displayvideo.advertisers.channels.sites.bulkEdit
Path : v4/advertisers/{advertiserId}/channels/{+channelId}/sites:bulkEdit
Flat Path : v4/advertisers/{advertiserId}/channels/{channelsId}/sites:bulkEdit
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
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.
Parameters :
channelId
Format : int64
Required : Yes
Description : Required. The ID of the parent channel to which the sites belong.
Pattern : ^[^/]+$
Location : path
Type : string
advertiserId
Required : Yes
Type : string
Format : int64
Location : path
Description : The ID of the advertiser that owns the parent channel.
▼ ▲ displayvideo.advertisers.channels.sites.list
Description : Lists sites in a channel.
Path : v4/advertisers/{+advertiserId}/channels/{+channelId}/sites
Parameters :
pageSize
Format : int32
Type : integer
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
advertiserId
Location : path
Type : string
Description : The ID of the advertiser that owns the parent channel.
Pattern : ^[^/]+$
Format : int64
Required : Yes
channelId
Required : Yes
Description : Required. The ID of the parent channel to which the requested sites belong.
Pattern : ^[^/]+$
Location : path
Format : int64
Type : string
pageToken
Description : A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned.
Type : string
Location : query
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`.
partnerId
Location : query
Description : The ID of the partner that owns the parent channel.
Format : int64
Type : string
filter
Description : Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
Type : string
Flat Path : v4/advertisers/{advertisersId}/channels/{channelsId}/sites
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
HTTP Method : GET
▼ ▲ displayvideo.advertisers.channels.sites.replace
HTTP Method : POST
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.
Parameters :
advertiserId
Location : path
Description : The ID of the advertiser that owns the parent channel.
Format : int64
Type : string
Required : Yes
channelId
Location : path
Pattern : ^[^/]+$
Format : int64
Required : Yes
Description : Required. The ID of the parent channel whose sites will be replaced.
Type : string
Flat Path : v4/advertisers/{advertiserId}/channels/{channelsId}/sites:replace
Path : v4/advertisers/{advertiserId}/channels/{+channelId}/sites:replace
▼ ▲ displayvideo.advertisers.assets.upload
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/assets
Mediaupload :
Protocols :
Simple :
Path : /upload/v4/advertisers/{+advertiserId}/assets
Multipart : Yes
Accept : */*
Supportsmediaupload : Yes
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
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 : v4/advertisers/{advertisersId}/assets
Parameters :
advertiserId
Description : Required. The ID of the advertiser this asset belongs to.
Type : string
Location : path
Required : Yes
Pattern : ^[^/]+$
Format : int64
▼ ▲ displayvideo.floodlightGroups.floodlightActivities.get
HTTP Method : GET
Description : Gets a Floodlight activity.
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Description : Required. The ID of the partner through which the Floodlight activity is being accessed.
Location : query
Format : int64
Type : string
floodlightGroupId
Required : Yes
Type : string
Description : Required. The ID of the parent Floodlight group to which the requested Floodlight activity belongs.
Format : int64
Pattern : ^[^/]+$
Location : path
floodlightActivityId
Type : string
Location : path
Description : Required. The ID of the Floodlight activity to fetch.
Pattern : ^[^/]+$
Required : Yes
Format : int64
Flat Path : v4/floodlightGroups/{floodlightGroupsId}/floodlightActivities/{floodlightActivitiesId}
Parameter Order :
Path : v4/floodlightGroups/{+floodlightGroupId}/floodlightActivities/{+floodlightActivityId}
▼ ▲ displayvideo.floodlightGroups.floodlightActivities.list
Parameters :
partnerId
Format : int64
Type : string
Description : Required. The ID of the partner through which the Floodlight activities are being accessed.
Location : query
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.
orderBy
Location : query
Type : string
Description : Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `floodlightActivityId` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
pageToken
Location : query
Description : Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFloodlightActivities` method. If not specified, the first page of results will be returned.
Type : string
floodlightGroupId
Location : path
Type : string
Pattern : ^[^/]+$
Description : Required. The ID of the parent Floodlight group to which the requested Floodlight activities belong.
Required : Yes
Format : int64
Scopes : https://www.googleapis.com/auth/display-video
Description : Lists Floodlight activities in a Floodlight group.
HTTP Method : GET
Parameter Order : floodlightGroupId
Flat Path : v4/floodlightGroups/{floodlightGroupsId}/floodlightActivities
Path : v4/floodlightGroups/{+floodlightGroupId}/floodlightActivities
▼ ▲ displayvideo.floodlightGroups.get
Path : v4/floodlightGroups/{+floodlightGroupId}
Description : Gets a Floodlight group.
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/floodlightGroups/{floodlightGroupsId}
Parameter Order : floodlightGroupId
HTTP Method : GET
Parameters :
partnerId
Description : Required. The partner context by which the Floodlight group is being accessed.
Location : query
Format : int64
Type : string
floodlightGroupId
Type : string
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : Required. The ID of the Floodlight group to fetch.
▼ ▲ displayvideo.floodlightGroups.patch
Parameters :
partnerId
Format : int64
Description : Required. The partner context by which the Floodlight group is being accessed.
Location : query
Type : string
updateMask
Location : query
Type : string
Format : google-fieldmask
Description : Required. The mask to control which fields to update.
floodlightGroupId
Type : string
Location : path
Description : Output only. The unique ID of the Floodlight group. Assigned by the system.
Required : Yes
Format : int64
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/floodlightGroups/{floodlightGroupId}
Flat Path : v4/floodlightGroups/{floodlightGroupId}
HTTP Method : PATCH
Description : Updates an existing Floodlight group. Returns the updated Floodlight group if successful.
Parameter Order : floodlightGroupId
▼ ▲ displayvideo.sdfuploadtasks.operations.get
Parameter Order : name
Parameters :
name
Description : The name of the operation resource.
Type : string
Pattern : ^sdfuploadtasks/operations/[^/]+$
Location : path
Required : Yes
Flat Path : v4/sdfuploadtasks/operations/{operationsId}
Path : v4/{+name}
Description : Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.
HTTP Method : GET
Scopes :
▼ ▲ displayvideo.users.patch
Path : v4/users/{+userId}
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.
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/display-video-user-management
Flat Path : v4/users/{usersId}
Parameters :
userId
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Output only. The unique ID of the user. Assigned by the system.
Format : int64
Location : path
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Type : string
Format : google-fieldmask
Parameter Order : userId
▼ ▲ displayvideo.users.list
Path : v4/users
HTTP Method : GET
Flat Path : v4/users
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
Parameters :
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.
Type : string
Location : query
pageSize
Type : integer
Location : query
Format : int32
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
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.
Type : string
Location : query
orderBy
Type : string
Location : query
Description : Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
▼ ▲ displayvideo.users.create
Scopes : https://www.googleapis.com/auth/display-video-user-management
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.
HTTP Method : POST
Path : v4/users
Flat Path : v4/users
▼ ▲ displayvideo.users.delete
Parameter Order : userId
Flat Path : v4/users/{usersId}
Parameters :
userId
Pattern : ^[^/]+$
Required : Yes
Format : int64
Location : path
Description : Required. The ID of the user to delete.
Type : string
Scopes : https://www.googleapis.com/auth/display-video-user-management
Description : Deletes a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
Path : v4/users/{+userId}
HTTP Method : DELETE
▼ ▲ displayvideo.users.bulkEditAssignedUserRoles
Parameter Order : userId
Path : v4/users/{+userId}:bulkEditAssignedUserRoles
Flat Path : v4/users/{usersId}:bulkEditAssignedUserRoles
Parameters :
userId
Description : Required. The ID of the user to which the assigned user roles belong.
Location : path
Format : int64
Pattern : ^[^/]+$
Type : string
Required : Yes
Scopes : https://www.googleapis.com/auth/display-video-user-management
HTTP Method : POST
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.
▼ ▲ displayvideo.users.get
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.
Flat Path : v4/users/{usersId}
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/display-video-user-management
Path : v4/users/{+userId}
Parameter Order : userId
Parameters :
userId
Required : Yes
Type : string
Pattern : ^[^/]+$
Description : Required. The ID of the user to fetch.
Location : path
Format : int64