バージョニング

セマンティック バージョニング

Google Ads API は、メジャー バージョン番号とマイナー バージョン番号を使用したセマンティック バージョニングに従います。バージョンは MAJOR.MINOR または vMAJOR.MINOR として記述されます。たとえば、v26.0(または v26)はメジャー バージョンで、v26.1 はマイナー バージョンです。

現在および過去のバージョンについて詳しくは、リリースノートをご覧ください。

メジャー バージョン

メジャー リリース バージョンでは、下位互換性のない変更が導入されます。メジャー バージョンの最初のリリースは 0 で終わります(vX.0 または vX。X はメジャー バージョン番号)。

各メジャー バージョンには、個別の REST エンドポイント パスと gRPC エンドポイント パス(vX)があります。これには、マイナー バージョンのサフィックスは含まれません。次の URL で、X はメジャー バージョン番号です(例: v26)。

https://googleads.googleapis.com/vX

古いメジャー バージョンからアップグレードする場合は、新しいメジャー バージョンのエンドポイントに切り替えるときにコードの変更が必要になることがあります。クライアント ライブラリを使用している場合は、新しいメジャー バージョンをサポートするクライアント ライブラリ リリースにアップグレードします。メジャー バージョンがリリースされると、コードの互換性を破る変更を解決するのに役立つアップグレード ガイドが提供されます。

互換性を破る変更の例を以下に示します。

  • サービス、インターフェース、フィールド、メソッド、列挙値の削除や名前変更。
  • フィールドのタイプの変更。
  • リソース名の形式の変更。
  • HTTP 定義での URL 形式の変更。
  • 出力形式の変更(デフォルト値の変更など)。
  • 返されるエラーの理由を A から B に変更する。

マイナー バージョン

マイナー バージョンでは、下位互換性のある変更のみが導入されます。マイナー バージョンの場合、vMAJOR.MINOR の MINOR 番号は 0 より大きくなります(例: v26.1)。

マイナー バージョンがリリースされると、既存のメジャー バージョンのエンドポイント(https://googleads.googleapis.com/vX)が自動的に更新されます。エンドポイント URL のバージョンパスを変更する必要はなく、既存のコードは引き続き機能します。

マイナー バージョンでは、既存のコードに影響しない機能やアップデートが追加されます。クライアント ライブラリでマイナー バージョンのフィールドまたは機能を使用するには、マイナー バージョンの定義を含むリリースにクライアント ライブラリをアップグレードします。

サポート終了と廃止

Google Ads API の古いバージョンは、定期的にサポートが終了し、その後廃止されます。

  • 非推奨: メジャー バージョン(v26 など)がリリースされると、それ以前のすべてのメジャー バージョンは非推奨としてマークされます。非推奨のバージョンに対する API 呼び出しは、サポート終了日まで引き続き成功します。既存のクライアント ライブラリ リリースでも引き続きサポートされますが、それ以降のクライアント ライブラリ リリースでは、パッケージ サイズを縮小するために非推奨の API バージョンが省略されます。
  • 廃止: バージョンは廃止日に無効になり、そのエンドポイントへのすべての API 呼び出しが失敗します。

バージョンのサポート終了に先立って、デベロッパー ブログでお知らせを投稿します。有効な日付、サポート終了日、廃止予定日については、サポート終了と廃止のスケジュールをご覧ください。