バージョニング

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

Google Ads API は、メジャー バージョンとマイナー バージョンがあるセマンティック バージョニングに準拠しています。バージョンの形式は MAJOR.MINOR または vMAJOR_MINOR です。たとえば、v18_0 はメジャー バージョンで、v18_1 はマイナー バージョンです。

過去のバージョンについては、リリースノートをご覧ください。

メジャー バージョン

メジャー リリース バージョンでは、下位互換性のない破壊的変更が導入されます。バージョンは vX_0 の形式でゼロで終わります。ここで、X はメジャー バージョン番号です。

各メジャー バージョンには個別のエンドポイントがあります。次の URL の例では、X はメジャー バージョン番号です。

https://googleads.googleapis.com/vX

古いメジャー バージョンからアップグレードする場合は、新しいメジャー バージョンのエンドポイントに切り替える際にコードを変更しなければならない場合があります。Google のクライアント ライブラリを使用している場合は、最新バージョンにアップグレードしてください。メジャー バージョンがリリースされると、コードの破壊的変更を修正するために確認すべき移行ガイドが提供されます。

互換性を損なう変更の例としては、次のようなものが挙げられます。

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

マイナー バージョン

マイナー バージョンでは、下位互換性のある変更のみが導入されます。マイナー バージョンの場合、vMAJOR_MINORMINOR 番号は 0 より大きい値になります。

マイナー バージョンがリリースされると、すでに使用されているエンドポイントは自動的に更新されます。コードが破損することはありません。既存のクライアント ライブラリは引き続き使用できます。

マイナー バージョンには、既存のコードに影響しない新機能や更新が含まれています。これらの新機能を利用する場合は、クライアント ライブラリを最新バージョンにアップグレードしてください。

廃止

古いバージョンの Google Ads API は、定期的にサポートを終了する必要があります。バージョンのサポートが終了する直前に、デベロッパー ブログに通知を投稿します。サポート終了スケジュールが更新され、今後の廃止日が追加されました。