このページは Cloud Translation API によって翻訳されました。

v2 から v3 に移行する

最終更新日: 2023-10-31

アプリケーションの移行

v2 から v3 に移行するには、v3 を呼び出すようにエンドポイント URL を更新し、互換性を破る変更に備えてアプリケーションを更新する必要があります。

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

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

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

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

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

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

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

必要な変更を加える

v3 には、互換性を破る変更がいくつか導入されています。以下の手順を確認し、Display & Video 360 API の既存の使用方法に応じて必要な変更を加えます。

YouTube リソースとそれに関連するターゲティングを取得している通話を更新する

YoutubeAdGroup リソースと YoutubeAdGroupAd リソースが AdGroup リソースと AdGroupAd リソースに置き換えられました。これらの新しいリソースは v2 リソースとほぼ同じ情報を提供しますが、更新されたフィールド名または列挙型を使用できます。統合で、YoutubeAdGroup リソースまたは YoutubeAdGroupAd リソースの使用を AdGroup リソースと AdGroupAd リソースに置き換え、次の v2 サービスの呼び出しを対応する v3 サービスに更新します。
- advertisers.youtubeAdGroupAds～advertisers.adGroupAds
- advertisers.youtubeAdGroups～advertisers.adGroups
- advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions から advertisers.adGroups.targetingTypes.assignedTargetingOptions
YoutubeAndPartnersBiddingStrategy オブジェクトへの参照が、一般的な BiddingStrategy オブジェクト内の新しい youtubeAndPartnersBid フィールドに移動しました。biddingStrategy フィールドは YoutubeAndPartnersSettings オブジェクトから削除されました。統合を更新して、LineItem リソースまたは AdGroup リソースの bidStrategy フィールドの BiddingStrategy オブジェクトから YouTube 広告申込情報または広告グループの入札戦略を取得します。
YoutubeAndPartnersSettings オブジェクトの thirdPartyMeasurementSettings フィールドの名前が thirdPartyMeasurementConfigs に、YoutubeAndPartnersThirdPartyMeasurementSettings オブジェクトの名前が ThirdPartyMeasurementConfigs に変更されました。統合を更新し、新しいフィールドとオブジェクトを使用してサードパーティ測定の設定情報を取得します。

広告主の作成時に必要なお支払い情報の設定を含める

billingConfig が Advertiser リソースの必須フィールドになりました。advertisers.create リクエストを更新して、このフィールドが設定されていることを確認します。親パートナーのデフォルトのお支払い情報は、新しい Partner リソースの billingConfig フィールドを使用して取得できます。

新しいフィールドを使用して最適化されたターゲティングを管理する

TargetingExpansionConfig オブジェクトの targetingExpansionLevel フィールドが、新しいブール値の enableOptimizedTargeting フィールドに置き換えられました。

新しい KPI フィールドを使用するよう広告掲載オーダーの統合を更新する

InsertionOrder リソースの performanceGoal フィールドが新しい kpi フィールドに置き換えられました。この新しいフィールドでは、PerformanceGoal オブジェクトの代わりに Kpi オブジェクトを使用し、新しいフィールドと列挙型を使用します。

非推奨のサービスおよびフィールドへの参照を削除する

過去の非推奨の機能に合わせて、v3 ではさまざまなエンティティが削除されました。

手動トリガーが非推奨となったため、advertisers.manualTriggers サービスは削除されました。
成果ベースの購入が非推奨となったため、billableOutcome フィールドが InsertionOrder リソースから削除されました。

その他の変更

上記の互換性を破る変更に加えて、v3 では新機能も導入されています。

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

近隣地域リストの管理

v3 では近隣地域リストを完全に管理できるため、advertisers.locationLists.assignedLocations サービスを使用して TARGETING_LOCATION_TYPE_PROXIMITY LocationList リソースに割り当てられたビジネスを作成、削除できます。ロケーションは、TARGETING_TYPE_POI TargetingOption リソースの ID で識別されます。これらは targetingTypes.targetingOptions.search を使用して取得できます。

ルールベースのカスタム入札アルゴリズムを構築可能

v3 では、customBiddingAlgorithms、media、customBiddingAlgorithms.rules サービスを使用して、ルールベースのカスタム入札アルゴリズムを作成および取得できます。

この機能はベータ版であり、許可リストに登録されたパートナーのみご利用いただけます。パートナーが許可リストに登録されていない場合は、リクエストからエラーが返されます。