Display & Video 360 API

通过 Display & Video 360 API,用户可以自动执行复杂的 Display & Video 360 工作流程,例如创建广告订单以及为各个订单项设置定位选项。

服务:displayvideo.googleapis.com

要调用此服务,我们建议您使用 Google 提供的客户端库。如果您的应用需要使用您自己的库来调用此服务,则在发出 API 请求时应使用以下信息。

发现文档

发现文档是用于说明和使用 REST API 的机器可读规范。它用于构建客户端库、IDE 插件以及与 Google API 交互的其他工具。一项服务可能会提供多个发现文档。此服务提供了以下发现文档:

服务端点

服务端点是指定 API 服务的网络地址的基本网址。一项服务可能有多个服务端点。此服务具有以下服务端点,下面的所有 URI 都与此服务端点相关:

  • https://displayvideo.googleapis.com

REST 资源:v2.advertisers

方法
audit GET /v2/advertisers/{advertiserId}:audit
审核广告客户。
create POST /v2/advertisers
创建新的广告客户。
delete DELETE /v2/advertisers/{advertiserId}
删除广告客户。
editAssignedTargetingOptions POST /v2/advertisers/{advertiserId}:editAssignedTargetingOptions
修改单个广告客户下的定位选项。
get GET /v2/advertisers/{advertiserId}
获取广告客户。
list GET /v2/advertisers
列出当前用户有权访问的广告客户。
listAssignedTargetingOptions GET /v2/advertisers/{advertiserId}:listAssignedTargetingOptions
列出为某个广告主分配的各种定位选项。
patch PATCH /v2/advertisers/{advertiser.advertiserId}
更新现有广告客户。

REST 资源:v2.advertisers.assets

方法
upload POST /v2/advertisers/{advertiserId}/assets
POST /upload/v2/advertisers/{advertiserId}/assets
上传素材资源。

REST 资源:v2.advertisers.campaigns

方法
create POST /v2/advertisers/{campaign.advertiserId}/campaigns
创建新的广告系列。
delete DELETE /v2/advertisers/{advertiserId}/campaigns/{campaignId}
永久删除一个广告系列。
get GET /v2/advertisers/{advertiserId}/campaigns/{campaignId}
获取广告系列。
list GET /v2/advertisers/{advertiserId}/campaigns
列出广告客户中的广告系列。
listAssignedTargetingOptions GET /v2/advertisers/{advertiserId}/campaigns/{campaignId}:listAssignedTargetingOptions
列出为广告系列指定的各种定位类型定位选项。
patch PATCH /v2/advertisers/{campaign.advertiserId}/campaigns/{campaign.campaignId}
更新现有广告系列。

REST 资源:v2.advertisers.campaigns.targetingTypes.assignedTargetingOptions

方法
get GET /v2/advertisers/{advertiserId}/campaigns/{campaignId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}
获取分配给广告系列的单个定位选项。
list GET /v2/advertisers/{advertiserId}/campaigns/{campaignId}/targetingTypes/{targetingType}/assignedTargetingOptions
列出针对特定定位类型分配给广告系列的定位选项。

REST 资源:v2.advertisers.channels

方法
create POST /v2/advertisers/{advertiserId}/channels
创建一个新频道。
get GET /v2/advertisers/{advertiserId}/channels/{channelId}
获取合作伙伴或广告客户的渠道。
list GET /v2/advertisers/{advertiserId}/channels
列出合作伙伴或广告客户的渠道。
patch PATCH /v2/advertisers/{advertiserId}/channels/{channel.channelId}
更新渠道。

REST 资源:v2.advertisers.channels.sites

方法
bulkEdit POST /v2/advertisers/{advertiserId}/channels/{channelId}/sites:bulkEdit
批量修改单个渠道下的网站。
create POST /v2/advertisers/{advertiserId}/channels/{channelId}/sites
在渠道中创建网站。
delete DELETE /v2/advertisers/{advertiserId}/channels/{channelId}/sites/{urlOrAppId}
从渠道中删除网站。
list GET /v2/advertisers/{advertiserId}/channels/{channelId}/sites
列出渠道中的网站。
replace POST /v2/advertisers/{advertiserId}/channels/{channelId}/sites:replace
替换单个渠道下的所有网站。

REST 资源:v2.advertisers.creatives

方法
create POST /v2/advertisers/{creative.advertiserId}/creatives
创建新的广告素材。
delete DELETE /v2/advertisers/{advertiserId}/creatives/{creativeId}
删除广告素材。
get GET /v2/advertisers/{advertiserId}/creatives/{creativeId}
获取广告素材。
list GET /v2/advertisers/{advertiserId}/creatives
列出广告客户中的广告素材。
patch PATCH /v2/advertisers/{creative.advertiserId}/creatives/{creative.creativeId}
更新现有广告素材。

