このページは Cloud Translation API によって翻訳されました。

REST Resource: people

リソース: Person
- JSON 表現
- PersonMetadata
  - JSON 表現
- ソース
  - JSON 表現
- SourceType
- ProfileMetadata
  - JSON 表現
- ObjectType
- UserType
- 住所
  - JSON 表現
- FieldMetadata
  - JSON 表現
- AgeRange
- AgeRangeType
  - JSON 表現
- 略歴
  - JSON 表現
- ContentType
- 生年月日
  - JSON 表現
- 日付
  - JSON 表現
- BraggingRights
  - JSON 表現
- CalendarUrl
  - JSON 表現
- ClientData
  - JSON 表現
- CoverPhoto
  - JSON 表現
- EmailAddress
  - JSON 表現
- イベント
  - JSON 表現
- ExternalId
  - JSON 表現
- FileAs
  - JSON 表現
- 性別
  - JSON 表現
- ImClient
  - JSON 表現
- 興味 / 関心
  - JSON 表現
- 言語 / 地域
  - JSON 表現
- Location
  - JSON 表現
- メンバーシップ
  - JSON 表現
- ContactGroupMembership
  - JSON 表現
- DomainMembership
  - JSON 表現
- MiscKeyword
  - JSON 表現
- KeywordType
- 名前
  - JSON 表現
- ニックネーム
  - JSON 表現
- NicknameType
- Occupation
  - JSON 表現
- 組織
  - JSON 表現
- PhoneNumber
  - JSON 表現
- 写真
  - JSON 表現
- Relation
  - JSON 表現
- RelationshipInterest（関係性の関心）
  - JSON 表現
- RelationshipStatusRelationshipStatus（関係ステータス）
  - JSON 表現
- 居住地
  - JSON 表現
- SipAddress
  - JSON 表現
- スキル
  - JSON 表現
- タグライン
  - JSON 表現
- URL
  - JSON 表現
- UserDefined
  - JSON 表現
メソッド

リソース: Person

認証されたユーザーの連絡先やプロフィールデータなど、さまざまなデータソースから統合されたユーザーに関する情報。

ほとんどのフィールドに複数の項目を含めることができます。フィールド内のアイテムの順序は保証されませんが、空でないフィールドには、metadata.primary が true に設定されたフィールドが 1 つだけ保証されます。

JSON 表現

JSON 表現
{ "resourceName": string, "etag": string, "metadata": { object (`PersonMetadata`) }, "addresses": [ { object (`Address`) } ], "ageRange": enum (`AgeRange`), "ageRanges": [ { object (`AgeRangeType`) } ], "biographies": [ { object (`Biography`) } ], "birthdays": [ { object (`Birthday`) } ], "braggingRights": [ { object (`BraggingRights`) } ], "calendarUrls": [ { object (`CalendarUrl`) } ], "clientData": [ { object (`ClientData`) } ], "coverPhotos": [ { object (`CoverPhoto`) } ], "emailAddresses": [ { object (`EmailAddress`) } ], "events": [ { object (`Event`) } ], "externalIds": [ { object (`ExternalId`) } ], "fileAses": [ { object (`FileAs`) } ], "genders": [ { object (`Gender`) } ], "imClients": [ { object (`ImClient`) } ], "interests": [ { object (`Interest`) } ], "locales": [ { object (`Locale`) } ], "locations": [ { object (`Location`) } ], "memberships": [ { object (`Membership`) } ], "miscKeywords": [ { object (`MiscKeyword`) } ], "names": [ { object (`Name`) } ], "nicknames": [ { object (`Nickname`) } ], "occupations": [ { object (`Occupation`) } ], "organizations": [ { object (`Organization`) } ], "phoneNumbers": [ { object (`PhoneNumber`) } ], "photos": [ { object (`Photo`) } ], "relations": [ { object (`Relation`) } ], "relationshipInterests": [ { object (`RelationshipInterest`) } ], "relationshipStatuses": [ { object (`RelationshipStatus`) } ], "residences": [ { object (`Residence`) } ], "sipAddresses": [ { object (`SipAddress`) } ], "skills": [ { object (`Skill`) } ], "taglines": [ { object (`Tagline`) } ], "urls": [ { object (`Url`) } ], "userDefined": [ { object (`UserDefined`) } ] }

{
  "resourceName": string,
  "etag": string,
  "metadata": {
    object (PersonMetadata)
  },
  "addresses": [
    {
      object (Address)
    }
  ],
  "ageRange": enum (AgeRange),
  "ageRanges": [
    {
      object (AgeRangeType)
    }
  ],
  "biographies": [
    {
      object (Biography)
    }
  ],
  "birthdays": [
    {
      object (Birthday)
    }
  ],
  "braggingRights": [
    {
      object (BraggingRights)
    }
  ],
  "calendarUrls": [
    {
      object (CalendarUrl)
    }
  ],
  "clientData": [
    {
      object (ClientData)
    }
  ],
  "coverPhotos": [
    {
      object (CoverPhoto)
    }
  ],
  "emailAddresses": [
    {
      object (EmailAddress)
    }
  ],
  "events": [
    {
      object (Event)
    }
  ],
  "externalIds": [
    {
      object (ExternalId)
    }
  ],
  "fileAses": [
    {
      object (FileAs)
    }
  ],
  "genders": [
    {
      object (Gender)
    }
  ],
  "imClients": [
    {
      object (ImClient)
    }
  ],
  "interests": [
    {
      object (Interest)
    }
  ],
  "locales": [
    {
      object (Locale)
    }
  ],
  "locations": [
    {
      object (Location)
    }
  ],
  "memberships": [
    {
      object (Membership)
    }
  ],
  "miscKeywords": [
    {
      object (MiscKeyword)
    }
  ],
  "names": [
    {
      object (Name)
    }
  ],
  "nicknames": [
    {
      object (Nickname)
    }
  ],
  "occupations": [
    {
      object (Occupation)
    }
  ],
  "organizations": [
    {
      object (Organization)
    }
  ],
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ],
  "photos": [
    {
      object (Photo)
    }
  ],
  "relations": [
    {
      object (Relation)
    }
  ],
  "relationshipInterests": [
    {
      object (RelationshipInterest)
    }
  ],
  "relationshipStatuses": [
    {
      object (RelationshipStatus)
    }
  ],
  "residences": [
    {
      object (Residence)
    }
  ],
  "sipAddresses": [
    {
      object (SipAddress)
    }
  ],
  "skills": [
    {
      object (Skill)
    }
  ],
  "taglines": [
    {
      object (Tagline)
    }
  ],
  "urls": [
    {
      object (Url)
    }
  ],
  "userDefined": [
    {
      object (UserDefined)
    }
  ]
}

