デジタル プラットフォーム API - 破壊的変更

API は絶えず変化しています。 変更の大部分は単に新しい機能を追加するだけですが、統合を調整する必要がある 破壊的変更 が発生することがあります。

このページでは、API の破壊的変更と見なされる変更について説明します。 また、破壊的変更と見なされない変更の例も示します。

重要

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

破壊的変更

次の種類の変更は、破壊的変更と見なされます。

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

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

破壊的でない変更の例

次の種類の変更は、破壊的変更とは見なされません。 このリストは網羅的ではありません。これらは、破壊的でない変更のほんの一例です。

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