新しいバージョンに移行する

キャンペーン マネージャー 360 API の新しいバージョンが定期的にリリースされています。新しいバージョンがリリースされると、古いバージョンは非推奨になり、最終的には廃止されます。バージョンが廃止されると、そのバージョンに対するすべてのリクエストでエラーが返されるようになります。

使用している API のバージョンが非推奨になった場合は、廃止日より前に新しいバージョンに移行する必要があります。このガイドでは、使用している API バージョンが非推奨かどうかを判断する方法と、推奨される移行手順について説明します。

ステップ 1: 使用しているバージョンを確認する

サポートが終了したキャンペーン マネージャー 360 API を使用している可能性があるアプリケーションのメンテナンスを行う場合は、まず使用しているバージョンをご確認ください。ほとんどの場合、API には言語固有のクライアント ライブラリ、または公式の統合を介してアクセスできます。これらのクライアント ライブラリと統合で使用されている API バージョンを確認する手順については、以下をご覧ください。

Apps Script の新しいエディタ

Apps Script のバージョン情報は、詳細サービスのダイアログで公開されます。

1. Apps Script エディタで、サービスを追加アイコン をクリックします。
2. 利用可能なサービスのリストから、Campaign Manager 360 API を見つけます。
3. バージョンのプルダウンで選択された値は、現在使用されているキャンペーン マネージャー 360 API のバージョンです。

Apps Script の以前のエディタ

Apps Script のバージョン情報は、詳細サービスのダイアログで公開されます。

1. Apps Script エディタから、[リソース] > [高度な Google サービス] に移動します。
2. 利用可能なサービスのリストから、Campaign Manager 360 API を見つけます。
3. バージョンのプルダウンで選択された値は、現在使用されているキャンペーン マネージャー 360 API のバージョンです。

C#

.NET の Google API クライアント ライブラリのバージョン情報は、次の場所に公開されています。

1. nuget のパッケージ名とサービスの名前空間に含まれています。

   Google.Apis.Dfareporting.v3_4

2. DfareportingService の公開プロパティを介して公開されます。

   Console.WriteLine(DfareportingService.Version);

Java

Java の Google API クライアント ライブラリのバージョン情報は、次の場所に公開されています。

1. Maven artifactId で指定します。

   <dependency>
     <groupId>com.google.apis</groupId>
     <artifactId>google-api-services-dfareporting</artifactId>
     <version>v3.4-rev1-1.21.0</version>
   </dependency>

2. JAR ファイル名に含まれています。

   google-api-services-dfareporting-v3.4-rev1-1.21.0.jar

3. Dfareporting の公開プロパティを介して公開されます。

   System.out.println(Dfareporting.DEFAULT_SERVICE_PATH);

PHP

PHP の Google API クライアント ライブラリのバージョン情報は、Google_Service_Dfareporting のパブリック プロパティを介して公開されます。

$service = new Google_Service_Dfareporting($client)
print $service->version;

Python

Python 用 Google API クライアント ライブラリはバージョン管理されていません。使用する API バージョンは、検出ビルダーの引数として指定されます。

discovery.build('dfareporting', 'v3.4', http=http)

Ruby

Ruby バージョン 0.9 未満の Google API クライアント ライブラリはバージョン管理されていません。使用する API バージョンは、サービス コンストラクタの引数として指定されます。

service = Google::APIClient::Service.new("dfareporting", "v3.4",
    {
      :application_name => "My application",
      :application_version => '1.0.0',
      :authorization => authorization
    }
)

0.9 以上の Ruby 用 Google API クライアント ライブラリの場合、バージョンはサービスの名前空間

Google.Apis.DfareportingV3_4

で公開されます。

使用しているバージョンはメモしておきます。この情報は後で必要になります。

ステップ 2: バージョンのステータスを確認する

非推奨スケジュールには、現在サポートされているすべてのバージョンのステータスが一覧表示されます。このリストから目的のバージョンを見つけて、ステータスを確認します。手順は次のとおりです。

1. [非推奨日] 列と [廃止日] 列に日付が表示されていない場合は、完全にサポートされているバージョンが使用されています。
2. 日付がある場合、使用しているバージョンのサポートが終了し、指定した日付に廃止されます。
3. 記載されていないバージョンはすでにサポートが終了しており、サポートが終了しています。

上記 2 または 3 に該当する場合は、サービスが中断することのないように、新しいバージョンに移行する必要があります。非推奨スケジュールの表の上部に表示される最新バージョン（ベータ版リリースを除く）に移行することをおすすめします。これにより、アップグレード間の最大期間を確保できます。

ステップ 3: バージョンをアップグレードする

移行が必要と判断した場合は、統合を更新するか、必要なクライアント ライブラリの更新されたビルドを入手します。クライアント ライブラリの中には、どの API バージョンでも機能する単一のビルドしか提供しないものと、バージョンごとに個別のビルドを提供するものがあります。以下のリストは、最も幅広く使用されているクライアント ライブラリと統合のための一般的なアップグレード情報です。