REST 资源:v2.advertisers.insertionOrders

方法
create POST /v2/advertisers/{insertionOrder.advertiserId}/insertionOrders
创建新的广告订单。
delete DELETE /v2/advertisers/{advertiserId}/insertionOrders/{insertionOrderId}
删除广告订单。
get GET /v2/advertisers/{advertiserId}/insertionOrders/{insertionOrderId}
获取广告订单。
list GET /v2/advertisers/{advertiserId}/insertionOrders
列出广告客户中的广告订单。
listAssignedTargetingOptions GET /v2/advertisers/{advertiserId}/insertionOrders/{insertionOrderId}:listAssignedTargetingOptions
列出广告订单在各种定位类型中已分配的定位选项。
patch PATCH /v2/advertisers/{insertionOrder.advertiserId}/insertionOrders/{insertionOrder.insertionOrderId}
更新现有广告订单。

REST 资源:v2.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions

方法
create POST /v2/advertisers/{advertiserId}/insertionOrders/{insertionOrderId}/targetingTypes/{targetingType}/assignedTargetingOptions
为广告订单分配定位选项。
delete DELETE /v2/advertisers/{advertiserId}/insertionOrders/{insertionOrderId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}
从广告订单中删除已分配的定位选项。
get GET /v2/advertisers/{advertiserId}/insertionOrders/{insertionOrderId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}
获取分配给广告订单的单个定位选项。
list GET /v2/advertisers/{advertiserId}/insertionOrders/{insertionOrderId}/targetingTypes/{targetingType}/assignedTargetingOptions
列出分配给广告订单的定位选项。

REST 资源:v2.advertisers.invoices

方法
list GET /v2/advertisers/{advertiserId}/invoices
列出广告客户在给定月份内发布的账单。
lookupInvoiceCurrency GET /v2/advertisers/{advertiserId}/invoices:lookupInvoiceCurrency
检索广告客户在给定月份使用的账单币种。

REST 资源:v2.advertisers.lineItems

方法
bulkEditAssignedTargetingOptions POST /v2/advertisers/{advertiserId}/lineItems:bulkEditAssignedTargetingOptions
批量修改多个订单项下的定位选项。
bulkListAssignedTargetingOptions GET /v2/advertisers/{advertiserId}/lineItems:bulkListAssignedTargetingOptions
列出为多个订单项分配的定位选项(适用于各种定位类型)。
bulkUpdate POST /v2/advertisers/{advertiserId}/lineItems:bulkUpdate
更新多个订单项。
create POST /v2/advertisers/{lineItem.advertiserId}/lineItems
创建一个新订单项。
delete DELETE /v2/advertisers/{advertiserId}/lineItems/{lineItemId}
删除订单项。
duplicate POST /v2/advertisers/{advertiserId}/lineItems/{lineItemId}:duplicate
复制订单项。
generateDefault POST /v2/advertisers/{advertiserId}/lineItems:generateDefault
创建一个新订单项,并为其采用继承自广告订单的设置(包括定位)和 ENTITY_STATUS_DRAFT entity_status
get GET /v2/advertisers/{advertiserId}/lineItems/{lineItemId}
获取订单项。
list GET /v2/advertisers/{advertiserId}/lineItems
列出广告客户中的订单项。
patch PATCH /v2/advertisers/{lineItem.advertiserId}/lineItems/{lineItem.lineItemId}
更新现有订单项。

REST 资源:v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions

方法
create POST /v2/advertisers/{advertiserId}/lineItems/{lineItemId}/targetingTypes/{targetingType}/assignedTargetingOptions
为订单项分配定位选项。
delete DELETE /v2/advertisers/{advertiserId}/lineItems/{lineItemId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}
从订单项中删除已分配的定位选项。
get GET /v2/advertisers/{advertiserId}/lineItems/{lineItemId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}
获取分配给订单项的单个定位选项。
list GET /v2/advertisers/{advertiserId}/lineItems/{lineItemId}/targetingTypes/{targetingType}/assignedTargetingOptions
列出分配给订单项的定位选项。

REST 资源:v2.advertisers.locationLists

方法
create POST /v2/advertisers/{advertiserId}/locationLists
创建新的位置列表。
get GET /v2/advertisers/{advertiserId}/locationLists/{locationListId}
获取位置列表。
list GET /v2/advertisers/{advertiserId}/locationLists
根据给定的广告客户 ID 列出地理位置列表。
patch PATCH /v2/advertisers/{advertiserId}/locationLists/{locationList.locationListId}
更新位置列表。

