上次更新時間: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
資源管理廣告空間來源指派作業。下列
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
物件清單存取權的每個廣告主,提供現有演算法模型的完備性和停權狀態。
其他異動
除了上述的破壞性變更外,第 2 版也會推出新功能。
如要瞭解初始推出後第 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
,在相同的廣告訂單中建立現有委刊項副本,以便複製所有設定和指定目標設定。
廣告訂單指定目標的部分寫入權限
在第 2 版中,您可以使用 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