contact リソース型

名前空間: microsoft.graph

重要

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

連絡先は、連絡を取り合う人や組織に関する情報を編成および保存できる Outlook のアイテムです。 連絡先は連絡先フォルダーに格納されます。

このリソースは以下をサポートしています。

  • 拡張機能として、カスタム プロパティに独自のデータを追加します。
  • 変更通知を受信します。
  • デルタ関数を提供することにより、デルタ クエリを使用して、増分の追加、削除、更新を追跡します。

メソッド

メソッド 戻り値の型 説明
連絡先を取得する contact 連絡先オブジェクトのプロパティとリレーションシップを読み取ります。
作成 contact 連絡先をルート連絡先フォルダーまたは別の連絡先フォルダーの連絡先エンドポイントに追加します。
更新する contact 連絡先オブジェクトを更新します。
削除 なし 連絡先オブジェクトを削除します。
delta contactコレクション 指定したフォルダーで追加、削除、更新された連絡先のセットを取得します。
オープン拡張機能
Create open extension openTypeExtension オープン拡張機能を作成し、新規または既存のリソースにカスタム プロパティを追加します。
Get open extension openTypeExtension コレクション 拡張機能の名前で識別されるオープン拡張機能を取得します。
スキーマ拡張機能
スキーマ拡張機能の値を追加する スキーマ拡張機能の定義を作成し、それを使用してカスタマイズされた種類のデータをリソースに追加します。
拡張プロパティ
単一値の拡張プロパティを作成する contact 新規または既存の連絡先に、1 つ以上の単一値の拡張プロパティを作成します。
単一値の拡張プロパティを持つ連絡先を取得する contact $expand または $filter を使用して、単一値の拡張プロパティを含む連絡先を取得します。
複数値の拡張プロパティを作成する contact 新規または既存の連絡先に、1 つ以上の複数値の拡張プロパティを作成します。
複数値の拡張プロパティを持つ連絡先を取得する contact $expand を使用して、複数値の拡張プロパティを含む連絡先を取得します。

プロパティ

プロパティ 説明
assistantName String 連絡先のアシスタントの名前。
birthday DateTimeOffset 連絡先の誕生日です。 Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。
categories String collection 連絡先に関連付けられたカテゴリ。 各カテゴリは、ユーザーに対して定義されている outlookCategorydisplayName プロパティに対応しています。
changeKey String 連絡先のバージョンを識別します。 連絡先を変更するたびに ChangeKey も変更されます。 これにより、Exchange は正しいバージョンのオブジェクトに変更を適用できます。
children String collection 連絡先の子供の名前。
CompanyName String 連絡先の会社の名前。
createdDateTime DateTimeOffset 連絡先が作成された時刻です。 Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。
department String 連絡先の部署。
displayName String 連絡先の表示名。 [作成] または [更新] の操作で表示名を指定できます。 後で他のプロパティを更新すると、指定した displayName 値が自動的に生成された値に上書きされますので、ご注意ください。 既存の値を保持するには、[更新] 操作で必ずその値を displayName として含めてください。
emailAddresses typedEmailAddress コレクション 連絡先のメール アドレス。
fileAs String 連絡先がファイルされる名前。
flag followUpFlag 連絡先の状態、開始日、期日、または完了日を示すフラグ値。
gender String 連絡先の性別。
generation String 連絡先の世代。
givenName String 連絡先の名。
id String 連絡先の一意の識別子。 既定では、この値は、アイテムをあるコンテナー (フォルダーや予定表など) から別のコンテナーに移動したときに変更されます。 この動作を変更するには、Prefer: IdType="ImmutableId" ヘッダーを使用します。 詳細については「Outlook リソースの不変識別子を取得する」を参照してください。 読み取り専用です。
imAddresses String collection 連絡先のインスタント メッセージング (IM) アドレス。
initials String 連絡先のイニシャル。
jobTitle String 連絡先の役職。
lastModifiedDateTime DateTimeOffset 連絡先が変更された時刻です。 Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。
manager String 連絡先の上司の名前。
middleName String 連絡先のミドル ネーム。
nickName String 連絡先のニックネーム。
officeLocation String 連絡先のオフィスの所在地。
parentFolderId String 連絡先の親フォルダーの ID。
personalNotes String 連絡先に関するユーザーのメモ。
phones phone コレクション 自宅電話、携帯電話、勤務先電話など、連絡先に関連付けられた電話番号。
postalAddresses physicalAddress コレクション 自宅住所や勤務先住所など、連絡先に関連付けられた住所。
profession String 連絡先の専門的職業。
spouseName String 連絡先の配偶者/パートナーの名前。
String 連絡先の姓。
title String 連絡先の肩書。
websites website コレクション 連絡先に関連付けられた Web サイト。
weddingAnniversary Date 連絡先の結婚記念日。
yomiCompanyName String 連絡先の会社名の読み仮名。
yomiGivenName String 連絡先の名 (ファースト ネーム) の読み仮名。
yomiSurname String 連絡先の発音の日本語の姓 (姓)。

リレーションシップ

リレーションシップ 説明
extensions extension コレクション 連絡先に対して定義されているオープン拡張機能のコレクション。 Null 許容型。
multiValueExtendedProperties multiValueLegacyExtendedProperty collection 連絡先に定義された、複数値の拡張プロパティのコレクション。 読み取り専用。 Null 許容型。
photo photo 連絡先の写真 (オプション)。 連絡先の写真を取得また設定することができます。
singleValueExtendedProperties singleValueLegacyExtendedProperty collection 連絡先に定義された、単一値の拡張プロパティのコレクション。 読み取り専用。 Null 許容型。

JSON 表記

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

{
  "assistantName": "string",
  "birthday": "String (timestamp)",
  "categories": ["string"],
  "changeKey": "string",
  "children": ["string"],
  "companyName": "string",
  "createdDateTime": "String (timestamp)",
  "department": "string",
  "displayName": "string",
  "emailAddresses": [{"@odata.type": "microsoft.graph.typedEmailAddress"}],
  "fileAs": "string",
  "flag": {"@odata.type": "microsoft.graph.followupFlag"},
  "gender": "string",
  "generation": "string",
  "givenName": "string",
  "id": "string (identifier)",
  "imAddresses": ["string"],
  "initials": "string",
  "jobTitle": "string",
  "lastModifiedDateTime": "String (timestamp)",
  "manager": "string",
  "middleName": "string",
  "nickName": "string",
  "officeLocation": "string",
  "parentFolderId": "string",
  "personalNotes": "string",
  "phones": [{"@odata.type": "microsoft.graph.phone"}],
  "postalAddresses": [{"@odata.type": "microsoft.graph.physicalAddress"}],
  "profession": "string",
  "spouseName": "string",
  "surname": "string",
  "title": "string",
  "websites": [{"@odata.type": "microsoft.graph.website"}],
  "weddingAnniversary": "date",
  "yomiCompanyName": "string",
  "yomiGivenName": "string",
  "yomiSurname": "string"
}