v1 から v2 に移行する

最終更新日: 2022 年 12 月 6 日

アプリケーションの移行

v1 から v2 に移行するには、v2 と 互換性を破る変更に対応するためにアプリケーションを更新する

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 では、互換性を破る変更が多数行われています。以下を確認してください の既存の使用に関連する必要な変更を行う ディスプレイとVideo 360 API。

ターゲティング メソッドの呼び出しを更新する

• 一部のターゲティング タイプは、ターゲティングではなく列挙値を使用して割り当てられるようになりました あります。たとえばタブレット デバイスは DEVICE_TYPE_TABLET DeviceType 列挙型、 （P-MAX キャンペーンのターゲティングオプション ID ではなく targetingTypes.targetingOptions サービスで利用できます。次の文字列バージョン: これらの列挙型は新しい これらの assignedTargetingOptionIdAlias フィールド AssignedTargetingOption 個のリソースを取得または取得するときに使用できます。 既存のターゲティングを削除するassignedTargetingOptionId 値 これらの AssignedTargetingOption 個のリソースのうち、変更はありません。

  次のターゲティング タイプを管理する呼び出しを更新して、列挙値を使用します。

  • 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 が削除されました。管理 AssignedTargetingOption リソースを使用した広告枠ソースの割り当て /TARGETING_TYPE_INVENTORY_SOURCE。

• 次の LineItemWarningMessage 列挙値は次のとおりです。 バージョン 2 で非推奨となり、今後は 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 に置き換えられました フィールド。readiness が表示されます。 既存のアルゴリズムの 一時停止状態 アクセス権を持つ広告主ごとに、 CustomBiddingModelDetails オブジェクト。

その他の変更

v2 では、上記の互換性を破る変更に加え、 説明します。

初期リリース後に v2 に追加された機能は、 リリースノートをご覧ください。

YouTube 広告申込情報に対する読み取り専用アクセス権

v2 では、YouTube 広告申込情報とそのターゲット設定は、 advertisers.lineItems と advertisers.lineItems.targetingTypes.assignedTargetingOptions 提供します。この API には読み取り専用アクセス権があります。つまり、 これらの広告申込情報に対して書き込みリクエストを行うと、エラーが返されます。YouTube 広告申込情報は、次のいずれかの LineItemType になります。 values:

• 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 では、InsertionOrder のサブセットのターゲット設定を編集できます。 新しい create とリソースの使用 delete メソッド advertisers.insertionOrders.targetingTypes.assignedTargetingOptions あります。次のターゲティング タイプは、挿入時に完全に管理できます 注文レベル:

• 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