バージョン管理

Partner API のバージョンは URL で指定します。現在のバージョンは次のとおりです。

https://partner-api.performancehub.co/partner/v1/

変更ポリシー

Performance Hub は、可能な限り、追加的で後方互換性のある変更を行うよう努めています。

後方互換性のある変更の例:

• リクエストに新しい省略可能なフィールドを追加する。
• レスポンスに新しいフィールドを追加する。
• 新しいエンドポイントを追加する。
• クライアントが不明な値を処理することが想定される列挙型に、新しい値を追加する。
• ステータスコードの仕様を変えずに、検証メッセージを改善する。

access_time_windows と access_time_windows_revision は、会員リクエストに追加されたフィールドです。これらを省略する既存のクライアントでは、保存済みの Access Time Window のスナップショットは変更されません。この省略のルールにより、部分的なアップサートとの互換性が保たれます。省略することは、空の配列を送信することと同じではありません。

互換性を損なう変更の例:

• フィールドを削除する、または名前を変更する。
• フィールドの型を変更する。
• 省略可能なリクエストフィールドを必須にする。
• エンドポイントを削除する。
• 既存のステータスコードやドメイン固有の reason の意味を変更する。

非推奨化

互換性を損なう変更が必要な場合、Performance Hub は可能な限り既存のバージョンをそのまま変更することを避けます。代わりに、新しいバージョンまたは移行手段を導入し、影響を受けるパートナーに変更をお知らせします。

非推奨化の通知には、次のものが含まれる場合があります。

• 変更履歴の項目。
• パートナーへの直接の連絡。
• Partner Console での注記。
• ドキュメントでの移行ガイダンス。

クライアントに関する推奨事項

追加的な変更に対応できるクライアントを構築してください。

• 使用しないレスポンスフィールドは無視する。
• 不明な列挙値は、クラッシュさせずにサポート対象外として扱う。
• レスポンスの厳密な一致チェックを避ける。
• 認識できない値をログに記録し、意図的に連携を更新できるようにする。

Access Time Windows のようにリビジョン管理される会員の区画については、結果が判明するまで、送信したリビジョンと正規化済みのペイロードを保存してください。変更された内容にリビジョンを再利用すると競合になり、同じ内容を再送信した場合は冪等になります。Access Time Windows を参照してください。

OpenAPI 仕様

公開されている OpenAPI 仕様を使用して、クライアントの生成、リクエストの検証、API の形式の変更の追跡を行ってください。

OpenAPI 仕様を参照してください。