Apps Script の新しいエディタ

Google Apps Script はキャンペーン マネージャー 360 API のすべてのバージョンをサポートし、スクリプトごとに使用するバージョンを選択できます。特定のスクリプトで使用するバージョンを変更するには:

1. Apps Script エディタで、サービスを追加アイコン をクリックします。
2. 利用可能なサービスのリストから、Campaign Manager 360 API を見つけます。
3. 使用するキャンペーン マネージャー 360 API のバージョンを変更するには、バージョンのプルダウンを使用します。
4. [追加] をクリックして変更内容を保存します。

Apps Script の以前のエディタ

Google Apps Script はキャンペーン マネージャー 360 API のすべてのバージョンをサポートし、スクリプトごとに使用するバージョンを選択できます。特定のスクリプトで使用するバージョンを変更するには:

1. Apps Script エディタから、[リソース] > [高度な Google サービス] に移動します。
2. 利用可能なサービスのリストから、Campaign Manager 360 API を見つけます。
3. 使用するキャンペーン マネージャー 360 API のバージョンを変更するには、バージョンのプルダウンを使用します。
4. [OK] をクリックして変更を保存します。

C#

.NET の Google API クライアント ライブラリでは、Campaign Manager 360 API のバージョンごとに個別のビルドが提供され、Nuget で配布されます。

インストール手順やその他の代替ダウンロード オプションについては、クライアント ライブラリのドキュメントをご覧ください。

Java

Java 用 Google API クライアント ライブラリでは、キャンペーン マネージャー 360 API のバージョンごとに個別のビルドが提供され、Maven を介して配布されます。

インストール手順やその他の代替ダウンロード オプションについては、クライアント ライブラリのドキュメントをご覧ください。

PHP

PHP 用 Google API クライアント ライブラリでは、Campaign Manager 360 API の各バージョンに対して別々のビルドが提供され、Packagist を介して配信されます。

インストール手順やその他の代替ダウンロード オプションについては、クライアント ライブラリのドキュメントをご覧ください。

Python

Python の Google API クライアント ライブラリでは、すべてのビルドでキャンペーン マネージャー 360 API のすべてのバージョンがサポートされています。単に、ディスカバリ ビルダーに引数として渡されるバージョン文字列を更新します。

discovery.build('dfareporting', 'v3.4', http=http)

インストール手順やその他のダウンロード オプションの詳細については、クライアント ライブラリのドキュメントをご覧ください。

Ruby

Ruby v0.8 以前の Google API クライアント ライブラリは、Campaign Manager 360 API のすべてのバージョンに対応しています。サービス コンストラクタに引数として渡されているバージョン文字列を更新するだけです。

service = Google::APIClient::Service.new("dfareporting", "v3.4",
    {
      :application_name => "My application",
      :application_version => '1.0.0',
      :authorization => authorization
    }
)

Google API クライアント ライブラリ（Ruby v0.9 以降用）は、キャンペーン マネージャー 360 API の各バージョンに対して個別のビルドを作成し、RubyGems を介して配布します。 インストール手順やその他の代替ダウンロード オプションについては、クライアント ライブラリのドキュメントをご覧ください。

ステップ 4: バージョンの違いに対処する

Google は新しいリリースを下位互換性のあるものにすることを目指しています。つまり、API バージョン間で移行する場合、コードを変更する必要はありません。それが不可能な場合は、デベロッパーによる対応が必要な変更（互換性を破る変更）をリリースノートでお知らせします。

この時点で、リリースノートは以前のバージョンでメモしたバージョンから始まり、アップグレードするバージョンまでとなっています。リリースノートのセクションは、次のように解釈されます。

• 新機能 - 新しく追加された機能。
• サポート終了 - API から削除された機能。利用可能な場合は、交換機能についてこのセクションで説明します。
• 既知の問題 - 追加または削除ではない変更です。たとえば、名前を変更したフィールドやメソッド、変更された検証ロジックなどです。

新機能ではコードを変更する必要がないため、ここでは無視して構いません。このセクションを後ほどお試しください。

一方、[廃止] セクションまたは [既知の問題] セクションで変更が見つかった場合は、対応が必要になることがあります。コードを検索して、削除または変更された機能がアプリケーションで使用されているかどうかを確認してください。その場合は、コードを更新して変更に対処する必要があります。

最新情報を入手する

前述のように、キャンペーン マネージャー 360 API のリリースと廃止は定期的に行われます。新しいリリース、非推奨、廃止に関する情報は、次のチャンネルに投稿されます。

• Google 広告デベロッパー ブログ（メール通知アラートの登録）
• Campaign Manager 360 API フォーラム

1 つ以上のチャンネルに登録して、API に関する最新の情報を確認することをおすすめします。