キャンペーン マネージャー 360 API の新バージョンは定期的にリリースされます。新バージョンがリリースされると、それより古いバージョンはサポートが終了し、最終的には廃止されます。あるバージョンが廃止されると、そのバージョンに対するすべてのリクエストにエラーが返されるようになります。
使用しているバージョンが非推奨の場合は、サービスの中断を避けるため、できるだけ早くアップグレードする必要があります。
ステップ 1: 使用しているバージョンを確認する
使用している API バージョンは、次の手順で確認できます。ほとんどの場合、API へのアクセスには、Google から提供される言語別のクライアント ライブラリまたは公式の統合が使用されます。
Apps Script の新しいエディタ
Apps Script のバージョン情報は、高度なサービス ダイアログにエクスポーズされています。
- Apps Script エディタで、[サービスを追加] をクリックします。
- 使用可能なサービスのリストで、キャンペーン マネージャー 360 API を探します。
- バージョンのプルダウンで選択されている値が、使用されているキャンペーン マネージャー 360 API のバージョンです。
Apps Script の以前のエディタ
Apps Script のバージョン情報は、高度なサービス ダイアログにエクスポーズされています。
- Apps Script エディタから、[リソース] > [Google の拡張サービス] に移動します。
- 使用可能なサービスのリストで、キャンペーン マネージャー 360 API を探します。
- バージョンのプルダウンで選択されている値が、使用されているキャンペーン マネージャー 360 API のバージョンです。
C#
.NET の Google API クライアント ライブラリのバージョン情報は、以下の場所にエクスポーズされています。
- NuGet パッケージ名とサービスの名前空間に含まれています。
Google.Apis.Dfareporting.v3_4
DfareportingServiceの public プロパティによりエクスポーズされています。Console.WriteLine(DfareportingService.Version);
Java
Java 用 Google API クライアント ライブラリのバージョン情報は、以下の場所にエクスポーズされています。
- Maven の artifactId に指定されています。
<dependency> <groupId>com.google.apis</groupId> <artifactId>google-api-services-dfareporting</artifactId> <version>v3.4-rev1-1.21.0</version> </dependency>
- JAR ファイル名に含まれています。
google-api-services-dfareporting-v3.4-rev1-1.21.0.jar
Dfareportingの public プロパティによりエクスポーズされています。System.out.println(Dfareporting.DEFAULT_SERVICE_PATH);
PHP
PHP の Google API クライアント ライブラリのバージョン情報は、Google_Service_Dfareporting の public プロパティを使用してエクスポーズされています。
$service = new Google_Service_Dfareporting($client) print $service->version;
Python
Python 用 Google API クライアント ライブラリ(v1/v2)にはバージョンがありません。使用する API バージョンは discovery ビルダーの引数として指定されています。
discovery.build('dfareporting', 'v3.4', http=http)
Ruby
Ruby の Google API クライアント ライブラリには 0.9 より前のバージョンはありません。使用する API バージョンはサービス コンストラクタの引数として指定されています。
service = Google::APIClient::Service.new("dfareporting", "v3.4", { :application_name => "My application", :application_version => '1.0.0', :authorization => authorization } )
Ruby の Google API のクライアント ライブラリで 0.9 以降のバージョンは、サービスの名前空間にエクスポーズされています。
Google.Apis.DfareportingV3_4
手順 2: 使用しているバージョンのステータスを判断する
非推奨のスケジュールを確認して、バージョンのステータスを特定します。リストにないバージョンは廃止されており、サポートされていません。
お使いのバージョンがリストに記載されている場合は、[Deprecation Date] 列と [Sunset Date] 列を確認します。
- 日付が表示されていない場合は、そのバージョンは完全にサポートされています。
- 日付が記載されているバージョンはサポートが終了しており、指定されている日に廃止されます。
バージョンが非推奨になった場合やサポートが終了した場合は、サービスの中断を防ぐために新しいバージョンに移行する必要があります。アップグレード間の時間を最大化するには、スケジュールに示されている最新バージョン(ベータ版を除く)に移行することをおすすめします。
ステップ 3: バージョンをアップグレードする
API の新しいバージョンに移行するには、統合を更新するか、または使用したいクライアント ライブラリのビルドの更新版を取得する必要があります。クライアント ライブラリには、すべての API バージョンに対応する 1 つのビルドのみが提供されるものと、バージョンごとに別々のビルドが提供されるものがあります。以下では、広く使用されているクライアント ライブラリと統合における一般的なアップグレード情報を紹介します。
Apps Script の新しいエディタ
Google Apps Script では、Campaign Manager 360 API の全バージョンがサポートされており、スクリプトごとに使用するバージョンを選択できます。特定のスクリプトで使用されているバージョンを変更するには、次の手順に従います。
- Apps Script エディタで、[サービスを追加] をクリックします。
- 使用可能なサービスのリストで、キャンペーン マネージャー 360 API を探します。
- バージョンのプルダウンで、キャンペーン マネージャー 360 API のバージョンを変更します。
- [追加] をクリックして変更内容を保存します。
Apps Script の以前のエディタ
Google Apps Script では、Campaign Manager 360 API の全バージョンがサポートされており、スクリプトごとに使用するバージョンを選択できます。特定のスクリプトで使用されているバージョンを変更するには、次の手順に従います。
- Apps Script エディタから、[リソース] > [Google の拡張サービス] に移動します。
- 使用可能なサービスのリストで、キャンペーン マネージャー 360 API を探します。
- バージョンのプルダウンで、キャンペーン マネージャー 360 API のバージョンを変更します。
- [OK] をクリックして変更を保存します。
C#
.NET の Google API クライアント ライブラリは、Campaign Manager 360 API の各バージョンに対して別々のビルドが提供され、NuGet を通じて配信されます。使用する API バージョンに対応するクライアント ライブラリのバージョンに更新します。
インストール手順やその他のダウンロード方法について詳しくは、クライアント ライブラリのドキュメントをご覧ください。
Java
Java の Google API クライアント ライブラリは、Campaign Manager 360 API の各バージョンに対して別々のビルドが提供され、Maven を通じて配信されます。使用する API バージョンに対応するクライアント ライブラリのバージョンに更新します。
インストール手順やその他のダウンロード方法について詳しくは、クライアント ライブラリのドキュメントをご覧ください。
PHP
PHP の Google API クライアント ライブラリは、Campaign Manager 360 API の各バージョンに対して別々のビルドが提供され、Packagist を通じて配信されます。使用する API バージョンに対応するクライアント ライブラリのバージョンに更新します。
インストール手順やその他のダウンロード方法について詳しくは、クライアント ライブラリのドキュメントをご覧ください。
Python
Python(v1/v2)の Google API クライアント ライブラリでは、どのビルドもキャンペーン マネージャー 360 API の全バージョンに対応しています。キャンペーン マネージャー 360 API の新しいバージョンに移行するには、discovery ビルダーの引数として渡すバージョンの文字列を更新します。
discovery.build('dfareporting', 'v3.4', http=http)
Ruby
Ruby v0.8 以下の Google API クライアント ライブラリは、キャンペーン マネージャー 360 API の全バージョンに対応しています。キャンペーン マネージャー 360 API の新しいバージョンに移行するには、サービス コンストラクタの引数として渡すバージョンの文字列を更新します。
service = Google::APIClient::Service.new("dfareporting", "v3.4", { :application_name => "My application", :application_version => '1.0.0', :authorization => authorization } )
REST
HTTPS を使用して API を直接呼び出している場合は、リクエストのエンドポイントを更新して、新しい API バージョン番号を使用します。
たとえば、v4 から v5 に移行する場合は、ベース URL を次のように変更します。
https://dfareporting.googleapis.com/dfareporting/v4/...
https://dfareporting.googleapis.com/dfareporting/v5/...
ステップ 4: バージョン間の違いに対処する
新しい API バージョンは、可能な限り下位互換性があるように設計されています。ただし、一部の更新には、コードの変更が必要になる非互換の変更が含まれている場合があります。これらの変更については、リリースノートで詳しく説明しています。
移行する際は、現在のバージョンとアップグレード先のバージョンの間の各バージョンのリリースノートを確認してください。次のセクションには特に注意してください。
- 新機能: 新しく追加された機能です。これらは移行のためのコード変更を必要としません。
- 廃止: API から削除された機能。利用可能な場合は、代替機能が記載されています。
- 既知の問題: 名前が変更されたフィールドやメソッド、変更された検証ロジックなど、既存の機能の変更。
アプリケーションが廃止または報告されている問題のセクションに記載されている機能を使用している場合は、コードを更新して変更に対処する必要があります。
最新情報を入手する
Google Ads デベロッパー ブログを定期的に確認して、API のリリース、非推奨、終了に関する情報をいち早く入手してください。