outlookCategory リソースの種類

名前空間: microsoft.graph

重要

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

注意

Outlook タスクは非推奨となり、2022 年 8 月 10 日にデータの返しを停止しました。 Outlook タスクでこの機能を使用する既存のアプリを更新します。

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

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

各カテゴリは、 displayName と color という 2 つのプロパティによって属性付 されます。 displayName の値は、ユーザーのマスター リスト内で一意でなければなりません。 ただし 、色 は一意である必要はありません。マスター リスト内の複数のカテゴリを同じ色にマップできます。 ユーザーのマスター リスト内のカテゴリには、最大 25 種類の色をマッピングできます。

メソッド

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

プロパティ

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

手記に使用できる値は、Nonepreset0preset1などのプリセット定数です。 各プリセット定数は、さらに色にマップされます。実際の色は、カテゴリが表示されている Outlook クライアントによって異なります。 次の表は、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"
}