フィールド
`resourceName`	`string` サーバーによって割り当てられた個人のリソース名。`people/{person_id}` 形式の ASCII 文字列。
`etag`	`string` リソースの HTTP エンティティタグ。ウェブキャッシュの検証に使用されます。
`metadata`	`object (PersonMetadata)` 出力のみ。人物に関するメタデータ。
`addresses[]`	`object (Address)` ユーザーの番地。
`ageRange (deprecated)`	`enum (AgeRange)` この項目は非推奨です。出力のみ。非推奨（代わりに `person.ageRanges` を使用してください）その人の年齢層。
`ageRanges[]`	`object (AgeRangeType)` 出力のみ。ユーザーの年齢層。
`biographies[]`	`object (Biography)` 人物の経歴。このフィールドは、連絡先ソースのシングルトンです。
`birthdays[]`	`object (Birthday)` ユーザーの誕生日。このフィールドは、連絡先ソースのシングルトンです。
`braggingRights[] (deprecated)`	`object (BraggingRights)` この項目は非推奨です。非推奨: データは返されません。個人の自慢権は返されません。
`calendarUrls[]`	`object (CalendarUrl)` ユーザーのカレンダーの URL。
`clientData[]`	`object (ClientData)` 個人のクライアントデータ。
`coverPhotos[]`	`object (CoverPhoto)` 出力のみ。そのユーザーのカバー写真。
`emailAddresses[]`	`object (EmailAddress)` ユーザーのメールアドレス。`people.connections.list` と `otherContacts.list` のメールアドレスの数は 100 に制限されています。Person にさらに多くのメールアドレスがある場合は、`people.getBatchGet` を呼び出すことで、セット全体を取得できます。
`events[]`	`object (Event)` 個人のイベント。
`externalIds[]`	`object (ExternalId)` ユーザーの外部 ID。
`fileAses[]`	`object (FileAs)` ユーザーのファイルファイル。
`genders[]`	`object (Gender)` ユーザーの性別。このフィールドは、連絡先ソースのシングルトンです。
`imClients[]`	`object (ImClient)` ユーザーのインスタントメッセージクライアント。
`interests[]`	`object (Interest)` ユーザーの興味や関心。
`locales[]`	`object (Locale)` ユーザーの言語 / 地域設定。
`locations[]`	`object (Location)` ユーザーの所在地。
`memberships[]`	`object (Membership)` ユーザーのグループメンバー。
`miscKeywords[]`	`object (MiscKeyword)` ユーザーのその他のキーワード。
`names[]`	`object (Name)` 個人の名前。このフィールドは、連絡先ソースのシングルトンです。
`nicknames[]`	`object (Nickname)` ユーザーのニックネーム。
`occupations[]`	`object (Occupation)` 職業。
`organizations[]`	`object (Organization)` ユーザーの過去または現在の組織。
`phoneNumbers[]`	`object (PhoneNumber)` 個人の電話番号。`people.connections.list` と `otherContacts.list` の電話番号の数は 100 に制限されています。Person により多くの電話番号がある場合は、`people.getBatchGet` を呼び出すことで、セット全体を取得できます。
`photos[]`	`object (Photo)` 出力のみ。人物の写真。
`relations[]`	`object (Relation)` 人の関係。
`relationshipInterests[] (deprecated)`	`object (RelationshipInterest)` この項目は非推奨です。出力のみ。非推奨: データは返されません。ユーザーの関係の関心事。
`relationshipStatuses[] (deprecated)`	`object (RelationshipStatus)` この項目は非推奨です。出力のみ。非推奨: データは返されません。相手の関係ステータス。
`residences[] (deprecated)`	`object (Residence)` この項目は非推奨です。サポート終了: （代わりに `person.locations` を使用してください）ユーザーの居住地。
`sipAddresses[]`	`object (SipAddress)` ユーザーの SIP アドレス。
`skills[]`	`object (Skill)` ユーザーのスキル。
`taglines[] (deprecated)`	`object (Tagline)` この項目は非推奨です。出力のみ。非推奨: データは返されません。ユーザーのタグライン。
`urls[]`	`object (Url)` ユーザーに関連付けられている URL。
`userDefined[]`	`object (UserDefined)` そのユーザーのユーザー定義データ。

PersonMetadata

人物に関するメタデータ。

JSON 表現
{ "sources": [ { object (`Source`) } ], "previousResourceNames": [ string ], "linkedPeopleResourceNames": [ string ], "deleted": boolean, "objectType": enum (`ObjectType`) }