REST 资源:v2.advertisers.locationLists.assignedLocations

方法
bulkEdit POST /v2/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations:bulkEdit
批量修改营业地点与单个地理位置列表之间的多项分配关系。
create POST /v2/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
在营业地点和营业地点列表之间创建分配。
delete DELETE /v2/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{assignedLocationId}
删除营业地点与营业地点列表之间的分配关系。
list GET /v2/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
列出已分配给某个营业地点列表的营业地点。

REST 资源:v2.advertisers.manualTriggers

方法
activate POST /v2/advertisers/{advertiserId}/manualTriggers/{triggerId}:activate
启用手动触发器。
create POST /v2/advertisers/{manualTrigger.advertiserId}/manualTriggers
创建新的手动触发器。
deactivate POST /v2/advertisers/{advertiserId}/manualTriggers/{triggerId}:deactivate
停用手动触发器。
get GET /v2/advertisers/{advertiserId}/manualTriggers/{triggerId}
获取手动触发器。
list GET /v2/advertisers/{advertiserId}/manualTriggers
列出指定广告客户 ID 的当前用户可以访问的手动触发器。
patch PATCH /v2/advertisers/{manualTrigger.advertiserId}/manualTriggers/{manualTrigger.triggerId}
更新手动触发器。

REST 资源:v2.advertisers.negativeKeywordLists

方法
create POST /v2/advertisers/{advertiserId}/negativeKeywordLists
创建新的否定关键字列表。
delete DELETE /v2/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}
根据广告客户 ID 和否定关键字列表 ID 删除否定关键字列表。
get GET /v2/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}
根据广告客户 ID 和否定关键字列表 ID 获取否定关键字列表。
list GET /v2/advertisers/{advertiserId}/negativeKeywordLists
根据给定的广告客户 ID 列出否定关键字列表。
patch PATCH /v2/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordList.negativeKeywordListId}
更新否定关键字列表。

REST 资源:v2.advertisers.negativeKeywordLists.negativeKeywords

方法
bulkEdit POST /v2/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}/negativeKeywords:bulkEdit
在一个否定关键字列表中批量修改否定关键字。
create POST /v2/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}/negativeKeywords
在否定关键字列表中创建否定关键字。
delete DELETE /v2/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}/negativeKeywords/{keywordValue}
从否定关键字列表中移除否定关键字。
list GET /v2/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}/negativeKeywords
列出否定关键字列表中的否定关键字。
replace POST /v2/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}/negativeKeywords:replace
替换一个否定关键字列表中的所有否定关键字。

REST 资源:v2.advertisers.targetingTypes.assignedTargetingOptions

方法
create POST /v2/advertisers/{advertiserId}/targetingTypes/{targetingType}/assignedTargetingOptions
为广告客户分配定位选项。
delete DELETE /v2/advertisers/{advertiserId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}
从广告客户中删除已分配的定位选项。
get GET /v2/advertisers/{advertiserId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}
获取分配给广告客户的单个定位选项。
list GET /v2/advertisers/{advertiserId}/targetingTypes/{targetingType}/assignedTargetingOptions
列出分配给广告客户的定位选项。

REST 资源:v2.advertisers.youtubeAdGroupAds

方法
get GET /v2/advertisers/{advertiserId}/youtubeAdGroupAds/{youtubeAdGroupAdId}
获取 YouTube 广告组广告。
list GET /v2/advertisers/{advertiserId}/youtubeAdGroupAds
列出 YouTube 广告组广告。

REST 资源:v2.advertisers.youtubeAdGroups

方法
bulkListAdGroupAssignedTargetingOptions GET /v2/advertisers/{advertiserId}/youtubeAdGroups:bulkListAdGroupAssignedTargetingOptions
列出为多个 YouTube 广告组分配的各个定位类型指定的定位选项。
get GET /v2/advertisers/{advertiserId}/youtubeAdGroups/{youtubeAdGroupId}
获取 YouTube 广告组。
list GET /v2/advertisers/{advertiserId}/youtubeAdGroups
列出 YouTube 广告组。

REST 资源:v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions

方法
get GET /v2/advertisers/{advertiserId}/youtubeAdGroups/{youtubeAdGroupId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}
获取分配给 YouTube 广告组的单个定位选项。
list GET /v2/advertisers/{advertiserId}/youtubeAdGroups/{youtubeAdGroupId}/targetingTypes/{targetingType}/assignedTargetingOptions
列出分配给 YouTube 广告组的定位选项。

