バージョニング

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

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

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

メジャー バージョン

メジャー リリース バージョンでは、下位互換性のない互換性のない変更が行われます。バージョン番号の末尾は vX_0 で、X はメジャー バージョン番号です。

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

https://googleads.googleapis.com/vX

古いメジャー バージョンからアップグレードする場合は、新しいメジャー バージョン エンドポイントに切り替えるときにコードの変更が必要になることがあります。クライアント ライブラリを使用している場合は、最新バージョンにアップグレードします。メジャー バージョンがリリースされた場合、移行ガイドも用意されています。これにより、コードに互換性のない変更が行われた場合に、それを解決できます。

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

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

マイナー バージョン

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

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

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

日の入り

Google Ads API の古いバージョンは定期的に廃止する必要があります。バージョンが廃止される際には、デベロッパー ブログでお知らせします。サポート終了スケジュールは将来の廃止日に合わせて更新されます。