フィールド
`sources[]`	`object (Source)` ユーザーのデータソース。
`previousResourceNames[]`	`string` 出力のみ。このユーザーの過去のリソース名。同期トークンを含む `people.connections.list` リクエストに対してのみ入力されます。連絡先とプロフィールをリンクするフィールド（確認済みのメールアドレス、確認済みの電話番号、プロフィールの URL など）を追加または削除すると、リソース名が変更されることがあります。
`linkedPeopleResourceNames[]`	`string` 出力のみ。このリソースにリンクされているユーザーのリソース名。
`deleted`	`boolean` 出力のみ。人リソースが削除された場合は true。`people.connections.list` と `otherContacts.list` の同期リクエストの場合のみ入力されます。
`objectType (deprecated)`	`enum (ObjectType)` この項目は非推奨です。出力のみ。非推奨（代わりに `person.metadata.sources.profileMetadata.objectType` を使用してください）人物オブジェクトの型。

ソース

フィールドのソース。

JSON 表現

JSON 表現
{ "type": enum (`SourceType`), "id": string, "etag": string, "updateTime": string, // Union field `metadata` can be only one of the following: "profileMetadata": { object (`ProfileMetadata`) } // End of list of possible types for union field `metadata`. }

{
  "type": enum (SourceType),
  "id": string,
  "etag": string,
  "updateTime": string,

  // Union field metadata can be only one of the following:
  "profileMetadata": {
    object (ProfileMetadata)
  }
  // End of list of possible types for union field metadata.
}

フィールド
`type`	`enum (SourceType)` ソースタイプ。
`id`	`string` サーバーによって生成されたソースタイプ内の一意の識別子。
`etag`	`string` `person.metadata.sources` にのみ入力されます。ソースの HTTP エンティティタグ。ウェブキャッシュの検証に使用されます。
`updateTime`	`string (Timestamp format)` 出力のみ。`person.metadata.sources` にのみ入力されます。このソースの最終更新日時。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: `"2014-10-02T15:01:23Z"`、`"2014-10-02T15:01:23.045123456Z"`。
共用体フィールド `metadata`。`person.metadata.sources` にのみ入力されます。ソースに関するメタデータ。`metadata` は次のいずれかになります。
`profileMetadata`	`object (ProfileMetadata)` 出力のみ。`person.metadata.sources` にのみ入力されます。 PROFILE 型のソースに関するメタデータ。

SourceType

ソースのタイプ。

列挙型
`SOURCE_TYPE_UNSPECIFIED`	（指定なし）
`ACCOUNT`	Google アカウント。
`PROFILE`	Google プロフィール。プロフィールは https://profiles.google.com/{id} で確認できます。{id} はソース ID です。
`DOMAIN_PROFILE`	Google Workspace のドメインプロファイル。
`CONTACT`	Google の連絡先。連絡先は https://contact.google.com/{id} で確認できます。{id} はソース ID です。
`OTHER_CONTACT`	Google の「その他の連絡先」。
`DOMAIN_CONTACT`	Google Workspace ドメインの共有の連絡先。

ProfileMetadata

プロフィールに関するメタデータ。

JSON 表現
{ "objectType": enum (`ObjectType`), "userTypes": [ enum (`UserType`) ] }

フィールド

objectType

enum (ObjectType)

出力のみ。プロファイルオブジェクトタイプ。

userTypes[]

enum (UserType)

出力のみ。ユーザーが入力する。

ObjectType

人物オブジェクトのタイプ。

列挙型
`OBJECT_TYPE_UNSPECIFIED`	（指定なし）
`PERSON`	人。
`PAGE`	Currents ページ。

UserType

ユーザーのタイプ。

列挙型
`USER_TYPE_UNKNOWN`	ユーザータイプが不明です。
`GOOGLE_USER`	ユーザーが Google ユーザーである。
`GPLUS_USER`	ユーザーが Currents ユーザーである。
`GOOGLE_APPS_USER`	ユーザーが Google Workspace ユーザーである。

住所

個人の住所。私書箱または番地を指定できます。すべてのフィールドは任意です。

JSON 表現

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "formattedValue": string, "type": string, "formattedType": string, "poBox": string, "streetAddress": string, "extendedAddress": string, "city": string, "region": string, "postalCode": string, "country": string, "countryCode": string }

{
  "metadata": {
    object (FieldMetadata)
  },
  "formattedValue": string,
  "type": string,
  "formattedType": string,
  "poBox": string,
  "streetAddress": string,
  "extendedAddress": string,
  "city": string,
  "region": string,
  "postalCode": string,
  "country": string,
  "countryCode": string
}

フィールド
`metadata`	`object (FieldMetadata)` 住所に関するメタデータ。
`formattedValue`	`string` 住所の構造化されていない値。ユーザーが設定しなかった場合は、構造化された値から自動的に構成されます。
`type`	`string` 住所のタイプ。型はカスタムにすることも、次の定義済みの値のいずれかにすることもできます。 `home` `work` `other`
`formattedType`	`string` 出力のみ。閲覧者のアカウントの言語 / 地域または `Accept-Language` HTTP ヘッダーのロケールで翻訳、フォーマットされたアドレスのタイプ。
`poBox`	`string` 住所の私書箱。
`streetAddress`	`string` 番地です。
`extendedAddress`	`string` 住所の拡張住所（部屋番号など）。
`city`	`string` 住所の市区町村。
`region`	`string` 州や都道府県など、住所の地域。
`postalCode`	`string` 住所の郵便番号。
`country`	`string` 住所の国。
`countryCode`	`string` 住所の ISO 3166-1 alpha-2 国コード。

FieldMetadata

フィールドに関するメタデータ。

JSON 表現
{ "primary": boolean, "sourcePrimary": boolean, "verified": boolean, "source": { object (`Source`) } }

