openTypeExtension リソース タイプ (オープン拡張)openTypeExtension resource type (open extensions)

重要

Microsoft Graph の/betaバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでは、これらの API の使用はサポートされていません。Use of these APIs in production applications is not supported.

オープン拡張 (旧称は Office 365 のデータ拡張機能) を使用すると、型指定されていないプロパティを Microsoft Graph のリソースに簡単に直接追加できます。Open extensions (formerly known as Office 365 data extensions) provide an easy way to directly add untyped properties to a resource in Microsoft Graph. オープン拡張機能は、openTypeExtension リソースで表されます。Open extensions are represented by the openTypeExtension resource. リソースに追加されるオープン拡張機能は extensions ナビゲーション プロパティに表示されます。このプロパティは、extension 抽象型から派生します。Any open extension added to a resource shows up in the extensions navigation property, which is derived from the extension abstract type. 各拡張機能には extensionName プロパティがあります。このプロパティは、すべての拡張機能とカスタム データで唯一定義済みの書き込み可能なプロパティです。Each extension has an extensionName property which is the only pre-defined, writable property for all extensions, along with your custom data. 拡張機能名が必ず一意であるようにする方法の 1 つは、_独自のドメイン_に依存する逆引きドメイン ネーム システム (DNS) 形式 (例: Com.Contoso.ContactInfo) を使用することです。One way to help make sure extension names are unique is to use a reverse domain name system (DNS) format that is dependent on your own domain, for example, Com.Contoso.ContactInfo. 拡張機能名に Microsoft ドメイン (Com.Microsoft または Com.OnMicrosoft) を使用しないでください。Do not use the Microsoft domain (Com.Microsoft or Com.OnMicrosoft) in an extension name.

オープン拡張機能の例:オープン拡張機能を使用したユーザーへのカスタム データの追加Open extension example: Add custom data to users using open extensions

オープン拡張機能は、次のリソースの対応するバージョンの一般提供 (GA: /v1.0 および /ベータ) またはプレビュー (/ベータ) でサポートされています。Open extensions are supported by the following resources in the corresponding versions - general availability (GA: /v1.0 and /beta) or preview (/beta).

リソースResource バージョンVersion
管理単位Administrative unit プレビューのみPreview only
予定表イベントCalendar event GAGA
グループ予定表イベントGroup calendar event GAGA
グループ会話スレッド投稿Group conversation thread post GAGA
devicedevice GAGA
グループgroup GAGA
メッセージmessage GAGA
組織organization GAGA
個人用連絡先Personal contact GAGA
ユーザーuser GAGA

Outlook 固有の考慮事項Outlook-specific considerations

Outlook リソース (イベント、メッセージ、個人用連絡先) に存在する各オープン拡張は、MAPI 名前付きプロパティに保存されます。Each open extension present on an Outlook resource (event, message, or personal contact) is stored in a MAPI named property. Outlook のオープン拡張を作成する場合は、MAPI 名前付きプロパティがユーザーのメールボックスで有限のリソースであることを考慮してください。When you create open extensions for Outlook, consider that MAPI named properties are a finite resource in a user's mailbox. ユーザーの名前付きプロパティのクォータがすべて使用されると、それ以上、そのユーザーに対して名前付きのプロパティを作成することはできません。When a user's named property quota is exhausted, you can't create any more named properties for that user. これにより、機能する名前付きプロパティに依存しているクライアントから、予期しない動作が発生する可能性があります。This can result in unexpected behavior from clients that rely on named properties to function.

Outlook リソースのオープン拡張を作成する場合は、次のガイドラインを適用します。Apply the following guidelines when you create open extensions on Outlook resources:

  • 必要な拡張機能の最小数を作成します。Create the minimum number of extensions required. ほとんどのアプリケーションで必要な拡張機能は、1 つのみです。Most applications should require no more than one extension. 拡張機能には、定義済みのプロパティや構造体が設定されていないため、1 つの拡張機能に複数の値を保存できます。Extensions have no set defined properties or structure, so you can store multiple values in a single extension.
  • 拡張機能には変更可能な方法 (ユーザー入力に基づくなど) で名前を付けないでください。Avoid naming extensions in a variable manner (such as based on user input, etc.). ユーザーのメールボックスで以前に使用されていない新しい名前でオープン拡張が作成されるたびに、新しい MAPI 名前付きプロパティが作成されます。Each time an open extension is created with a new name that has not been used in a user's mailbox before, a new MAPI named property is created. 拡張機能を削除しても、名前付きプロパティは削除されません。Removing the extension does not remove the named property.

オープン拡張 (Outlook リソース用) または拡張プロパティを使用するUse open extensions (for Outlook resources) or extended properties

オープン拡張機能は、カスタム データの格納およびカスタムデータへのアクセスを必要とするほとんどのシナリオに対して推奨されるソリューションです。Open extensions is the recommended solution for most scenarios involving storing and accessing custom data. ただし、拡張プロパティとこの REST API は、Microsoft Graph API のメタデータを通じてまだ公開されていない Outlook MAPI プロパティのカスタム データにアクセスする必要がある場合に使用できます。If, however, you need to access custom data for Outlook MAPI properties that are not already exposed through the Microsoft Graph API metadata, you can use extended properties and its REST API. メタデータが公開するプロパティは、https://graph.microsoft.com/v1.0/$metadata で確認できます。You can verify which properties the metadata exposes at https://graph.microsoft.com/v1.0/$metadata.

JSON 表記JSON representation

以下は、リソースの JSON 表記ですHere is a JSON representation of the resource

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

プロパティProperties

プロパティProperty Type 説明Description
extensionNameextensionName StringString オープン型のデータ拡張情報の一意のテキスト識別子。必須。A unique text identifier for an open type data extension. Required.
idid StringString extensionName と拡張子タイプを連結する完全修飾識別子。読み取り専用。A fully qualified identifier that concatenates the extension type with the extensionName. Read-only.

リレーションシップRelationships

なしNone

メソッドMethods

メソッドMethod 戻り値の型Return Type 説明Description
PostPost opentypeextension(既存のリソースインスタンスの場合)、または opentypeextension オブジェクトを含む新しい連絡先イベント、またはメッセージopenTypeExtension(in an existing resource instance), or a new contact, event, or message that contains an openTypeExtension object. 既存または新規のリソース インスタンス内に openTypeExtension オブジェクトを作成します。Create an openTypeExtension object in an existing or new resource instance.
GetGet openTypeExtensionopenTypeExtension openTypeExtension オブジェクトのプロパティと関係を読み取ります。Read properties and relationships of openTypeExtension object.
更新するUpdate openTypeExtensionopenTypeExtension openTypeExtension オブジェクトを更新します。Update openTypeExtension object.
削除Delete なしNone openTypeExtension オブジェクトを削除します。Delete openTypeExtension object.