新バージョンへの移行

DCM/DFA Reporting and Trafficking API の新バージョンは定期的にリリースされます。新バージョンがリリースされると、それより古いバージョンはサポートが終了し、最終的には廃止されます。あるバージョンが廃止されると、そのバージョンに対するすべてのリクエストにエラーが返されるようになります。

使用している API バージョンのサポートが終了したら、予定されている廃止日までに新しいバージョンに移行する必要があります。このガイドでは、使用している API バージョンのサポートが終了しているかどうかを判断する方法について詳しく説明し、おすすめの移行手順を紹介します。

手順 1: 使用しているバージョンを確認する

アプリケーションで使用している DCM/DFA Reporting and Trafficking API のバージョンのサポートが終了している可能性がある場合、まず使用しているバージョンを確認する必要があります。ほとんどの場合、API へのアクセスには、Google から提供される言語別のクライアント ライブラリまたは公式の統合が使用されます。クライアント ライブラリと統合で使用されている API バージョンを確認する手順を以下に示します。

Apps Script

Apps Script のバージョン情報は、高度なサービス ダイアログにエクスポーズされています。

  1. Apps Script エディタから、[リソース] > [Google の拡張サービス] に移動します。
  2. 使用可能なサービスのリストで、DCM/DFA Reporting and Trafficking API を探します。
  3. バージョンのプルダウンで選択されている値が、現在使用されている DCM/DFA Reporting and Trafficking API のバージョンです。

C#

.NET の Google API クライアント ライブラリのバージョン情報は、以下の場所にエクスポーズされています。

  1. NuGet パッケージ名とサービスの名前空間に含まれています。
    Google.Apis.Dfareporting.v3_2
  2. DfareportingService の public プロパティによりエクスポーズされています。
    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.3-rev1-1.21.0</version>
    </dependency>
  2. JAR ファイル名に含まれています。
    google-api-services-dfareporting-v3.3-rev1-1.21.0.jar
  3. Dfareporting の public プロパティによりエクスポーズされています。
    System.out.println(Dfareporting.DEFAULT_SERVICE_PATH);

PHP

PHP の Google API クライアント ライブラリのバージョン情報は、Google_Client_Dfareporting の public プロパティにエクスポーズされています。

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

Python

Python の Google API クライアント ライブラリにはバージョンがありません。使用する API バージョンは discovery ビルダーの引数として指定されています。

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

Ruby

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

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

Ruby の Google API のクライアント ライブラリで 0.9 以降のバージョンは、サービスの名前空間にエクスポーズされています。

Google.Apis.DfareportingV3_2

使用しているバージョンは後で必要になるので、メモしておいてください。

手順 2: 使用しているバージョンのステータスを判断する

サポート終了スケジュールのリストには、現在サポートされているすべてのバージョンのステータスが表示されています。使用しているバージョンをこのリストで探し、そのステータスを以下のように判断します。

  1. [Deprecation Date] 列と [Sunset Date] 列に日付の記載がないバージョンは、完全にサポートされています。
  2. 日付が記載されているバージョンは現在サポートが終了しており、指定されている日に廃止されます。
  3. リストにないバージョンはすでに廃止されており、サポートされていません。

上記の 2 または 3 に該当する場合、サービスの中断を防ぐために新しいバージョンに移行する必要があります。サポート終了スケジュールのリストの一番上(ベータ版を除く)に記載されている、最新バージョンに移行することをおすすめします。これにより、アップグレードの間隔を最大にすることができます。

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

移行が必要と判断したら、次の手順として、統合を更新するか、または使用したいクライアント ライブラリのビルドの更新版を取得します。クライアント ライブラリには、すべての API バージョンに対応する 1 つのビルドのみが提供されるものと、バージョンごとに別々のビルドが提供されるものがあります。以下では、広く使用されているクライアント ライブラリと統合における一般的なアップグレード情報を紹介します。

