デジタル プラットフォーム API - 大きな変更点

API は絶えず変化しています。 ほとんどの変更は単に新機能を追加するだけですが、場合によっては重大 な変更 が導入されるため、統合の調整が必要になる場合があります。

このページでは、API の大きな変更と見なされる変更について説明します。 また、重大な変更に該当しない変更の例も示します。

重要

Microsoft は、バグを修正し、 サービス ポリシーの一部 と法的義務に準拠するために機能を調整し、アルファ版およびベータ版の機能と製品を変更する権利を、早期通知なしに留保します。

大きな変更点

次の種類の変更は、重大な変更の対象となります。

  • フィールドの削除
  • フィールドを [必須以外] から [必須] に変更しました
  • 新しい入力規則の追加
  • フィールドのデータ型の変更 (ID の配列をオブジェクトの配列に変換するなど)
  • 要求の調整の変更
  • 応答によって返されるオブジェクト数の減少

API に重大な変更を導入する場合、運用環境では 2 つのバージョンの API (重大な変更のあるバージョンとないバージョン) を 60 日間サポートします。 また、これらの変更と、重大な変更期間中に各バージョンに正しく到達する方法について API ユーザーに通知します。 ユーザー アカウントで API が有効になっている場合は、重大な変更に関する通知を自動的に受信します。

重大でない変更の例

次の種類の変更は、破壊的変更とは見なされません。 このリストはすべてを網羅していないことに注意してください。これらは、重大でない変更のほんの一部例です。

  • 新しい非必須フィールドの追加
  • 新しいサービスの追加
  • レポートへのメトリック/ディメンションの追加
  • 新しいレポート タイプの追加
  • フィールドを削除せずに非推奨にする
  • 許可される同時レポート数の減少または増加
  • ログレベルのデータ フィードのいずれかに新しいフィールドを追加する
  • オブジェクト内のフィールド、配列内のオブジェクトなどの順序の変更