outlookCategory リソースの種類

名前空間: microsoft.graph

ユーザーが Outlook アイテム (メッセージやイベントなど) をグループ化するために使用できるカテゴリを表します。 ユーザーはマスター リストにカテゴリを定義し、これらのユーザー定義カテゴリの 1 つ以上をアイテムに適用できます。

カテゴリを作成してユーザーのマスター カテゴリ リストに定義するには、REST API を使用することができます。 また、このマスター カテゴリ リストの取得、特定のカテゴリの取得、カテゴリに関連付けられている色の更新、カテゴリの削除などの操作を行うこともできます。 カテゴリをアイテムに適用するには、適用対象とするアイテムの categories コレクションに、カテゴリの displayName プロパティを割り当てます。 カテゴリを割り当てることができるリソースには、 連絡先、 イベント、 メッセージ、 投稿、 および todoTask が含まれます。

各カテゴリを特徴付けるプロパティには、displayName と color の 2 つがあります。 displayName の値は、ユーザーのマスター リスト内で一意でなければなりません。 一方、color には一意の値を設定する必要はありません。マスター リストに含まれる複数のカテゴリに、同じ色をマッピングすることができます。 ユーザーのマスター リスト内のカテゴリには、最大 25 種類の色をマッピングできます。

メソッド

メソッド	戻り値の型	説明
カテゴリの一覧表示	outlookCategory コレクション	ユーザーに対して定義されているすべてのカテゴリを取得します。
カテゴリの取得	outlookCategory	指定した outlookCategory オブジェクトのプロパティとリレーションシップを取得します。
作成	outlookCategory	ユーザーのマスター カテゴリ リスト内に outlookCategory オブジェクトを作成します。
更新	outlookCategory	指定した outlookCategory オブジェクトの書き込み可能な color プロパティを更新します。
削除	None	指定した outlookCategory オブジェクトを削除します。

プロパティ

プロパティ	型	説明
color	categoryColor	カテゴリを特徴付ける、あらかじめ設定された色の定数。定数は、事前定義された 25 種類の色のいずれか 1 つにマッピングされています。 詳細については、次の注を参照してください。
displayName	String	ユーザーのメールボックス内でカテゴリを識別する一意の名前。 カテゴリが作成された後に、この名前を変更することはできません。 読み取り専用です。

注:color に使用できる値は、あらかじめ設定されている None、preset0、preset1 などの定数です。 設定済みの定数は、それぞれ 1 つの色にマッピングされています。ただし、実際の色は、カテゴリを表示する Outloook クライアントに依存します。 次の表に、設定済みの各定数に Outlook (デスクトップ クライアント) でマッピングされている色を記載します。

設定済みの定数	Outlook でマッピングされている色
None	マッピングされている色なし
Preset0	赤
Preset1	オレンジ
Preset2	茶
Preset3	黄
Preset4	緑
Preset5	青緑
Preset6	オリーブ
Preset7	青
Preset8	紫
Preset9	深紅
Preset10	鋼色
Preset11	DarkSteel
Preset12	灰色
Preset13	DarkGray
Preset14	黒
Preset15	DarkRed
Preset16	DarkOrange
Preset17	DarkBrown
Preset18	DarkYellow
Preset19	DarkGreen
Preset20	DarkTeal
Preset21	DarkOlive
Preset22	DarkBlue
Preset23	DarkPurple
Preset24	DarkCranberry

JSON 表記

リソースの JSON 表記を次に示します。

{
  "color": "String",
  "displayName": "String"
}