上次更新日期:2023 年 10 月 31 日
迁移您的应用
从 v2 迁移到 v3 需要更新端点网址以调用 v3,并更新应用以纳入重大变更。
将 API 调用从 v2 更新为 v3
如需使用 v3 而不是 v2,您需要更新请求以使用新的 v3 端点。
例如,如需使用 v2 调用 advertisers.get
方法,您可以使用以下网址:
GET https://displayvideo.googleapis.com/v2/advertisers/advertiserId
对于 v3,请将网址更新为以下网址:
GET https://displayvideo.googleapis.com/v3/advertisers/advertiserId
如果您使用客户端库向 API 发出请求,请使用最新版本的客户端库,并更新配置以使用 v3。
进行所需的更改
我们在 v3 中引入了多项破坏性变更。请查看以下说明,并根据您目前对 Display & Video 360 API 的使用情况进行必要的更改。
更新了用于检索 YouTube 资源及其相关定位的调用
YoutubeAdGroup
和YoutubeAdGroupAd
资源已替换为AdGroup
和AdGroupAd
资源。这些新资源提供的信息与 v2 资源几乎完全相同,但可能会使用更新的字段名称或枚举类型。在集成中,将YoutubeAdGroup
或YoutubeAdGroupAd
资源的使用替换为AdGroup
和AdGroupAd
资源,并将对以下 v2 服务的调用更新为相应的 v3 服务:advertisers.youtubeAdGroupAds
到advertisers.adGroupAds
advertisers.youtubeAdGroups
到advertisers.adGroups
advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions
至advertisers.adGroups.targetingTypes.assignedTargetingOptions
- 对
YoutubeAndPartnersBiddingStrategy
对象的引用已移至常规BiddingStrategy
对象中的新youtubeAndPartnersBid
字段。biddingStrategy
字段已从YoutubeAndPartnersSettings
对象中移除。更新您的集成,以从LineItem
或AdGroup
资源的bidStrategy
字段中的BiddingStrategy
对象检索 YouTube 订单项或广告组的出价策略。 - 在
YoutubeAndPartnersSettings
对象中,thirdPartyMeasurementSettings
字段已重命名为thirdPartyMeasurementConfigs
,YoutubeAndPartnersThirdPartyMeasurementSettings
对象已重命名为ThirdPartyMeasurementConfigs
。更新集成,以使用新字段和对象检索第三方效果衡量配置信息。
创建广告客户时,请添加所需的结算配置
billingConfig
现在是 Advertiser
资源中的必填字段。更新您的 advertisers.create
请求,以验证是否已设置此字段。可以通过新的 Partner
资源 billingConfig
字段检索父合作伙伴的默认结算信息。
使用新字段来控制优化型定位
TargetingExpansionConfig
对象中的 targetingExpansionLevel
字段已替换为新的布尔值 enableOptimizedTargeting
字段。
更新了广告订单集成,以使用新的 KPI 字段
新的 kpi
字段已取代 InsertionOrder
资源中的 performanceGoal
字段。此新字段使用 Kpi
对象代替 PerformanceGoal
对象,并使用新字段和枚举。
移除了对已弃用的服务和字段的引用
为了与过去的功能弃用保持一致,v3 中移除了各种实体:
- 由于手动触发器已被弃用,
advertisers.manualTriggers
服务已被移除。 - 由于“按结果付费购买”模式已被弃用,因此
billableOutcome
字段已从InsertionOrder
资源中移除。
其他更改
除了上述重大更改之外,v3 还引入了新功能。
如需了解初始发布后添加到 v3 中的功能,请参阅我们的版本说明。
管理邻近区域位置列表
在 v3 中,您可以完全管理邻近位置列表,从而使用 advertisers.locationLists.assignedLocations
服务创建和删除分配给 TARGETING_LOCATION_TYPE_PROXIMITY
LocationList
资源的位置。位置信息通过 TARGETING_TYPE_POI
TargetingOption
资源的 ID 来标识。您可以使用 targetingTypes.targetingOptions.search
检索这些信息。
能够构建基于规则的自定义出价算法
在 v3 中,您可以使用 customBiddingAlgorithms
、media
、customBiddingAlgorithms.rules
服务构建和检索基于规则的自定义出价算法。
此功能目前处于 Beta 版阶段,仅供已列入许可名单的合作伙伴使用。如果您的合作伙伴未列入许可名单,您的请求将返回错误。