フィードバック 編集

Outlook の拡張プロパティの概要

  • [アーティクル]

名前空間: microsoft.graph

重要

Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。

注意事項

この機能を使用する既存のアプリは、Outlookが廃止されるので、Outlook更新する必要があります。 詳細についてはTo Doプレビューの API を参照してください。

拡張プロパティではカスタム データを格納することができます。特に Outlook MAPI プロパティが まだ Microsoft Graph API のメタデータで公開されていない 場合に、拡張プロパティは、アプリがこれらのプロパティのカスタム データにアクセスするためのフォールバック メカニズムとして機能します。拡張プロパティの REST API を使用して、次のユーザー リソースにこのようなカスタム データを格納したり、取得したりできます。

または、次の Microsoft 365 グループリソースの場合:

拡張プロパティとオープン拡張機能のどちらを使用するか

最も一般的なシナリオとして、オープン拡張機能 (openTypeExtension で表される。旧称は Office 365 のデータ拡張機能) を使用して、リソース インスタンスのカスタム データをユーザーのメールボックスに格納したり、それらにアクセスしたりできます。拡張プロパティは、Microsoft Graph API のメタデータでまだ公開されていない Outlook MAPI プロパティのカスタム データにアクセスする必要がある場合にのみ使用します。

拡張プロパティのタイプ

拡張プロパティに単一の値を保存するか、または (同じ型の) 複数の値を保存するかに応じて、拡張プロパティを singleValueLegacyExtendedProperty、または multiValueLegacyExtendedProperty として作成できます。

これらのタイプはそれぞれ、id によってプロパティを識別し、データを value に格納します。

id を使用して、特定のリソース インスタンスをその拡張プロパティと一緒に取得するか、単一の値の拡張プロパティでフィルターして、そのプロパティのすべてのインスタンスを取得できます。

注 REST API を使用して、1 つの呼び出しで特定のインスタンスのすべての拡張プロパティを取得することはできません。

id の形式

拡張プロパティの id は、次の 3 つの形式のいずれかで指定することができます。

  • 名前付きプロパティ - 拡張プロパティの種類、名前空間、および文字列名によって識別されます。
  • 名前付きプロパティ - 拡張プロパティの種類、名前空間、および数値の識別子によって識別されます。
  • proptag の形式 - 拡張プロパティの種類、および MAPI プロパティのタグによって識別されます。

次の 2 つの表では、単一値または複数値の拡張プロパティに適用されるこれらの形式について説明します。 {type} は、拡張プロパティ値の種類を表します。 この例では、これらの種類の文字列、整数、および配列を示しています。

単一値の拡張プロパティに有効な id の形式

形式 例 説明
"{type} {guid} Name {name}" "String {8ECCC264-6880-4EBE-992F-8888D2EEAA1D} Name TestProperty" 属している名前空間 (GUID) と文字列の名前で、プロパティを識別します。
"{type} {guid} Id {id}" "Integer {8ECCC264-6880-4EBE-992F-8888D2EEAA1D} Id 0x8012" 属している名前空間 (GUID) と数値の識別子で、プロパティを識別します。
"{type} {proptag}" "String 0x4001" 事前定義済みプロパティをそのプロパティ タグで識別します。

複数値の拡張プロパティに有効な id の形式

形式 例 説明
"{type} {guid} Name {name}" "StringArray {8ECCC264-6880-4EBE-992F-8888D2EEAA1D} Name TestProperty" 名前空間 (GUID) と文字列の名前で、プロパティを識別します。
"{type} {guid} Id {id}" "IntegerArray {8ECCC264-6880-4EBE-992F-8888D2EEAA1D} Id 0x8013" 名前空間 (GUID) と数値の識別子で、プロパティを識別します。
"{type} {proptag}" "StringArray 0x4002" 事前定義済みプロパティをそのプロパティ タグで識別します。

名前付きプロパティ形式のいずれかを使用して、単一値または複数値の拡張プロパティをカスタム プロパティとして定義します。 2 つの形式のうち、文字列名 (Name) を先にとる形式の方が参照しやすいため、推奨形式となります。 名前付きプロパティのプロパティの識別子は、0x8000-0xfffe の範囲にあります。

MAPI によって、またはクライアントまたはサーバーによって事前定義済みの、まだ Microsoft Graph に公開されていないプロパティにアクセスするには、proptag 形式を使用します。 これらのプロパティのプロパティ識別子は、0x0001〜0x7fff の範囲にあります。 カスタム プロパティを定義するのに、proptag 形式を使用してしないでください。

[MS-OXPROPS] Microsoft Corporation の「Exchange Server プロトコルのマスター プロパティ リスト」では、既存の MAPI プロパティへの拡張プロパティのマッピングに関する情報 (プロパティ識別子や GUID など) を検索できます。

注 id に対して 1 つの形式を選択したら、その形式でのみ拡張プロパティにアクセスする必要があります。

REST API の操作

単一値の拡張プロパティの操作:

複数値の拡張プロパティの操作: