v3 から v4 に移行する

最終更新日: 2025-03-27

アプリケーションの移行

v3 から v4 に移行するには、v4 を呼び出すようにエンドポイント URL を更新し、破壊的変更に対応するようにアプリケーションを更新する必要があります。

API 呼び出しを v3 から v4 に更新する

v3 ではなく v4 を使用するには、新しい v4 エンドポイントを使用するようにリクエストを更新します。

たとえば、v3 で advertisers.get メソッドを呼び出すには、次の URL を使用します。

GET https://displayvideo.googleapis.com/v3/advertisers/advertiserId

v4 の場合は、URL を次のように更新します。

GET https://displayvideo.googleapis.com/v4/advertisers/advertiserId

クライアント ライブラリを使用して API にリクエストを送信している場合は、最新バージョンのクライアント ライブラリを使用し、v4 を使用するように構成を更新してください。

必要な変更を加える

v4 では、互換性を破る変更がいくつか導入されます。以下の手順を確認し、ディスプレイ＆ビデオ 360 API の既存の使用状況に関連する必要な変更を加えます。

ファーストパーティ / サードパーティ オーディエンス リソースと関連するターゲティングに関するコールを更新

FirstAndThirdPartyAudience リソースは FirstPartyAndPartnerAudience リソースに置き換えられました。

この変更を行うには、以下を更新する必要があります。

• 新しい FirstPartyAndPartnerAudience リソースを使用する FirstAndThirdPartyAudience リソースへの参照。
• v3 サービス firstAndThirdPartyAudiences のメソッドに対する既存のリクエストを、新しい v4 サービス firstPartyAndPartnerAudiences に移動します。
• firstPartyAndPartnerAudiences.list リクエストのデフォルトのページサイズは、100 ～ 5,000 アイテムです。
• v3 firstAndThirdPartyAudienceType フィールドから新しい v4 firstPartyAndPartnerAudienceType フィールドへの参照。新しい FirstPartyAndPartnerAudienceType 列挙型タイプを使用し、古い値は次の新しい値に対応します。
  • FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_FIRST_PARTY から TYPE_FIRST_PARTY
  • FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_THIRD_PARTY から TYPE_PARTNER

• AudienceType 列挙型値 LICENSED への参照を、より具体的な次のいずれかの新しい値に置き換える。

  • THIRD_PARTY
  • COMMERCE
  • LINEAR

• TargetingType TARGETING_TYPE_AUDIENCE_GROUP の AssignedTargetingOption リソースへの参照。AudienceGroupAssignedTargetingOptionDetails の v3 フィールドを次の新しい v4 フィールドに置き換えます。

  • excludedFirstPartyAndPartnerAudienceGroup を含む excludedFirstAndThirdPartyAudienceGroup
  • includedFirstPartyAndPartnerAudienceGroups を含む includedFirstAndThirdPartyAudienceGroups

既存の広告グループの一括リスト ターゲティング リクエストを更新する

advertisers.adGroups.bulkListAdGroupAssignedTargetingOptions の名前を advertisers.adGroups.bulkListAssignedTargetingOptions に変更しました。新しいメソッド名を使用するように既存のリクエストを更新します。

広告掲載オーダーを作成するときに最適化目標を含める

optimizationObjective が InsertionOrder リソースの必須フィールドになりました。advertisers.insertionOrders.create リクエストを更新して、このフィールドが設定されていることを確認します。

キャンペーンまたは広告掲載オーダーのターゲティングの管理または取得をリクエストする処理を削除

キャンペーンまたは広告掲載オーダーのターゲット設定を取得または管理する機能は削除されました。次のサービスまたはメソッドに対するリクエストを削除します。

• advertisers.campaigns.targetingTypes.assignedTargetingOptions サービス
• advertisers.insertionOrders.targetingTypes.assignedTargetingOptions サービス
• advertisers.campaigns.listAssignedTargetingOptions メソッド
• advertisers.insertionOrders.listAssignedTargetingOptions メソッド

クリエイティブ リソース フィールド publisherReviewStatuses への参照を削除

publisherReviewStatuses フィールドは、2024 年 6 月に非推奨となった後、Creative リソースの ReviewStatusInfo オブジェクトから削除されました。