上次更新時間:2022-12-06
遷移應用程式
從 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_TABLETDeviceType列舉來指定平板電腦裝置,而非使用targetingTypes.targetingOptions服務的指定選項 ID。這些列舉的字串版本會顯示在這些AssignedTargetingOption資源的新assignedTargetingOptionIdAlias欄位中,可用於擷取或刪除現有指定目標。這些AssignedTargetingOption資源的assignedTargetingOptionId值並未變更。更新管理下列指定類型的呼叫,以便使用列舉值:
TARGETING_TYPE_AGE_RANGETARGETING_TYPE_CONTENT_INSTREAM_POSITIONTARGETING_TYPE_CONTENT_OUTSTREAM_POSITIONTARGETING_TYPE_DEVICE_TYPETARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSIONTARGETING_TYPE_ENVIRONMENTTARGETING_TYPE_EXCHANGETARGETING_TYPE_GENDERTARGETING_TYPE_HOUSEHOLD_INCOMETARGETING_TYPE_NATIVE_CONTENT_POSITIONTARGETING_TYPE_OMIDTARGETING_TYPE_PARENTAL_STATUSTARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSIONTARGETING_TYPE_VIDEO_PLAYER_SIZETARGETING_TYPE_VIEWABILITY
方法
advertisers.lineItems.bulkEditLineItemAssignedTargetingOptions已由方法advertisers.lineItems.bulkEditAssignedTargetingOptions取代。方法
advertisers.lineItems.bulkListLineItemAssignedTargetingOptions已由方法advertisers.lineItems.bulkListAssignedTargetingOptions取代。更新管理
TARGETING_TYPE_PROXIMITY_LOCATION_LIST的呼叫,以便使用設定的半徑大小和距離單位,而非ProximityRadiusRange列舉值。針對單一父項資源下多個指定類型擷取或編輯指定選項的指定方法已重新命名。
更新對下列方法的呼叫,以便使用新名稱:
advertisers.bulkEditAdvertiserAssignedTargetingOptions至advertisers.editAssignedTargetingOptionsadvertisers.bulkListAdvertiserAssignedTargetingOptions至advertisers.listAssignedTargetingOptionsadvertisers.campaigns.bulkListCampaignAssignedTargetingOptions至advertisers.campaigns.listAssignedTargetingOptionsadvertisers.insertionOrders.bulkListInsertionOrderAssignedTargetingOptions至advertisers.insertionOrders.listAssignedTargetingOptionspartners.bulkEditPartnerAssignedTargetingOptions至partners.editAssignedTargetingOptions
更新對 advertisers.lineItems 服務的呼叫
- 已移除欄位
inventorySourceIds。使用TARGETING_TYPE_INVENTORY_SOURCE的AssignedTargetingOption資源管理廣告空間來源指派。 下列
LineItemWarningMessage列舉值已在 v2 中淘汰,且不會再顯示在LineItem.warningMessages中:NO_POSITIVE_AUDIENCE_LIST_TARGETEDAPP_INSTALL_NO_CONVERSION_PIXELTARGETING_REVOKED_OR_CLOSED_USER_LISTAPP_INSTALL_NO_OPTIMAL_BIDDING_STRATEGYCREATIVE_SIZE_NOT_IN_USE_FOR_TARGETED_DEALSNO_CREATIVE_FOR_TARGETED_DEALSTARGETING_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_ACTIONLINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIOLINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLELINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOPLINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACHLINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOPLINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLELINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOPLINE_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_RANGETARGETING_TYPE_BROWSERTARGETING_TYPE_CATEGORYTARGETING_TYPE_CHANNELTARGETING_TYPE_DEVICE_MAKE_MODELTARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSIONTARGETING_TYPE_ENVIRONMENTTARGETING_TYPE_GENDERTARGETING_TYPE_KEYWORDTARGETING_TYPE_LANGUAGETARGETING_TYPE_NEGATIVE_KEYWORD_LISTTARGETING_TYPE_OPERATING_SYSTEMTARGETING_TYPE_PARENTAL_STATUSTARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSIONTARGETING_TYPE_VIEWABILITY