フィールド
`primary`	`boolean` 出力のみ。このフィールドが人物のすべてのソースのメインフィールドである場合は true になります。各ユーザーには、`primary` が true に設定されたフィールドが 1 つまで含まれます。
`sourcePrimary`	`boolean` フィールドが `source` のプライマリフィールドの場合は true。各ソースには、`sourcePrimary` が true に設定されたフィールドが 1 つまで必要です。
`verified`	`boolean` 出力のみ。フィールドが検証されている場合は true、未検証の場合は false です。「確認済み」フィールドは通常、ユーザーによって所有されていることが確認されている名前、メールアドレス、電話番号、ウェブサイトなどです。
`source`	`object (Source)` フィールドのソース。

AgeRange

非推奨（代わりに person.ageRanges を使用してください）

人の年齢層。

列挙型
`AGE_RANGE_UNSPECIFIED`	（指定なし）
`LESS_THAN_EIGHTEEN`	18 歳未満。
`EIGHTEEN_TO_TWENTY`	18 ～ 20 歳。
`TWENTY_ONE_OR_OLDER`	21 歳以上です。

AgeRangeType

個人の年齢層。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "ageRange": enum (`AgeRange`) }

フィールド

フィールド
`metadata`	`object (FieldMetadata)` 年齢層に関するメタデータ。
`ageRange`	`enum (AgeRange)` 年齢層。

metadata

object (FieldMetadata)

年齢層に関するメタデータ。

ageRange

enum (AgeRange)

年齢層。

略歴

人の短い経歴。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "value": string, "contentType": enum (`ContentType`) }

フィールド

フィールド
`metadata`	`object (FieldMetadata)` 略歴に関するメタデータ。
`value`	`string` 略歴。
`contentType`	`enum (ContentType)` 略歴のコンテンツタイプ。

metadata

object (FieldMetadata)

略歴に関するメタデータ。

value

string

略歴。

contentType

enum (ContentType)

略歴のコンテンツタイプ。

ContentType

コンテンツのタイプ。

列挙型
`CONTENT_TYPE_UNSPECIFIED`	（指定なし）
`TEXT_PLAIN`	書式なしテキスト。
`TEXT_HTML`	HTML テキスト。

誕生日

人の誕生日。date フィールドと text フィールドのうち少なくとも 1 つが指定されています。通常、date フィールドと text フィールドは同じ日付を表しますが、必ず同じ日付を表すとは限りません。クライアントで誕生日を変更する場合は、常に date フィールドを設定する必要があります。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "date": { object (`Date`) }, "text": string }

フィールド

フィールド
`metadata`	`object (FieldMetadata)` 誕生日に関するメタデータ。
`date`	`object (Date)` 誕生日の構造化された日付。
`text (deprecated)`	`string` この項目は非推奨です。 `date` フィールドが設定されている場合は、こちらを使用してください。ユーザーの誕生日を表す自由形式の文字列。この値は検証されません。

metadata

object (FieldMetadata)

誕生日に関するメタデータ。

date

object (Date)

誕生日の構造化された日付。

text
(deprecated)

string

date フィールドが設定されている場合は、こちらを使用してください。

ユーザーの誕生日を表す自由形式の文字列。この値は検証されません。

日付

誕生日など、カレンダーの日付全体または一部を表します。時刻とタイムゾーンが他の場所で指定されているか、重要ではありません。日付はグレゴリオ暦を基準にしています。次のいずれかを表します。

ゼロ以外の年、月、日の値を含む完全な日付。
年が 0 の月と日（記念日など）。
1 年、1 か月が 0 日、1 日が 0 日です。
年と月。日がゼロです（クレジットカードの有効期限など）。

JSON 表現
{ "year": integer, "month": integer, "day": integer }

フィールド
`year`	`integer` 日付の年。1 ～ 9999 にするか、年のない日付を指定するには 0 を指定する必要があります。
`month`	`integer` 月。1 ～ 12 にする必要があります。月と日のない年を指定するには 0 にする必要があります。
`day`	`integer` 日。その年と月に対して有効な 1 ～ 31 にする必要があります。年を単独で指定するか、日が重要でない場合は年と月を 0 で指定します。

BraggingRights

非推奨: データは返されません。個人の自慢権は返されません。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "value": string }

フィールド

フィールド
`metadata`	`object (FieldMetadata)` 自慢する権利に関するメタデータ。
`value`	`string` 自慢の権利（例: `climbed mount everest`）。

metadata

object (FieldMetadata)

自慢する権利に関するメタデータ。

value

string

自慢の権利（例: climbed mount everest）。

CalendarUrl

ユーザーのカレンダーの URL。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "url": string, "type": string, "formattedType": string }

フィールド
`metadata`	`object (FieldMetadata)` カレンダー URL に関するメタデータ。
`url`	`string` カレンダーの URL。
`type`	`string` カレンダーの URL のタイプ。型はカスタムにすることも、次の定義済みの値のいずれかにすることもできます。 `home` `freeBusy` `work`
`formattedType`	`string` 出力のみ。閲覧者のアカウントの言語 / 地域または `Accept-Language` HTTP ヘッダーの言語 / 地域で翻訳およびフォーマットされたカレンダー URL のタイプ。

ClientData

クライアントによって入力された任意のクライアントデータ。キーと値は重複できます。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "key": string, "value": string }

フィールド

フィールド
`metadata`	`object (FieldMetadata)` クライアントデータに関するメタデータ。
`key`	`string` クライアントがクライアントデータのキーを指定しました。
`value`	`string` クライアントが指定したクライアントデータの値。

metadata

object (FieldMetadata)