Apps Script

Google Apps Script では、DCM/DFA Reporting and Trafficking API の全バージョンがサポートされており、スクリプトごとに使用するバージョンを選択できます。特定のスクリプトで使用されているバージョンを変更するには、次の手順に従います。

  1. Apps Script エディタから、[リソース] > [Google の拡張サービス] に移動します。
  2. 使用可能なサービスのリストで、DCM/DFA Reporting and Trafficking API を探します。
  3. バージョンのプルダウンで、使用する DCM/DFA Reporting and Trafficking API のバージョンを変更します。
  4. [OK] をクリックして変更を保存します。

C#

.NET の Google API クライアント ライブラリでは、DCM/DFA Reporting and Trafficking API の各バージョンに対して別々のビルドが提供され、NuGet を通じて配信されます。

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

Java

Java の Google API クライアント ライブラリでは、DCM/DFA Reporting and Trafficking API の各バージョンに対して別々のビルドが提供され、Maven を通じて配信されます。

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

PHP

PHP の Google API クライアント ライブラリでは、DCM/DFA Reporting and Trafficking API の各バージョンに対して別々のビルドが提供され、Packagist を通じて配信されます。

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

Python

Python の Google API クライアント ライブラリでは、どのビルドも DCM/DFA Reporting and Trafficking API の全バージョンに対応しています。discovery ビルダーの引数として渡すバージョン文字列を変更するだけでアップグレードできます。

discovery.build('dfareporting', 'v3.3', http=http)
インストール手順やその他のダウンロード方法について詳しくは、クライアント ライブラリのドキュメントをご覧ください。

Ruby

Ruby v0.8 以下の Google API クライアント ライブラリは、DCM/DFA Reporting and Trafficking API の全バージョンに対応しています。サービス コンストラクタの引数として渡すバージョン文字列を変更するだけでアップグレードできます。

service = Google::APIClient::Service.new("dfareporting", "v3.3",
    {
      :application_name => "My application",
      :application_version => '1.0.0',
      :authorization => authorization
    }
)
Ruby v0.9 以上の Google API クライアント ライブラリでは、DCM/DFA Reporting and Trafficking API の各バージョンに対して別々のビルドが提供され、RubyGems を通じて配信されます。インストール手順やその他のダウンロード方法について詳しくは、クライアント ライブラリのドキュメントをご覧ください。

手順 4: バージョン間の違いに対処する

Google では、API バージョンの移行に際してコードの変更が不要となるよう、新しいリリースの後方互換性の維持に努めています。後方互換性を維持できない場合は、デベロッパー側で対処が必要な変更(破壊的変更)としてリリースノートでお知らせします。

Google のリリースノートを確認します。移行前のバージョン(前の手順でメモしたもの)の次のバージョンから、移行先のバージョンまでをご確認ください。リリースノートのセクションは次のように解釈します。

  • 新機能 - 新しく追加された機能です。
  • 廃止 - API から削除された機能です。代替機能がある場合は、このセクションで説明されています。
  • 報告されている問題 - 追加、削除のいずれにも該当しない変更です。たとえば、名前が変更されたフィールドやメソッド、変更された検証ロジックなどが記載されます。

新機能についてはコードの変更は不要で、ここでは無視できます。後でこのセクションに戻り、追加された機能を試してみることをおすすめします。

一方、廃止報告されている問題のセクションに変更が記載されている場合、対処が必要になることがあります。ご自分のアプリケーション コードをすべて検索して、削除または変更された機能を使用しているかどうかを確認する必要があります。使用している場合、コードを更新して変更に対処してください。

最新情報を入手する

前述のように、DCM/DFA Reporting and Trafficking API のリリースと廃止は定期的に行われます。新しいリリース、サポート終了、廃止についての最新情報は以下のチャネルに掲載されます。

上記のチャネルに登録して、最新の API ニュースを入手することをおすすめします。