バージョン管理と非推奨化

APIのバージョン管理、変更の提供、互換性を損なう変更や削除に先立つ通知について説明します。

APIとSDKのバージョン

REST APIのバージョンはパスの/v1で指定します。バージョンヘッダーはありません。/mcpのMCPは、独自のプロトコルバージョンをネゴシエーションします。

SDKパッケージのバージョンは、APIのバージョンとは別です。

/v1では、エンドポイントやMCPツール、データセット、対象国やカバレッジ、既存の動作を維持する任意入力を追加できます。これらの変更は、予告なく随時提供する場合があります。

任意のレスポンスフィールドやnullを許容するレスポンスフィールド、レスポンスの列挙型の新しい値も、予告なく追加する場合があります。これらの変更は変更履歴に記載します。

クライアントは未知のフィールドを無視し、未知の列挙値を受け入れるようにしてください。当社のSDKはすでにこの動作に対応しています。

フィールドの削除や名前の変更は、互換性を損なう変更です。型、意味、単位、精度、必須かどうかの変更も同様です。

ルートやメソッド、認証、認可、クォータ、既定の動作の変更も、互換性を損なう変更です。

互換性を損なう変更は、新しいパスや操作、または新しいメジャーバージョンとして提供します。既存のものを告知なく変更することはありません。

互換性を損なう変更や削除が、過去90日間にお客様のアカウントが呼び出したエンドポイントやフィールドに影響する場合、適用の少なくとも3か月前にお知らせします。メールと変更履歴で通知します。

過去90日間にどのアカウントからも呼び出されていないエンドポイントやフィールドは、より短い通知期間で削除する場合があります。これらの削除は変更履歴で告知します。

変更は、変更履歴とそのRSSフィードで告知します。

経済イベントのevent_typeフィールドは、typeの非推奨エイリアスです。typeを使用してください。

削除日は未定です。削除日を決める際は、上記の通知方針に従います。