outlookCategory リソースの種類outlookCategory resource type

重要な:[Microsoft Graph で/beta のバージョンの Api は予告なしに変更されることがあります。Important: APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでの、これらの API の使用はサポートされていません。Use of these APIs in production applications is not supported.

ユーザーが Outlook アイテム (メッセージやイベントなど) をグループ化するために使用できるカテゴリを表します。Represents a category by which a user can group Outlook items such as messages and events. Outlook では、ユーザーは、マスター] ボックスの一覧でカテゴリを定義し、アイテムを 1 つまたは複数のユーザー定義カテゴリを適用できます。In Outlook, the user defines categories in a master list, and can apply one or more of these user-defined categories to an item.

カテゴリを作成してユーザーのマスター カテゴリ リストに定義するには、REST API を使用することができます。Using the REST API, you can create and define categories in the master list of categories for a user. また、このマスター カテゴリ リストの取得特定のカテゴリの取得、カテゴリに関連付けられている色の更新、カテゴリの削除などの操作を行うこともできます。You can also get this master list of categories, get a specific category, update the color associated with a category, or delete a category. カテゴリをアイテムに適用するには、適用対象とするアイテムの categories コレクションに、カテゴリの displayName プロパティを割り当てます。You can apply a category to an item by assigning the displayName property of the category to the categories collection of the item. カテゴリを割り当てることができるリソースには、連絡先イベントメッセージoutlookTask、および投稿が含まれます。Resources that can be assigned categories include contact, event, message, outlookTask, and post.

各カテゴリを特徴付けるプロパティには、displayNamecolor の 2 つがあります。Each category is attributed by 2 properties: displayName and color. displayName の値は、ユーザーのマスター リスト内で一意でなければなりません。The displayName value must be unique in a user's master list. 一方、color には一意の値を設定する必要はありません。マスター リストに含まれる複数のカテゴリに、同じ色をマッピングすることができます。The color however does not have to be unique; multiple categories in the master list can be mapped to the same color. ユーザーのマスター リスト内のカテゴリには、最大 25 種類の色をマッピングできます。You can map up to 25 different colors to categories in a user's master list.

プロパティProperties

プロパティProperty 種類Type 説明Description
displayNamedisplayName StringString ユーザーのメールボックス内でカテゴリを識別する一意の名前。A unique name that identifies a category in the user's mailbox. カテゴリが作成された後に、この名前を変更することはできません。After a category is created, the name cannot be changed. 読み取り専用。Read-only.
colorcolor StringString カテゴリを特徴付ける、あらかじめ設定された色の定数。定数は、事前定義された 25 種類の色のいずれか 1 つにマッピングされています。A pre-set color constant that characterizes a category, and that is mapped to one of 25 predefined colors. 次の注を参照してください。See the note below.

注: color に使用できる値は、あらかじめ設定されている Nonepreset0preset1 などの定数です。Note The possible values for color are pre-set constants such as None, preset0 and preset1. 設定済みの定数は、それぞれ 1 つの色にマッピングされています。ただし、実際の色は、カテゴリを表示する Outloook クライアントに依存します。Each pre-set constant is further mapped to a color; the actual color is dependent on the Outlook client that the categories are being displayed in. 次の表に、設定済みの各定数に Outlook (デスクトップ クライアント) でマッピングされている色を記載します。The following table shows the colors mapped to each pre-set constant for Outlook (desktop client).

設定済みの定数Pre-set constant Outlook でマッピングされている色Color mapped to in Outlook
NoneNone マッピングされている色なしNo color mapped
Preset0Preset0 Red
Preset1Preset1 オレンジOrange
Preset2Preset2 Brown
Preset3Preset3 Yellow
Preset4Preset4 Green
Preset5Preset5 青緑Teal
Preset6Preset6 オリーブOlive
Preset7Preset7 Blue
Preset8Preset8 Purple
Preset9Preset9 深紅Cranberry
Preset10Preset10 鋼色Steel
Preset11Preset11 DarkSteelDarkSteel
Preset12Preset12 灰色Gray
Preset13Preset13 DarkGrayDarkGray
Preset14Preset14 Black
Preset15Preset15 DarkRedDarkRed
Preset16Preset16 DarkOrangeDarkOrange
Preset17Preset17 DarkBrownDarkBrown
Preset18Preset18 DarkYellowDarkYellow
Preset19Preset19 DarkGreenDarkGreen
Preset20Preset20 DarkTealDarkTeal
Preset21Preset21 DarkOliveDarkOlive
Preset22Preset22 DarkBlueDarkBlue
Preset23Preset23 DarkPurpleDarkPurple
Preset24Preset24 DarkCranberryDarkCranberry

JSON 表記JSON representation

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

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

メソッドMethods

メソッドMethod 戻り値の型Return Type 説明Description
カテゴリの一覧表示List categories outlookCategory コレクションoutlookCategory collection ユーザーに対して定義されているすべてのカテゴリを取得します。Get all the categories that have been defined for the user.
カテゴリの取得Get category outlookCategoryoutlookCategory 指定した outlookCategory オブジェクトのプロパティとリレーションシップを取得します。Get the properties and relationships of the specified outlookCategory object.
作成Create outlookCategoryoutlookCategory ユーザーのマスター カテゴリ リスト内に outlookCategory オブジェクトを作成します。Create an outlookCategory object in the user's master list of categories.
更新Update outlookCategoryoutlookCategory 指定した outlookCategory オブジェクトの書き込み可能な color プロパティを更新します。Update the writable property, color, of the specified outlookCategory object.
削除Delete NoneNone 指定した outlookCategory オブジェクトを削除します。Delete the specified outlookCategory object.