クライアントデータに関するメタデータ。

key

string

クライアントがクライアントデータのキーを指定しました。

value

string

クライアントが指定したクライアントデータの値。

CoverPhoto

個人のカバー写真。ユーザーのプロフィールページに表示される大きな画像。ユーザーの属性や関心事を表すものです。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "url": string, "default": boolean }

フィールド

フィールド
`metadata`	`object (FieldMetadata)` カバー写真に関するメタデータ。
`url`	`string` カバー写真の URL。
`default`	`boolean` カバー写真がデフォルトのカバー写真の場合は true、ユーザーから提供されたカバー写真の場合は false です。

metadata

object (FieldMetadata)

カバー写真に関するメタデータ。

url

string

カバー写真の URL。

default

boolean

カバー写真がデフォルトのカバー写真の場合は true、ユーザーから提供されたカバー写真の場合は false です。

EmailAddress

個人のメールアドレス。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "value": string, "type": string, "formattedType": string, "displayName": string }

フィールド
`metadata`	`object (FieldMetadata)` メールアドレスに関するメタデータ。
`value`	`string` メールアドレス。
`type`	`string` メールアドレスのタイプ。型はカスタムにすることも、次の定義済みの値のいずれかにすることもできます。 `home` `work` `other`
`formattedType`	`string` 出力のみ。閲覧者のアカウントの言語 / 地域または `Accept-Language` HTTP ヘッダーのロケールで翻訳およびフォーマットされたメールアドレスのタイプ。
`displayName`	`string` メールの表示名。

イベント

ユーザーに関連するイベント。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "date": { object (`Date`) }, "type": string, "formattedType": string }

フィールド
`metadata`	`object (FieldMetadata)` イベントに関するメタデータ。
`date`	`object (Date)` イベントの日付。
`type`	`string` イベントのタイプ。型はカスタムにすることも、次の定義済みの値のいずれかにすることもできます。 `anniversary` `other`
`formattedType`	`string` 出力のみ。閲覧者のアカウントの言語 / 地域または `Accept-Language` HTTP ヘッダーのロケールで翻訳およびフォーマットされたイベントのタイプ。

ExternalId

個人に関連する外部エンティティからの識別子。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "value": string, "type": string, "formattedType": string }

フィールド
`metadata`	`object (FieldMetadata)` 外部 ID に関するメタデータ。
`value`	`string` 外部 ID の値。
`type`	`string` 外部 ID のタイプ。型はカスタムにすることも、次の定義済みの値のいずれかにすることもできます。 `account` `customer` `loginId` `network` `organization`
`formattedType`	`string` 出力のみ。閲覧者のアカウントの言語 / 地域または `Accept-Language` HTTP ヘッダーのロケールで翻訳およびフォーマットされたイベントのタイプ。

FileAs

リスト内のユーザーを並べ替えるために使用する名前。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "value": string }

フィールド

フィールド
`metadata`	`object (FieldMetadata)` ファイル形式に関するメタデータ。
`value`	`string` file-as 値

metadata

object (FieldMetadata)

ファイル形式に関するメタデータ。

value

string

file-as 値

ジェンダー

人の性別。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "value": string, "formattedValue": string, "addressMeAs": string }

フィールド
`metadata`	`object (FieldMetadata)` 性別に関するメタデータ。
`value`	`string` 個人の性別。性別はカスタムにすることも、次の定義済みの値のいずれかにすることもできます。 `male` `female` `unspecified`
`formattedValue`	`string` 出力のみ。閲覧者のアカウントの言語 / 地域または HTTP ヘッダーの言語 `Accept-Language` で翻訳およびフォーマットされた性別の値。未指定またはカスタム値はローカライズされません。
`addressMeAs`	`string` 人を呼ぶために使用する代名詞の自由形式のテキストフィールド。一般的な値は次のとおりです。 `he`/`him` `she`/`her` `they`/`them`

ImClient

ユーザーのインスタントメッセージクライアント。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "username": string, "type": string, "formattedType": string, "protocol": string, "formattedProtocol": string }

フィールド
`metadata`	`object (FieldMetadata)` IM クライアントに関するメタデータ。
`username`	`string` IM クライアントで使用されるユーザー名。
`type`	`string` IM クライアントのタイプ。型はカスタムにすることも、次の定義済みの値のいずれかにすることもできます。 `home` `work` `other`
`formattedType`	`string` 出力のみ。閲覧者のアカウントの言語 / 地域または `Accept-Language` HTTP ヘッダーのロケールで翻訳およびフォーマットされた IM クライアントのタイプ。
`protocol`	`string` IM クライアントのプロトコル。プロトコルは、カスタムにすることも、次の定義済みの値のいずれかにすることもできます。 `aim` `msn` `yahoo` `skype` `qq` `googleTalk` `icq` `jabber` `netMeeting`
`formattedProtocol`	`string` 出力のみ。閲覧者のアカウントのロケールまたは `Accept-Language` HTTP ヘッダーのロケールでフォーマットされた IM クライアントのプロトコル。

興味 / 関心

ユーザーの関心の 1 つ。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "value": string }

フィールド

フィールド
`metadata`	`object (FieldMetadata)` 興味 / 関心に関するメタデータ。
`value`	`string` 興味 / 関心（例: `stargazing`）。

metadata

object (FieldMetadata)

興味 / 関心に関するメタデータ。

value

string

興味 / 関心（例: stargazing）。

Locale

ユーザーのロケール設定。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "value": string }

フィールド

フィールド
`metadata`	`object (FieldMetadata)` ロケールに関するメタデータ。
`value`	`string` ロケールを表す正しい形式の IETF BCP 47 言語タグ。