REST 资源:v2.combinedAudiences

方法
get GET /v2/combinedAudiences/{combinedAudienceId}
获取组合的受众群体。
list GET /v2/combinedAudiences
列出组合的受众群体。

REST 资源:v2.customBiddingAlgorithms

方法
create POST /v2/customBiddingAlgorithms
创建新的自定义出价算法。
get GET /v2/customBiddingAlgorithms/{customBiddingAlgorithmId}
获取自定义出价算法。
list GET /v2/customBiddingAlgorithms
列出当前用户可以访问且可用于出价策略的自定义出价算法。
patch PATCH /v2/customBiddingAlgorithms/{customBiddingAlgorithm.customBiddingAlgorithmId}
更新现有的自定义出价算法。
uploadScript GET /v2/customBiddingAlgorithms/{customBiddingAlgorithmId}:uploadScript
为脚本文件创建自定义出价脚本引用对象。

REST 资源:v2.customBiddingAlgorithms.scripts

方法
create POST /v2/customBiddingAlgorithms/{customBiddingAlgorithmId}/scripts
创建新的自定义出价脚本。
get GET /v2/customBiddingAlgorithms/{customBiddingAlgorithmId}/scripts/{customBiddingScriptId}
获取自定义出价脚本。
list GET /v2/customBiddingAlgorithms/{customBiddingAlgorithmId}/scripts
列出属于指定算法的自定义出价脚本。

REST 资源:v2.customLists

方法
get GET /v2/customLists/{customListId}
获取自定义列表。
list GET /v2/customLists
列出自定义名单。

REST 资源:v2.firstAndThirdPartyAudiences

方法
create POST /v2/firstAndThirdPartyAudiences
创建 FirstAndThirdPartyAudience。
editCustomerMatchMembers POST /v2/firstAndThirdPartyAudiences/{firstAndThirdPartyAudienceId}:editCustomerMatchMembers
更新目标客户匹配受众群体的成员名单。
get GET /v2/firstAndThirdPartyAudiences/{firstAndThirdPartyAudienceId}
获取第一方和第三方受众群体。
list GET /v2/firstAndThirdPartyAudiences
列出第一方和第三方受众群体。
patch PATCH /v2/firstAndThirdPartyAudiences/{firstAndThirdPartyAudience.firstAndThirdPartyAudienceId}
更新现有的 FirstAndThirdPartyAudience。

REST 资源:v2.floodlightGroups

方法
get GET /v2/floodlightGroups/{floodlightGroupId}
获取 Floodlight 组。
patch PATCH /v2/floodlightGroups/{floodlightGroup.floodlightGroupId}
更新现有 Floodlight 活动组。

REST 资源:v2.floodlightGroups.floodlightActivities

方法
get GET /v2/floodlightGroups/{floodlightGroupId}/floodlightActivities/{floodlightActivityId}
获取 Floodlight 活动。
list GET /v2/floodlightGroups/{floodlightGroupId}/floodlightActivities
列出 Floodlight 活动组中的 Floodlight 活动。

REST 资源:v2.googleAudiences

方法
get GET /v2/googleAudiences/{googleAudienceId}
获取 Google 受众群体。
list GET /v2/googleAudiences
列出 Google 受众群体。

REST 资源:v2.guaranteedOrders

方法
create POST /v2/guaranteedOrders
创建新的有保证订单。
editGuaranteedOrderReadAccessors POST /v2/guaranteedOrders/{guaranteedOrderId}:editGuaranteedOrderReadAccessors
修改有保证订单的广告客户读取。
get GET /v2/guaranteedOrders/{guaranteedOrderId}
获取有保证的订单。
list GET /v2/guaranteedOrders
列出当前用户访问的有保证订单。
patch PATCH /v2/guaranteedOrders/{guaranteedOrder.guaranteedOrderId}
更新现有的有保证订单。

REST 资源:v2.inventorySourceGroups

方法
create POST /v2/inventorySourceGroups
创建一个新的广告资源来源组。
delete DELETE /v2/inventorySourceGroups/{inventorySourceGroupId}
删除广告资源来源组。
get GET /v2/inventorySourceGroups/{inventorySourceGroupId}
获取广告资源来源组。
list GET /v2/inventorySourceGroups
列出当前用户访问的广告资源来源组。
patch PATCH /v2/inventorySourceGroups/{inventorySourceGroup.inventorySourceGroupId}
更新广告资源来源组。

REST 资源:v2.inventorySourceGroups.assignedInventorySources

