Microsoft Graph のユーザー構成 API を使用すると、アプリケーションはフォルダーごとの構成データを、Exchange Online メールボックスの内容と共に格納および取得できます。 userConfiguration オブジェクト (フォルダーに関連付けられたアイテム、FAI) は、特定のメール フォルダーに関連付けられ、そのフォルダー内で一意のキーによって識別されます。 各オブジェクトは、メールボックス全体ではなく 1 つのフォルダーに適用されます。 このスコープを使用すると、アプリは関連するコンテンツに近い状態を維持できます。
この API は、 アプリに userConfiguration オブジェクトの完全な作成、読み取り、更新、削除制御を提供し、シナリオに最適な形式 (任意のバイナリ データ、シリアル化された XML、または厳密に型指定されたキーと値のペア) を格納できる複数のペイロード スタイルをサポートします。
ユーザー構成 API と統合する理由
フォルダーごとのアプリケーションの状態と設定を格納する
多くのアプリケーションでは、特定のメール フォルダーに関連する設定や状態を保持するために信頼性の高い場所が必要です。 たとえば、受信トレイ同期ツールの最後に同期された項目 ID、カスタム フォルダーのビュー設定、またはフォルダーをスコープとする機能フラグなどがあります。 ユーザー構成 API は、アプリにこの種のデータの専用のメールボックス常駐ストレージの場所を提供するため、別の外部ストアを管理する必要はありません。
メールボックスのコンテンツと共にアプリ メタデータを保持する
ユーザー構成オブジェクトは、メールボックス内に住んでいます。 その結果、データは関連するコンテンツの近くに位置し、ユーザーの他のメールボックス コンテンツを保護するのと同じアクセス制御もこのデータを保護します。 このストレージ パターンにより、API は特定のフォルダーに関連付けられた状態を維持する必要があるアプリ メタデータに適しています。
データに合ったペイロード スタイルを選択する
userConfiguration リソースでは、次の 3 つのペイロード プロパティがサポートされており、シナリオに適した形状を選択できます。
- 任意のバイナリ コンテンツには binaryData を使用します。
- シリアル化された XML には xmlData を使用します。
- structuredData を使用して、独自の形式をシリアル化せずに、型指定されたキーと値のペアを格納します。 structuredDataEntry および structuredDataEntryTypedValue 複合型は、サポートされている値型をモデル化します。
1 つの userConfiguration オブジェクトは、これらのプロパティの任意の組み合わせを保持できます。 アプリの進化に合わせてペイロード スタイルを混在させることができます。
API リファレンス
このサービスの API リファレンスをお探しですか? userConfiguration リソースの種類とそのサポートされているメソッドを参照してください。
次の手順
- userConfiguration リソースの種類とサポートされているメソッド (作成、取得、更新、削除) を調べます。
- Graph エクスプローラーでユーザー構成 API を試してください。