REST Resource: people

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

リソース: 担当者

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

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

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

サーバーによって割り当てられたユーザーのリソース名。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.listotherContacts.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.listotherContacts.list の場合、電話番号の数は 100 個までに制限されています。複数の電話番号がある場合、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.listotherContacts.list の同期リクエストに対してのみデータが入力されます。

objectType
(deprecated)

enum (ObjectType)

出力のみ。非推奨(代わりに person.metadata.sources.profileMetadata.objectType を使用してください)

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

ソース

フィールドのソース。

JSON 表現
{
  "type": enum (SourceType),
  "id": string,
  "etag": string,
  "updateTime": string,
  "profileMetadata": {
    object (ProfileMetadata)
  }
}
フィールド
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")。

profileMetadata

object (ProfileMetadata)

出力のみ。person.metadata.sources にのみ入力されます。

PROFILE タイプのソースに関するメタデータ。

ソースの種類

ソースのタイプ。

列挙型
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)

出力のみ。ユーザータイプ。

オブジェクト タイプ

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

列挙型
OBJECT_TYPE_UNSPECIFIED (指定なし)
PERSON 人物。
PAGE Currents ページ

ユーザータイプ

ユーザーのタイプ。

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

住所

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

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

住所のタイプ。タイプはカスタムにすることも、次の事前定義された値のいずれかを指定することもできます。

  • 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 の国コード。

フィールド メタデータ

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

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)

フィールドのソース。

年齢層

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

ユーザーの年齢層。

列挙型
AGE_RANGE_UNSPECIFIED (指定なし)
LESS_THAN_EIGHTEEN 18 歳未満。
EIGHTEEN_TO_TWENTY 18 ~ 20 歳。
TWENTY_ONE_OR_OLDER 21 歳以上。

年齢層の範囲

ユーザーの年齢層。

JSON 表現
{
  "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)

伝記のコンテンツ タイプ。

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 フィールドを使用します。

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

Date

カレンダーの日付全体または日付の一部(誕生日など)を表します。時刻とタイムゾーンが別の場所で指定されているか、重要でない。日付は、グレゴリオ カレンダーの相対日付です。これは、次のいずれかを表します。

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

関連の種類:

JSON 表現
{
  "year": integer,
  "month": integer,
  "day": integer
}
フィールド
year

integer

日付の年。1 ~ 9999、または 0(年のない日付)を指定します。

month

integer

月(月)。月と日のない年を指定するには、1 ~ 12、または 0 にする必要があります。

day

integer

月の特定の日。1 から 31 までの範囲で年と月に対して有効です。年を限定する場合は自身を 0 とするか、日付が重要でない年と月を 0 と指定します。

ブラギングライト

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

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
フィールド
metadata

object (FieldMetadata)

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

value

string

自慢の権利(例: climbed mount everest)。

カレンダー URL

ユーザーのカレンダーの 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 のタイプ。

クライアント データ

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

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}
フィールド
metadata

object (FieldMetadata)

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

key

string

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

value

string

クライアント データで指定されたクライアントのデータ。

カバー写真

人のカバー写真。ユーザーのプロフィール ページに表示される大きな画像で、各個人やその人物が関心を持っているものを表します。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}
フィールド
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 ヘッダー ロケールで翻訳およびフォーマットされたイベントのタイプ。

FileA

リスト内の人物の並べ替えに使用する名前。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
フィールド
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

出力のみ。視聴者のアカウント ロケール、または Accept-Language HTTP ヘッダー ロケールで翻訳およびフォーマットされた性別の値。指定されていないか、カスタム値がローカライズされていません。

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 クライアントのプロトコル。

シグナルを

ユーザーの興味の一つ。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
フィールド
metadata

object (FieldMetadata)

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

value

string

興味 / 関心。例: stargazing

言語 / 地域

ユーザーの言語 / 地域の設定。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
フィールド
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)

出力のみ。ドメインのメンバーシップ。

連絡先グループ メンバーシップ

Google の連絡先グループのメンバー。

JSON 表現
{
  "contactGroupId": string,
  "contactGroupResourceName": string
}
フィールド
contactGroupId
(deprecated)

string

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

contactGroupResourceName

string

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

ドメイン メンバーシップ

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

JSON 表現
{
  "inViewerDomain": boolean
}
フィールド
inViewerDomain

boolean

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

その他のキーワード

人物の他のキーワード。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": enum (KeywordType),
  "formattedType": string
}
フィールド
metadata

object (FieldMetadata)

その他のキーワードに関するメタデータ。

value

string

その他のキーワードの値。

type

enum (KeywordType)

その他のキーワード。

formattedType

string

出力のみ。視聴者のアカウント ロケール、または Accept-Language HTTP ヘッダー ロケールで翻訳およびフォーマットされたその他のキーワードのタイプ。

キーワードの種類

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

列挙型
TYPE_UNSPECIFIED (指定なし)
OUTLOOK_BILLING_INFORMATION お支払い情報の Outlook 項目。
OUTLOOK_DIRECTORY_SERVER ディレクトリ サーバーの Outlook フィールド。
OUTLOOK_KEYWORD キーワードの Outlook フィールド
OUTLOOK_MILEAGE 走行距離の Outlook フィールド。
OUTLOOK_PRIORITY Outlook のフィールド。
OUTLOOK_SENSITIVITY 機密度を求める Outlook のフィールド。
OUTLOOK_SUBJECT 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

名前の接尾辞として正しく使用されている単語。

Nickname

ユーザーのニックネーム。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": enum (NicknameType)
}
フィールド
metadata

object (FieldMetadata)

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

value

string

ニックネーム。

type

enum (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 ヘッダーで指定されたロケールで指定します。

人間関係

非推奨: ある人物の関係性のデータは返されません。

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}
フィールド
metadata

object (FieldMetadata)

関係者の興味や関心に関するメタデータ。

value

string

ユーザーが求めている関係の種類。値は、カスタムまたは次の事前定義の値のいずれかです。

  • friend
  • date
  • relationship
  • networking
formattedValue

string

出力のみ。視聴者のアカウント ロケールまたは Accept-Language HTTP ヘッダーで指定されたロケールで翻訳され、書式設定された関係インタレストの値。

関係ステータス

非推奨: 相手の関係ステータスは返されません。

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 です。

SIP アドレス

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

JSON 表現
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
フィールド
metadata

object (FieldMetadata)

SIP アドレスに関するメタデータ。

value

string

RFC 3261 19.1 SIP URI 形式の SIP アドレス。

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 のタイプ。

ユーザー定義

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

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

連絡先の写真を更新する。