Outlook の拡張プロパティの概要Outlook extended properties overview

拡張プロパティではカスタム データを格納することができます。特に Outlook MAPI プロパティが_まだ Microsoft Graph API のメタデータで公開されていない_場合に、拡張プロパティは、アプリがこれらのプロパティのカスタム データにアクセスするためのフォールバック メカニズムとして機能します。拡張プロパティの REST API を使用して、次のユーザー リソースにこのようなカスタム データを格納したり、取得したりできます。Extended properties allow storing custom data and specifically serve as a fallback mechanism for apps to access custom data for Outlook MAPI properties when these properties are not already exposed in the Microsoft Graph API metadata. You can use extended properties REST API to store or get such custom data in the following user resources:

または、次の Office 365 グループ リソースとの間でもデータをやり取りできます。Or, in the following Office 365 group resources:

拡張プロパティとオープン拡張機能のどちらを使用するかUse extended properties or open extensions?

最も一般的なシナリオとして、オープン拡張機能 (openTypeExtension で表される。旧称は Office 365 のデータ拡張機能) を使用して、リソース インスタンスのカスタム データをユーザーのメールボックスに格納したり、それらにアクセスしたりできます。拡張プロパティは、Microsoft Graph API のメタデータでまだ公開されていない Outlook MAPI プロパティのカスタム データにアクセスする必要がある場合にのみ使用します。In most common scenarios, you should be able to use open extensions (represented by openTypeExtension, formerly known as Office 365 data extensions) to store and access custom data for resource instances in a user's mailbox. Use extended properties only if you need to access custom data for Outlook MAPI properties that are not already exposed in the Microsoft Graph API metadata.

拡張プロパティのタイプTypes of extended properties

拡張プロパティに単一の値を保存するか、または (同じ型の) 複数の値を保存するかに応じて、拡張プロパティを singleValueLegacyExtendedProperty、または multiValueLegacyExtendedProperty として作成できます。Depending on whether you intend to store a single or multiple values (of the same type) in an extended property, you can create an extended property as a singleValueLegacyExtendedProperty, or multiValueLegacyExtendedProperty.

これらのタイプはそれぞれ、id によってプロパティを識別し、データを value に格納します。Each of these types identifies the property by its id and stores data in value.

id を使用して、特定のリソース インスタンスをその拡張プロパティと一緒に取得するか、単一の値の拡張プロパティでフィルターして、そのプロパティのすべてのインスタンスを取得できます。You can use id to get a specific resource instance together with that extended property, or filter on a single-value extended property to get all the instances that have that property.

REST API を使用して、1 つの呼び出しで特定のインスタンスのすべての拡張プロパティを取得することはできません。Note You cannot use the REST API to get all the extended properties of a specific instance in one call.

id の形式id Formats

拡張プロパティの id は、次の 3 つの形式のいずれかで指定することができます。You can specify id of an extended property in one of three formats:

  • 名前付きプロパティ - 拡張プロパティの種類、名前空間、および文字列名によって識別されます。As a named property, identified by the extended property type, namespace, and a string name.
  • 名前付きプロパティ - 拡張プロパティの種類、名前空間、および数値の識別子によって識別されます。As a named property, identified by the extended property type, namespace, and a numeric identifier.
  • proptag の形式 - 拡張プロパティの種類、および MAPI プロパティのタグによって識別されます。In a proptag format, identified by the extended property type and a MAPI property tag.

次の 2 つの表では、単一値または複数値の拡張プロパティに適用されるこれらの形式について説明します。The next 2 tables below describe the supported formats to specify single and multi-value extended properties. {type} は、拡張プロパティ値の種類を表します。{type} represents the type of the value or values of the property. この例では、これらの種類の文字列、整数、および配列を示しています。Shown in the examples are string, integer, and arrays of these types.

単一値の拡張プロパティに有効な id の形式Valid id formats for single-value extended properties

形式Format Example 説明Description
"{type} {guid} Name {name}""{type} {guid} Name {name}" "String {8ECCC264-6880-4EBE-992F-8888D2EEAA1D} Name TestProperty" 属している名前空間 (GUID) と文字列の名前で、プロパティを識別します。Identifies a property by the namespace (the GUID) it belongs to, and a name.
"{type} {guid} Id {id}""{type} {guid} Id {id}" "Integer {8ECCC264-6880-4EBE-992F-8888D2EEAA1D} Id 0x8012" 属している名前空間 (GUID) と数値の識別子で、プロパティを識別します。Identifies a property by the namespace (the GUID) it belongs to, and an identifier.
"{type} {proptag}""{type} {proptag}" "String 0x4001001E" 事前定義済みプロパティをそのプロパティ タグで識別します。Identifies a pre-defined property by its property tag.

複数値の拡張プロパティに有効な id の形式Valid id formats for multi-value extended properties

形式Format Example 説明Description
"{type} {guid} Name {name}""{type} {guid} Name {name}" "StringArray {8ECCC264-6880-4EBE-992F-8888D2EEAA1D} Name TestProperty" 名前空間 (GUID) と文字列の名前で、プロパティを識別します。Identifies a property by the namespace (the GUID) it belongs to, and a name.
"{type} {guid} Id {id}""{type} {guid} Id {id}" "IntegerArray {8ECCC264-6880-4EBE-992F-8888D2EEAA1D} Id 0x8013" 名前空間 (GUID) と数値の識別子で、プロパティを識別します。Identifies a property by namespace (the GUID) and identifier.
"{type} {proptag}""{type} {proptag}" "StringArray 0x4002101E" 事前定義済みプロパティをそのプロパティ タグで識別します。Identifies a pre-defined property by its property tag.

名前付きプロパティ形式のいずれかを使用して、単一値または複数値の拡張プロパティをカスタム プロパティとして定義します。Use either of the named property formats to define a single-value or multi-value extended property as a custom property. 2 つの形式のうち、文字列名 (Name) を先にとる形式の方が参照しやすいため、推奨形式となります。Among the two formats, the first one that takes a string name (Name) is the preferred format for ease of reference. 名前付きプロパティのプロパティの識別子は、0x8000-0xfffe の範囲にあります。Named properties have their property identifiers in the 0x8000-0xfffe range.

MAPI によって、またはクライアントまたはサーバーによって事前定義済みの、まだ Microsoft Graph に公開されていないプロパティにアクセスするには、proptag 形式を使用します。Use the proptag format to access properties predefined by MAPI, or by a client or server, and that have not already been exposed in Microsoft Graph. これらのプロパティのプロパティ識別子は、0x0001〜0x7fff の範囲にあります。These properties have property identifiers in the 0x0001-0x7fff range. カスタム プロパティを定義するのに、proptag 形式を使用してしないでください。Do not try to define a custom property using the proptag format.

[MS-OXPROPS] Microsoft Corporation の「Exchange Server プロトコルのマスター プロパティ リスト」では、既存の MAPI プロパティへの拡張プロパティのマッピングに関する情報 (プロパティ識別子や GUID など) を検索できます。You can find information about mapping an extended property to an existing MAPI property, such as the property identifier and GUID, in [MS-OXPROPS] Microsoft Corporation, "Exchange Server Protocols Master Property List".

id に対して 1 つの形式を選択したら、その形式でのみ拡張プロパティにアクセスする必要があります。Note After you have chosen one format for the id, you should access that extended property by only that format.

REST API の操作REST API operations

単一値の拡張プロパティの操作:Single-value extended property operations:

複数値の拡張プロパティの操作:Multi-value extended property operations: