上次更新日期:2022 年 12 月 6 日
迁移应用
从 v1 迁移到 v2 需要将端点网址更新为调用 v2,并更新应用以考虑破坏性更改。
将您的 API 调用从 v1 更新为 v2
如需使用 v2 而不是 v1,您需要将请求更新为使用新的 v2 端点。
例如,如需使用 v1 调用 advertisers.get
方法,请使用以下网址:
GET https://displayvideo.googleapis.com/v1/advertisers/advertiserId
对于 v2,请将网址更新为以下内容:
GET https://displayvideo.googleapis.com/v2/advertisers/advertiserId
如果您使用客户端库向 API 发出请求,请使用最新版本的客户端库,并将您的配置更新为使用 v2。
进行所需的更改
我们在 v2 中进行了多项破坏性更改。请查看以下说明,并根据您当前使用 Display & Video 360 API 的情况进行必要的更改。
更新对定位方式的调用
某些定位类型现在使用枚举值(而非定位选项 ID)进行分配。例如,现在使用
DEVICE_TYPE_TABLET
DeviceType
枚举(而不是targetingTypes.targetingOptions
服务中的定位选项 ID)直接定位到平板电脑设备。这些枚举的字符串版本以这些AssignedTargetingOption
资源中的新assignedTargetingOptionIdAlias
字段表示,并且可在检索或删除现有定位条件时使用。这些AssignedTargetingOption
资源的assignedTargetingOptionId
值未更改。更新管理以下定位类型的调用以使用枚举值:
TARGETING_TYPE_AGE_RANGE
TARGETING_TYPE_CONTENT_INSTREAM_POSITION
TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
TARGETING_TYPE_DEVICE_TYPE
TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
TARGETING_TYPE_ENVIRONMENT
TARGETING_TYPE_EXCHANGE
TARGETING_TYPE_GENDER
TARGETING_TYPE_HOUSEHOLD_INCOME
TARGETING_TYPE_NATIVE_CONTENT_POSITION
TARGETING_TYPE_OMID
TARGETING_TYPE_PARENTAL_STATUS
TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
TARGETING_TYPE_VIDEO_PLAYER_SIZE
TARGETING_TYPE_VIEWABILITY
方法
advertisers.lineItems.bulkEditLineItemAssignedTargetingOptions
已替换为advertisers.lineItems.bulkEditAssignedTargetingOptions
方法。方法
advertisers.lineItems.bulkListLineItemAssignedTargetingOptions
已替换为advertisers.lineItems.bulkListAssignedTargetingOptions
方法。更新管理
TARGETING_TYPE_PROXIMITY_LOCATION_LIST
的调用,以使用设定的半径大小和距离单位,而不是ProximityRadiusRange
枚举值。已重命名单个父资源下跨多个定位类型检索或修改定位选项的定位方式。
更新对以下方法的调用以使用新名称:
- 将
advertisers.bulkEditAdvertiserAssignedTargetingOptions
更改为advertisers.editAssignedTargetingOptions
- 将
advertisers.bulkListAdvertiserAssignedTargetingOptions
更改为advertisers.listAssignedTargetingOptions
- 将
advertisers.campaigns.bulkListCampaignAssignedTargetingOptions
更改为advertisers.campaigns.listAssignedTargetingOptions
- 将
advertisers.insertionOrders.bulkListInsertionOrderAssignedTargetingOptions
更改为advertisers.insertionOrders.listAssignedTargetingOptions
partners.bulkEditPartnerAssignedTargetingOptions
至partners.editAssignedTargetingOptions
- 将
更新对 advertisers.lineItems
服务的调用
- 字段
inventorySourceIds
已被移除。使用TARGETING_TYPE_INVENTORY_SOURCE
的AssignedTargetingOption
资源管理广告资源来源分配关系。 以下
LineItemWarningMessage
枚举值在 v2 中已弃用,并且不再在LineItem.warningMessages
中显示:NO_POSITIVE_AUDIENCE_LIST_TARGETED
APP_INSTALL_NO_CONVERSION_PIXEL
TARGETING_REVOKED_OR_CLOSED_USER_LIST
APP_INSTALL_NO_OPTIMAL_BIDDING_STRATEGY
CREATIVE_SIZE_NOT_IN_USE_FOR_TARGETED_DEALS
NO_CREATIVE_FOR_TARGETED_DEALS
TARGETING_DEPRECATED_GEO_TARGET
triggerId
字段已从LineItemFlight
对象中移除,LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER
值已从LineItemFlightDateType
枚举类型中移除。v2 不支持根据手动触发器启用来将订单项设置为支出。
更新对 customBiddingAlgorithms
服务的调用
customBiddingAlgorithmState
和 modelReadiness
字段已替换为 modelDetails
字段,该字段可为每个广告主(通过 CustomBiddingModelDetails
对象列表提供访问权限)提供现有算法模型的就绪和暂停状态。
其他更改
除了上面列出的重大变更之外,v2 还引入了新功能。
如需了解初始发布之后添加到 v2 的功能,请参阅我们的版本说明。
对 YouTube 订单项的只读权限
在 v2 中,可以分别使用 advertisers.lineItems
和 advertisers.lineItems.targetingTypes.assignedTargetingOptions
服务检索 YouTube 订单项及其定位设置。该 API 提供只读访问权限,这意味着向这些订单项发出的任何尝试写入请求都将返回错误。YouTube 订单项将采用以下任一 LineItemType
值:
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTION
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIO
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE
可提升效果的新方法
在 v2 中,advertisers.lineItems
服务提供了新方法来代替批量请求,以提高性能并减少配额消耗:
- 您可以使用
advertisers.lineItems.bulkUpdate
为多个订单项设置相同的字段值。目前仅支持对entityStatus
字段的更新。 - 您可以使用
advertisers.lineItems.bulkEditAssignedTargetingOptions
在多个订单项中添加或移除相同的已分配定位选项。 - 您可以使用
advertisers.lineItems.bulkListAssignedTargetingOptions
列出多个订单项的已分配定位选项。 - 您可以使用
advertisers.lineItems.duplicate
复制同一广告订单中现有订单项的副本,从而复制所有配置和定位设置。
广告订单定位的部分写入权限
在 v2 中,您可以使用 advertisers.insertionOrders.targetingTypes.assignedTargetingOptions
服务中的新 create
和 delete
方法修改 InsertionOrder
资源的子集定位设置。您可以在广告订单级对以下定位类型进行全代管式管理:
TARGETING_TYPE_AGE_RANGE
TARGETING_TYPE_BROWSER
TARGETING_TYPE_CATEGORY
TARGETING_TYPE_CHANNEL
TARGETING_TYPE_DEVICE_MAKE_MODEL
TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
TARGETING_TYPE_ENVIRONMENT
TARGETING_TYPE_GENDER
TARGETING_TYPE_KEYWORD
TARGETING_TYPE_LANGUAGE
TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
TARGETING_TYPE_OPERATING_SYSTEM
TARGETING_TYPE_PARENTAL_STATUS
TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
TARGETING_TYPE_VIEWABILITY