metadata

object (FieldMetadata)

ロケールに関するメタデータ。

value

string

ロケールを表す正しい形式の IETF BCP 47 言語タグ。

ロケーション

ユーザーの現在地。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "value": string, "type": string, "current": boolean, "buildingId": string, "floor": string, "floorSection": string, "deskCode": string }

フィールド
`metadata`	`object (FieldMetadata)` ビジネスに関するメタデータ。
`value`	`string` 場所の自由形式の値。
`type`	`string` 場所のタイプ。型はカスタムにすることも、次の定義済みの値のいずれかにすることもできます。 `desk` `grewUp`
`current`	`boolean` 場所が現在地かどうか。
`buildingId`	`string` ビルディングの ID。
`floor`	`string` 階の名前または番号。
`floorSection`	`string` `floor_name` の階のセクション。
`deskCode`	`string` 個々のデスクの場所。

メンバーシップ

グループ内のユーザーのメンバーシップ。変更できるのは連絡先グループのメンバーのみです。

JSON 表現

{
  "metadata": {
    object (FieldMetadata)
  },

  // Union field membership can be only one of the following:
  "contactGroupMembership": {
    object (ContactGroupMembership)
  },
  "domainMembership": {
    object (DomainMembership)
  }
  // End of list of possible types for union field membership.
}

フィールド
`metadata`	`object (FieldMetadata)` メンバーシップに関するメタデータ。
共用体フィールド `membership`。メンバーシップ。`membership` は次のいずれかになります。
`contactGroupMembership`	`object (ContactGroupMembership)` 連絡先グループのメンバー。
`domainMembership`	`object (DomainMembership)` 出力のみ。ドメインのメンバーシップ。

ContactGroupMembership

Google コンタクトグループのメンバー。

JSON 表現
{ "contactGroupId": string, "contactGroupResourceName": string }

フィールド

contactGroupId
(deprecated)

string

出力のみ。連絡先グループメンバーの連絡先グループ ID。

contactGroupResourceName

string

サーバーによって割り当てられた連絡先グループのリソース名。contactGroups/{contactGroupId} 形式の ASCII 文字列。メンバーシップの変更に使用できるのは contactGroupResourceName のみです。連絡先グループのメンバーは削除できますが、追加できるのはユーザーグループ、「myContacts」、「スター付き」のシステムグループのみです。連絡先には、常に 1 つ以上の連絡先グループメンバーが必要です。

DomainMembership

Google Workspace ドメインのメンバーシップ。

JSON 表現
{ "inViewerDomain": boolean }

フィールド

inViewerDomain

boolean

ユーザーが閲覧者の Google Workspace ドメインに属している場合は true。

MiscKeyword

個人のその他のキーワード。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "value": string, "type": enum (`KeywordType`), "formattedType": string }

フィールド
`metadata`	`object (FieldMetadata)` その他のキーワードに関するメタデータ。
`value`	`string` その他のキーワードの値。
`type`	`enum (KeywordType)` その他のキーワードタイプ。
`formattedType`	`string` 出力のみ。閲覧者のアカウントの言語 / 地域または `Accept-Language` HTTP ヘッダーのロケールで翻訳およびフォーマットされたその他のキーワードのタイプ。

KeywordType

その他のキーワードのタイプ。

列挙型
`TYPE_UNSPECIFIED`	（指定なし）
`OUTLOOK_BILLING_INFORMATION`	お支払い情報の Outlook フィールド。
`OUTLOOK_DIRECTORY_SERVER`	ディレクトリサーバーの Outlook フィールド。
`OUTLOOK_KEYWORD`	キーワードの Outlook フィールド。
`OUTLOOK_MILEAGE`	走行距離の Outlook フィールド。
`OUTLOOK_PRIORITY`	優先度の Outlook フィールド。
`OUTLOOK_SENSITIVITY`	機密性用の Outlook フィールド。
`OUTLOOK_SUBJECT`	件名の Outlook フィールド。
`OUTLOOK_USER`	ユーザーの Outlook フィールド。
`HOME`	ホーム。
`WORK`	仕事用] に移動します。
`OTHER`	その他

名前

人の名前。名前が単名の場合、姓は空白です。

JSON 表現

{
  "metadata": {
    object (FieldMetadata)
  },
  "displayName": string,
  "displayNameLastFirst": string,
  "unstructuredName": string,
  "familyName": string,
  "givenName": string,
  "middleName": string,
  "honorificPrefix": string,
  "honorificSuffix": string,
  "phoneticFullName": string,
  "phoneticFamilyName": string,
  "phoneticGivenName": string,
  "phoneticMiddleName": string,
  "phoneticHonorificPrefix": string,
  "phoneticHonorificSuffix": string
}

フィールド
`metadata`	`object (FieldMetadata)` 名前に関するメタデータ。
`displayName`	`string` 出力のみ。閲覧者のアカウントまたは `Accept-Language` HTTP ヘッダーで指定された言語 / 地域に従ってフォーマットされた表示名。
`displayNameLastFirst`	`string` 出力のみ。閲覧者のアカウントまたは `Accept-Language` HTTP ヘッダーで指定された言語 / 地域に従ってフォーマットされた、姓の表示名。
`unstructuredName`	`string` 自由形式の名前の値。
`familyName`	`string` 姓。
`givenName`	`string` 指定された名前。
`middleName`	`string` ミドルネーム。
`honorificPrefix`	`string` 敬称の接頭辞（`Mrs.`、`Dr.` など）
`honorificSuffix`	`string` 敬称の接尾辞（`Jr.` など）
`phoneticFullName`	`string` 発音どおりのフルネーム。
`phoneticFamilyName`	`string` 姓が読み通りに表記された。
`phoneticGivenName`	`string` 指定された名前のスペルが発音どおりです。
`phoneticMiddleName`	`string` ミドルネームのスペル。
`phoneticHonorificPrefix`	`string` 発音どおりの敬語の接頭辞。
`phoneticHonorificSuffix`	`string` 敬語の接尾辞。発音どおりのつづりで表記されます。

