Search Ads 360 Reporting API のバージョニング

Search Ads 360 Reporting API はセマンティック バージョニングを使用します。

メジャー バージョンとマイナー バージョンがあり、vMAJOR_MINOR の形式で指定します。たとえば、v0_0 は最初のメジャー バージョンで、v0_1 は最初のマイナー バージョンです。バージョン番号の接尾辞はバージョン タイプを示します。メジャー バージョンの場合は常に 0、マイナー バージョンの場合は常に 0 より大きくなります。

メジャー バージョン

メジャー リリースでは、互換性を損なう変更が導入されます。

各メジャー バージョンには個別のエンドポイントがあります。次に例を示します。

https://searchads360.googleapis.com/v0

https://searchads360.googleapis.com/v1

メジャー バージョンから別のメジャー バージョンにアップグレードする場合は、新しいメジャー バージョンのエンドポイントに切り替える前にコードを変更する必要があります。

クライアント ライブラリを使用している場合は、最新バージョンにアップグレードする必要があります。新しいメジャー バージョンには、コードの互換性を損なう変更を修正するのに役立つ移行ガイドが用意されています。

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

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

マイナー バージョン

マイナー バージョンでは、下位互換性のある変更のみが導入されます。

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

マイナー バージョンには、既存のコードに影響しない新機能や更新が含まれます。新機能を使用するには、クライアント ライブラリを最新バージョンにアップグレードする必要があります。

廃止

以前のバージョンの Search Ads 360 Reporting API のサポートが終了する予定の場合は、searchads-api-announcements Google グループに通知が投稿されます。