最終更新日: 2022-12-06
アプリケーションの移行
v1 から v2 に移行するには、v2 を呼び出すようにエンドポイント URL を更新し、互換性を破る変更に備えてアプリケーションを更新する必要があります。
API 呼び出しを v1 から v2 に更新する
v1 の代わりに v2 を使用するには、新しい v2 エンドポイントを使用するようにリクエストを更新する必要があります。
たとえば、v1 で advertisers.get
メソッドを呼び出すには、次の URL を使用します。
GET https://displayvideo.googleapis.com/v1/advertisers/advertiserId
v2 の場合は、URL を次のように更新します。
GET https://displayvideo.googleapis.com/v2/advertisers/advertiserId
クライアント ライブラリを使用して API にリクエストを送信する場合は、クライアント ライブラリの最新バージョンを使用し、v2 を使用するように構成を更新します。
必要な変更を加える
v2 には、互換性を破る変更がいくつか導入されています。以下の手順を確認し、Display & Video 360 API の既存の使用方法に応じて必要な変更を加えます。
ターゲティング方法の呼び出しを更新する
一部のターゲティング タイプについては、ターゲティング オプション ID の代わりに列挙値を使用して割り当てられるようになりました。たとえば、タブレット デバイスは、
targetingTypes.targetingOptions
サービスのターゲティング オプション ID ではなく、DEVICE_TYPE_TABLET
DeviceType
列挙型で直接ターゲティングされるようになりました。これらの列挙型の文字列バージョンは、これらの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
メソッドに置き換えられました。ProximityRadiusRange
列挙値ではなく、設定された半径サイズと距離単位を使用するように、TARGETING_TYPE_PROXIMITY_LOCATION_LIST
を管理する呼び出しを更新します。1 つの親リソースにある複数のターゲティング タイプでターゲティング オプションを取得または編集するターゲティング方法の名前が変更されました。
新しい名前を使用するように、次のメソッドの呼び出しを更新します。
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 では、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 では、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