Search Ads 360 Reporting API では、セマンティック バージョニングが使用されます。
メジャー バージョンとマイナー バージョンがあり、形式は vMAJOR_MINOR
です。たとえば、v0_0
が最初のメジャー バージョンで、v0_1
が最初のマイナー バージョンです。バージョン番号のサフィックスはバージョン タイプを示します。メジャー バージョンの場合は常にゼロ、マイナー バージョンの場合は常に 0 より大きくなります。
メジャー バージョン
メジャー リリースでは、互換性を破る変更(下位互換性のない変更)が導入されます。
各メジャー バージョンには、次のように個別のエンドポイントがあります。
https://searchads360.googleapis.com/v0 https://searchads360.googleapis.com/v1
あるメジャー バージョンから別のメジャー バージョンにアップグレードする場合、新しいメジャー バージョンのエンドポイントに切り替える前に、コードの変更が必要になることがあります。
クライアント ライブラリを使用している場合は、最新バージョンにアップグレードする必要があります。新しいメジャー バージョンでは、コードに互換性を破る変更の修正に役立つ移行ガイドを提供しています。
互換性を破る変更の例:
- サービス、インターフェース、フィールド、メソッド、列挙値の削除または名前の変更。
- フィールドのタイプの変更。
- リソース名の形式の変更。
- HTTP 定義の URL 形式の変更。
- 出力形式を変更する(例:
0
をデフォルト値の--
に変更する)。 - 返されたエラーの理由を A から B に変更する。
マイナー バージョン
マイナー バージョンでは、下位互換性のある変更のみが導入されます。
マイナー バージョンがリリースされると、すでに使用されているエンドポイントが自動的に更新されます。これによってコードが破損することはありません。既存のクライアント ライブラリは引き続き使用できます。
マイナー バージョンには、既存のコードに影響しない新機能や更新が含まれます。新機能を使用する場合は、クライアント ライブラリを最新バージョンにアップグレードする必要があります。
日の入り
旧バージョンの Search Ads 360 Reporting API の廃止が予定されている場合は、Google グループに searchads-api-announcements の通知を投稿します。