セマンティック バージョニング
Google Ads API は、メジャー バージョン番号とマイナー バージョン番号でセマンティック バージョニングに従います。バージョンは MAJOR.MINOR または vMAJOR.MINOR として書き込まれます。たとえば、v25.0(または v25)はメジャー バージョン、v25.1 はマイナー バージョンです。
現在および過去のバージョンについて詳しくは、リリースノートをご覧ください。
メジャー バージョン
メジャー リリース バージョンでは、下位互換性のない変更が導入されます。メジャー バージョンの最初のリリースは 0 で終わります(vX.0 または vX。ここで、X はメジャー バージョン番号です)。
各メジャー バージョンには、マイナー バージョンの接尾辞を含まない個別の REST エンドポイント パスと gRPC エンドポイント パス(vX)があります。次の URL の X は、メジャー バージョン番号です(例: v25)。
https://googleads.googleapis.com/vX
古いメジャー バージョンからアップグレードする場合は、新しいメジャー バージョン エンドポイントに切り替えるときにコードの変更が必要になることがあります。Google のクライアント ライブラリを使用している場合は、新しいメジャー バージョンをサポートするクライアント ライブラリ リリースにアップグレードしてください。メジャー バージョンがリリースされると、コードの破壊的変更を解決するためのアップグレード ガイドが提供されます。
互換性を損なう変更の例としては、次のようなものが挙げられます。
- サービス、インターフェース、フィールド、メソッド、列挙値の削除や名前変更。
- フィールドのタイプを変更する。
- リソース名の形式の変更。
- HTTP 定義での URL 形式の変更。
- デフォルト値の変更など、出力形式の変更。
- A から B に返されるエラー理由を変更します。
マイナー バージョン
マイナー バージョンでは、下位互換性のある変更のみが導入されます。マイナー バージョンの場合、vMAJOR.MINOR の MINOR 番号は 0 より大きい値になります(v25.1 など)。
マイナー バージョンがリリースされると、既存のメジャー バージョンのエンドポイント(https://googleads.googleapis.com/vX)が自動的にインプレースで更新されます。エンドポイント URL のバージョンパスを変更する必要はなく、既存のコードは中断することなく引き続き動作します。
マイナー バージョンでは、既存のコードに影響しない機能や更新が追加されます。クライアント ライブラリでマイナー バージョンのフィールドまたは機能を使用するには、マイナー バージョンの定義を含むリリースにクライアント ライブラリをアップグレードします。
非推奨と廃止
古い Google Ads API バージョンは定期的に非推奨となり、その後廃止されます。
- 非推奨: メジャー バージョン(
v25など)がリリースされると、以前のすべてのメジャー バージョンが非推奨になります。非推奨バージョンへの API 呼び出しは、サービス終了日まで引き続き成功します。既存のクライアント ライブラリ リリースは引き続きサポートされますが、後続のクライアント ライブラリ リリースでは、パッケージ サイズを小さくするために非推奨の API バージョンが省略されます。 - 廃止: バージョンは廃止日に無効になり、そのエンドポイントに対するすべての API 呼び出しが失敗します。
バージョンのサポート終了に先立って、デベロッパー ブログでお知らせを掲載します。有効、非推奨、廃止予定の廃止日については、サポート終了と廃止のスケジュールを確認してください。