v1 から v2 に移行する

最終更新日: 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 では、互換性を破る変更がいくつか導入されます。以下の手順を確認し、ディスプレイ＆ビデオ 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 に置き換えられました。

• TARGETING_TYPE_PROXIMITY_LOCATION_LIST を管理する呼び出しを更新し、ProximityRadiusRange 列挙値ではなく、設定された半径サイズと距離単位を使用するようにしました。

• 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