上次更新: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。
進行必要變更
我們將在第 2 版推出幾項破壞性變更。請詳閱以下操作說明,並根據 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
資源管理廣告空間來源指派作業。 v2 已淘汰下列
LineItemWarningMessage
列舉值,不會再顯示於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 也提供新功能。
在初始啟動後加入第 2 版的功能會顯示在版本資訊中。
具備 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
提升成效的新方法
在第 2 版中,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