上次更新日期: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 中引入了许多破坏性更改。请查看以下内容 对现有使用说明进行必要的更改 展示广告与Video 360 API。
更新对定位方式的调用
某些定位类型现在使用枚举值(而非定位)进行分配 选项 ID。例如,平板电脑设备现在直接通过
DEVICE_TYPE_TABLET
DeviceType
枚举、 而不是来自targetingTypes.targetingOptions
服务。字符串版本 这些枚举均以新的 以下字段中的assignedTargetingOptionIdAlias
字段AssignedTargetingOption
资源,可在检索或 删除现有定位条件。assignedTargetingOptionId
值 有AssignedTargetingOption
项资源未更改。更新管理以下定位类型的调用以使用枚举值:
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
已被移除。管理 使用AssignedTargetingOption
资源分配广告资源来源 共TARGETING_TYPE_INVENTORY_SOURCE
个。 以下
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 首次发布后添加到 v2 中的功能, 版本说明。
对 YouTube 订单项拥有只读权限
在 v2 中,可以使用以下代码检索 YouTube 订单项及其定位设置
advertisers.lineItems
和
advertisers.lineItems.targetingTypes.assignedTargetingOptions
服务。该 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 中,您可以修改 InsertionOrder
的部分定位设置
使用新的 create
和
delete
方法(位于
advertisers.insertionOrders.targetingTypes.assignedTargetingOptions
服务。以下定位类型可在插入时完全进行管理
订单级:
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