openTypeExtension リソース タイプ (オープン拡張機能)

名前空間: microsoft.graph

オープン拡張 (旧称は Office 365 のデータ拡張機能) を使用すると、型指定されていないプロパティを Microsoft Graph のリソースに簡単に直接追加できます。

オープン拡張機能は、openTypeExtension リソースで表されます。 リソースに追加されるオープン拡張機能は extensions ナビゲーション プロパティに表示されます。このプロパティは、extension 抽象型から派生します。 各拡張機能には extensionName プロパティがあります。このプロパティは、すべての拡張機能とカスタム データで唯一定義済みの書き込み可能なプロパティです。

拡張機能名が一意であることの確認に役立つ方法の 1 つは、例えば、独自のドメイン に依存する逆引きドメイン ネーム システム (DNS) 形式を使用することです com.contoso.ContactInfoMicrosoft ドメイン (com.microsoftまたはcom.onmicrosoft)拡張機能名には使用しないでください。

オープン拡張機能の例:オープン拡張機能を使用したユーザーへのカスタム データの追加

オープン拡張機能は、次のリソースの対応するバージョンの一般状態 ( /v1.0 ) またはプレビュー (/ベータ) でサポートされています。

リソース バージョン
管理単位 GA
予定表イベント * GA
グループ予定表イベント GA
グループ会話スレッド投稿 GA
device GA
グループ GA
メッセージ GA
組織 GA
個人用連絡先 GA
ユーザー GA
To Do タスク GA
To Do タスクリスト GA

*メモ: 既存のサービスの制限により、代理人は共有メールボックス 予定表でオープン拡張追加イベントを作成することはできません。 これを試みると、ErrorAccessDenied応答が返されます。

Outlook 固有の考慮事項

Outlook リソース (イベント、メッセージ、個人用連絡先) に存在する各オープン拡張は、MAPI 名前付きプロパティに保存されます。 Outlook のオープン拡張を作成する場合は、MAPI 名前付きプロパティがユーザーのメールボックスで有限のリソースであることを考慮してください。 ユーザーの名前付きプロパティのクォータがすべて使用されると、それ以上、そのユーザーに対して名前付きのプロパティを作成することはできません。 これにより、機能する名前付きプロパティに依存しているクライアントから、予期しない動作が発生する可能性があります。

Outlook リソースのオープン拡張を作成する場合は、次のガイドラインを適用します。

  • 必要な拡張機能の最小数を作成します。 ほとんどのアプリケーションで必要な拡張機能は、1 つのみです。 拡張機能には、定義済みのプロパティや構造体が設定されていないため、1 つの拡張機能に複数の値を保存できます。
  • 拡張機能には変更可能な方法 (ユーザー入力に基づくなど) で名前を付けないでください。 ユーザーのメールボックスで以前に使用されていない新しい名前でオープン拡張が作成されるたびに、新しい MAPI 名前付きプロパティが作成されます。 拡張機能を削除しても、名前付きプロパティは削除されません。

オープン拡張 (Outlook リソース用) または拡張プロパティを使用する

オープン拡張機能は、カスタム データの格納およびカスタムデータへのアクセスを必要とするほとんどのシナリオに対して推奨される解です。ただし、拡張プロパティとこの REST API は、Microsoft Graph API のメタデータを通じてまだ公開されていない Outlook MAPI プロパティのカスタム データにアクセスする必要がある場合に使用できます。メタデータが公開するプロパティは、https://graph.microsoft.com/v1.0/$metadata で確認できます。

JSON 表記

以下は、リソースの JSON 表記です。

{
  "extensionName": "string",
  "id": "string (identifier)"
}

プロパティ

プロパティ 説明
extensionName String オープン型のオープン拡張機能の一意のテキスト識別子。必須。
id String extensionName と拡張子タイプを連結する完全修飾識別子。読み取り専用。

リレーションシップ

なし

メソッド

メソッド 戻り値の型 説明
Create (既存リソースのインスタンス内の) openTypeExtension、または、openTypeExtension オブジェクトを含む新しいcontacteventmessageposttodoTasktodoTaskList 既存または新規のリソース インスタンス内に openTypeExtension オブジェクトを作成します。
Get openTypeExtension openTypeExtension オブジェクトのプロパティと関係を読み取ります。
Update openTypeExtension openTypeExtension オブジェクトを更新します。
Delete なし openTypeExtension オブジェクトを削除します。