ニックネーム

個人のニックネーム。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "value": string, "type": enum (`NicknameType`) }

フィールド

metadata

object (FieldMetadata)

ニックネームに関するメタデータ。

value

string

ニックネーム。

type

enum (NicknameType)

ニックネームのタイプ。

NicknameType

ニックネームのタイプ。

列挙型
`DEFAULT`	一般的なニックネーム。
`MAIDEN_NAME`	旧姓または実名。結婚により姓が変わった場合に使用されます。この項目は非推奨です。
`INITIALS`	イニシャル。この項目は非推奨です。
`GPLUS`	Google+ プロフィールのニックネーム。この項目は非推奨です。
`OTHER_NAME`	所属などの名称（例: `Dr. Smith.`）この項目は非推奨です。
`ALTERNATE_NAME`	ユーザーの別名。
`SHORT_NAME`	人物の短い名前。この項目は非推奨です。

職業

職業。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "value": string }

フィールド

metadata

object (FieldMetadata)

職業に関するメタデータ。

value

string

職業（例: carpenter）。

組織

個人の過去または現在の組織。重複する期間も使用できます。

JSON 表現

{
  "metadata": {
    object (FieldMetadata)
  },
  "type": string,
  "formattedType": string,
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "current": boolean,
  "name": string,
  "phoneticName": string,
  "department": string,
  "title": string,
  "jobDescription": string,
  "symbol": string,
  "domain": string,
  "location": string,
  "costCenter": string,
  "fullTimeEquivalentMillipercent": integer
}

フィールド
`metadata`	`object (FieldMetadata)` 組織に関するメタデータ。
`type`	`string` 組織のタイプ。型はカスタムにすることも、次の定義済みの値のいずれかにすることもできます。 `work` `school`
`formattedType`	`string` 出力のみ。閲覧者のアカウントの言語 / 地域または `Accept-Language` HTTP ヘッダーのロケールで翻訳およびフォーマットされた組織のタイプ。
`startDate`	`object (Date)` ユーザーが組織に参加した開始日。
`endDate`	`object (Date)` ユーザーが退職した日付。
`current`	`boolean` 組織が個人の現在の組織である場合は true、過去の組織である場合は false です。
`name`	`string` 組織の名前。
`phoneticName`	`string` 組織の名称（発音）。
`department`	`string` 個人が所属する組織の部門。
`title`	`string` その担当者の組織での役職。
`jobDescription`	`string` 個人に関する組織での職務の説明。
`symbol`	`string` 組織を表すシンボル（証券コード、略語、頭字語など）。
`domain`	`string` 組織に関連付けられたドメイン名（例: `google.com`）。
`location`	`string` そのユーザーが勤務している組織のオフィスの所在地。
`costCenter`	`string` 組織のコストセンター。
`fullTimeEquivalentMillipercent`	`integer` 組織内のフルタイム従業員に相当するミリパーセント（100,000 = 100%）。

PhoneNumber

個人の電話番号。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "value": string, "canonicalForm": string, "type": string, "formattedType": string }

フィールド
`metadata`	`object (FieldMetadata)` 電話番号に関するメタデータ。
`value`	`string` 電話番号。
`canonicalForm`	`string` 出力のみ。正規化された ITU-T E.164 形式の電話番号。
`type`	`string` 電話番号のタイプ。型はカスタムにすることも、次の定義済みの値のいずれかにすることもできます。 `home` `work` `mobile` `homeFax` `workFax` `otherFax` `pager` `workMobile` `workPager` `main` `googleVoice` `other`
`formattedType`	`string` 出力のみ。閲覧者のアカウントの言語 / 地域または `Accept-Language` HTTP ヘッダーのロケールで翻訳およびフォーマットされた電話番号のタイプ。

写真

人物の写真。他のユーザーがその人物を識別できるよう、ユーザーの名前の横に画像が表示されます。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "url": string, "default": boolean }

フィールド

metadata

object (FieldMetadata)

写真に関するメタデータ。

url

string

写真の URL。目的のサイズを変更するには、URL の末尾にクエリパラメータ sz={size} を追加します。{size} はピクセル単位のサイズです。例: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

default

boolean

写真がデフォルトの写真の場合は true、ユーザーから提供された写真の場合は false です。

リレーション

ある人物と他の人物との関係。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "person": string, "type": string, "formattedType": string }

フィールド
`metadata`	`object (FieldMetadata)` リレーションに関するメタデータ。
`person`	`string` このリレーションが参照する相手の名前。
`type`	`string` 本人との関係。型はカスタムにすることも、次の定義済みの値のいずれかにすることもできます。 `spouse` `child` `mother` `father` `parent` `brother` `sister` `friend` `relative` `domesticPartner` `manager` `assistant` `referredBy` `partner`
`formattedType`	`string` 出力のみ。閲覧者のアカウントの言語 / 地域または Accept-Language HTTP ヘッダーで指定された言語 / 地域で翻訳およびフォーマットされたリレーションのタイプ。

RelationshipInterest

非推奨: データは返されません。個人の関係への関心。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "value": string, "formattedValue": string }

フィールド

metadata

object (FieldMetadata)

関係の関心に関するメタデータ。

value

string

その人物が求めている関係の種類。値はカスタムにすることも、次の定義済みの値のいずれかにすることもできます。