方法
bulkEdit POST /v2/inventorySourceGroups/{inventorySourceGroupId}/assignedInventorySources:bulkEdit
批量修改广告资源来源与单个广告资源来源组之间的多项分配关系。
create POST /v2/inventorySourceGroups/{inventorySourceGroupId}/assignedInventorySources
在广告资源来源和广告资源来源组之间创建分配关系。
delete DELETE /v2/inventorySourceGroups/{inventorySourceGroupId}/assignedInventorySources/{assignedInventorySourceId}
删除广告资源来源与广告资源来源组之间的分配关系。
list GET /v2/inventorySourceGroups/{inventorySourceGroupId}/assignedInventorySources
列出分配给广告资源来源组的广告资源来源。

REST 资源:v2.inventorySources

方法
create POST /v2/inventorySources
创建新的广告资源来源。
editInventorySourceReadWriteAccessors POST /v2/inventorySources/{inventorySourceId}:editInventorySourceReadWriteAccessors
可以修改广告资源来源的读写访问器。
get GET /v2/inventorySources/{inventorySourceId}
获取广告资源来源。
list GET /v2/inventorySources
列出当前用户访问的广告资源来源。
patch PATCH /v2/inventorySources/{inventorySource.inventorySourceId}
更新现有广告资源来源。

REST 资源:v2.media

方法
download GET /download/{resourceName=**}
下载媒体内容。
upload POST /media/{resourceName=**}
POST /upload/media/{resourceName=**}
上传媒体内容。

REST 资源:v2.partners

方法
editAssignedTargetingOptions POST /v2/partners/{partnerId}:editAssignedTargetingOptions
修改单个合作伙伴下的定位选项。
get GET /v2/partners/{partnerId}
获取合作伙伴。
list GET /v2/partners
列出当前用户可访问的合作伙伴。

REST 资源:v2.partners.channels

方法
create POST /v2/partners/{partnerId}/channels
创建一个新频道。
get GET /v2/partners/{partnerId}/channels/{channelId}
获取合作伙伴或广告客户的渠道。
list GET /v2/partners/{partnerId}/channels
列出合作伙伴或广告客户的渠道。
patch PATCH /v2/partners/{partnerId}/channels/{channel.channelId}
更新渠道。

REST 资源:v2.partners.channels.sites

方法
bulkEdit POST /v2/partners/{partnerId}/channels/{channelId}/sites:bulkEdit
批量修改单个渠道下的网站。
create POST /v2/partners/{partnerId}/channels/{channelId}/sites
在渠道中创建网站。
delete DELETE /v2/partners/{partnerId}/channels/{channelId}/sites/{urlOrAppId}
从渠道中删除网站。
list GET /v2/partners/{partnerId}/channels/{channelId}/sites
列出渠道中的网站。
replace POST /v2/partners/{partnerId}/channels/{channelId}/sites:replace
替换单个渠道下的所有网站。

REST 资源:v2.partners.targetingTypes.assignedTargetingOptions

方法
create POST /v2/partners/{partnerId}/targetingTypes/{targetingType}/assignedTargetingOptions
向合作伙伴分配定位选项。
delete DELETE /v2/partners/{partnerId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}
从合作伙伴中删除已分配的定位选项。
get GET /v2/partners/{partnerId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}
获取分配给合作伙伴的单个定位选项。
list GET /v2/partners/{partnerId}/targetingTypes/{targetingType}/assignedTargetingOptions
列出分配给合作伙伴的定位选项。

REST 资源:v2.sdfdownloadtasks

方法
create POST /v2/sdfdownloadtasks
创建 SDF 下载任务。

REST 资源:v2.sdfdownloadtasks.operations

方法
get GET /v2/{name=sdfdownloadtasks/operations/*}
获取异步 SDF 下载任务操作的最新状态。

REST 资源:v2.targetingTypes.targetingOptions

方法
get GET /v2/targetingTypes/{targetingType}/targetingOptions/{targetingOptionId}
获取一个定位选项。
list GET /v2/targetingTypes/{targetingType}/targetingOptions
列出指定类型的定位选项。
search POST /v2/targetingTypes/{targetingType}/targetingOptions:search
根据指定搜索字词搜索指定类型的定位选项。

REST 资源:v2.users

方法
bulkEditAssignedUserRoles POST /v2/users/{userId}:bulkEditAssignedUserRoles
为用户批量修改用户角色。
create POST /v2/users
创建新用户。
delete DELETE /v2/users/{userId}
删除用户。
get GET /v2/users/{userId}
获取用户。
list GET /v2/users
列出当前用户可以访问的用户。
patch PATCH /v2/users/{user.userId}
更新现有用户。