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

  • [アーティクル]

名前空間: microsoft.graph

Microsoft Graph のリソースに型指定されていないプロパティを直接追加する簡単な方法を提供する拡張オプションである、オープン拡張機能 (オープン型拡張機能とも呼ばれ、以前は Office 365 データ拡張機能とも呼ばれます) を表します。

リソースに追加されるオープン拡張機能は extensions ナビゲーション プロパティに表示されます。 各拡張機能には、カスタム データと共に、すべての拡張機能に対して定義済みの書き込み可能な唯一の extensionName プロパティがあります。 拡張機能名が必ず一意であるようにする方法の 1 つは、独自のドメインに依存する逆引きドメイン ネーム システム (DNS) 形式 (例: com.contoso.ContactInfo) を使用することです。 拡張機能名に Microsoft ドメイン (com.microsoft または com.onmicrosoft) を使用しないでください。

拡張機能抽象型から派生します。

次のリソースは、オープン拡張機能をサポートしています。

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

オープン拡張機能の制限を含む Microsoft Graph の機能拡張の詳細については、「 拡張機能を使用してリソースにカスタム プロパティを追加する 」と「オープン拡張機能を使用してカスタム データをユーザーに追加する」を参照してください。

Outlook 固有の考慮事項

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

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

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

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

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

メソッド

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

プロパティ

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

ID は、次のいずれかの方法で作成操作中に定義する必要があります。
  • 要求本文で id プロパティを明示的に定義します。
  • 要求本文で extensionName プロパティを定義すると、Microsoft Graph によって id プロパティに同じ値が自動的に割り当てられます。
    • 以降の更新では、 extensionName プロパティの値を id 値とは異なる値に変更できます。
    • 以降の更新では、要求本文で id プロパティのみを指定すると、開いている 拡張機能から extensionName プロパティが自動的に削除されます。

リレーションシップ

なし

JSON 表記

次の JSON 表現は、リソースの種類を示しています。

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

関連コンテンツ