friend
date
relationship
networking

formattedValue

string

出力のみ。閲覧者のアカウントの言語 / 地域または Accept-Language HTTP ヘッダーで指定された言語 / 地域で翻訳およびフォーマットされた関係の関心の値。

RelationshipStatus

非推奨: データは返されません。個人の関係ステータス。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "value": string, "formattedValue": string }

フィールド

metadata

object (FieldMetadata)

関係ステータスに関するメタデータ。

value

string

交際状況。値はカスタムにすることも、次の定義済みの値のいずれかにすることもできます。

single
inARelationship
engaged
married
itsComplicated
openRelationship
widowed
inDomesticPartnership
inCivilUnion

formattedValue

string

出力のみ。閲覧者のアカウントの言語 / 地域または Accept-Language HTTP ヘッダーのロケールで翻訳およびフォーマットされた関係ステータスの値。

住居

非推奨: 代わりに person.locations を使用してください。個人の過去または現在の居住地。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "value": string, "current": boolean }

フィールド

metadata

object (FieldMetadata)

住居に関するメタデータ。

value

string

居住地の住所。

current

boolean

その居住地が個人の現在の居住地である場合は true、過去の居住地である場合は false です。

SipAddress

個人の SIP アドレス。セッション初期プロトコルアドレスは、インターネット経由で音声通話やビデオ通話を行う VoIP 通信に使用されます。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "value": string, "type": string, "formattedType": string }

フィールド
`metadata`	`object (FieldMetadata)` SIP アドレスに関するメタデータ。
`value`	`string` SIP アドレス（RFC 3261 19.1 SIP URI 形式）。
`type`	`string` SIP アドレスのタイプ。型はカスタムにすることも、次の定義済みの値のいずれかにすることもできます。 `home` `work` `mobile` `other`
`formattedType`	`string` 出力のみ。閲覧者のアカウントの言語 / 地域または `Accept-Language` HTTP ヘッダーのロケールで変換およびフォーマットされた SIP アドレスのタイプ。

Skill

個人のスキル。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "value": string }

フィールド

metadata

object (FieldMetadata)

スキルに関するメタデータ。

value

string

スキル（例: underwater basket weaving）。

キャッチフレーズ

非推奨: データは返されません。ユーザーの簡単な 1 行の説明。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "value": string }

フィールド

metadata

object (FieldMetadata)

タグラインに関するメタデータ。

value

string

タグライン。

URL

個人に関連付けられた URL。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "value": string, "type": string, "formattedType": string }

フィールド
`metadata`	`object (FieldMetadata)` URL に関するメタデータ。
`value`	`string` URL。
`type`	`string` URL のタイプ。型はカスタムにすることも、次の定義済みの値のいずれかにすることもできます。 `home` `work` `blog` `profile` `homePage` `ftp` `reservations` `appInstallPage`: Currents アプリケーションのウェブサイト。 `other`
`formattedType`	`string` 出力のみ。閲覧者のアカウントの言語 / 地域または `Accept-Language` HTTP ヘッダーのロケールで翻訳およびフォーマットされた URL のタイプ。

UserDefined

エンドユーザーによって入力された任意のユーザーデータ。

JSON 表現
{ "metadata": { object (`FieldMetadata`) }, "key": string, "value": string }

フィールド

metadata

object (FieldMetadata)

ユーザー定義データに関するメタデータ。

key

string

ユーザー定義データのエンドユーザー指定のキー。

value

string

ユーザー定義データのエンドユーザー指定の値。

Methods
`batchCreateContacts`	新しい連絡先のバッチを作成し、新しい連絡先の PersonResponses を返します。レイテンシやエラーの増加を避けるため、同じユーザーに対する変更リクエストは順番に送信する必要があります。
`batchDeleteContacts`	複数の連絡先をまとめて削除します。
`batchUpdateContacts`	一連の連絡先を更新し、更新された連絡先の PersonResponses にリソース名のマップを返します。
`createContact`	新しい連絡先を作成し、その連絡先の人事リソースを返します。
`deleteContact`	連絡先を削除する
`deleteContactPhoto`	連絡先の写真を削除する。
`get`	リソース名を指定して個人に関する情報を提供します。
`getBatchGet`	リクエストされたリソース名のリストを指定して、特定のユーザーのリストに関する情報を提供します。
`listDirectoryPeople`	認証されたユーザーのドメインディレクトリ内にある、ドメインのプロフィールとドメインの連絡先のリストを提供します。
`searchContacts`	認証されたユーザーのグループ化された連絡先の中から検索クエリと一致する連絡先のリストを提供します。
`searchDirectoryPeople`	認証されたユーザーのドメインディレクトリ内にある、検索クエリに一致するドメインプロフィールとドメインの連絡先のリストを提供します。
`updateContact`	既存の連絡先担当者の連絡先データを更新します。
`updateContactPhoto`	連絡先の写真を更新します。

REST Resource: people

リソース: Person

PersonMetadata

ソース

SourceType

ProfileMetadata

ObjectType

UserType

住所

FieldMetadata

AgeRange

AgeRangeType

略歴

ContentType

誕生日

日付

BraggingRights

CalendarUrl

ClientData

CoverPhoto

EmailAddress

イベント

ExternalId

FileAs

ジェンダー

ImClient

興味 / 関心

Locale

ロケーション

メンバーシップ

ContactGroupMembership

DomainMembership

MiscKeyword

KeywordType

名前

ニックネーム

NicknameType

職業

組織

PhoneNumber

写真

リレーション

RelationshipInterest

RelationshipStatus

住居

SipAddress

Skill

キャッチフレーズ

URL

UserDefined

Methods