REST Resource: people

資源:人

從各種資料來源合併的使用者相關資訊,例如已驗證使用者的聯絡人和個人資料。

多數欄位可以包含多個項目。欄位內的項目沒有保證順序,但每個非空白欄位都保證只有一個欄位,且 metadata.primary 設為 true。

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

由伺服器指派的資源名稱,ASCII 字串,格式為 people/{person_id}

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)

使用者的日曆網址。

clientData[]

object (ClientData)

使用者的客戶資料。

coverPhotos[]

object (CoverPhoto)

僅供輸出。對方的封面相片。

emailAddresses[]

object (EmailAddress)

對方的電子郵件地址。people.connections.listotherContacts.list 的電子郵件地址上限為 100 個。如果某人擁有更多電子郵件地址,您可以呼叫 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)

使用者相關聯的網址。

userDefined[]

object (UserDefined)

使用者定義的資料。

個人中繼資料

使用者的相關中繼資料。

JSON 表示法
{
  "sources": [
    {
      object (Source)
    }
  ],
  "previousResourceNames": [
    string
  ],
  "linkedPeopleResourceNames": [
    string
  ],
  "deleted": boolean,
  "objectType": enum (ObjectType)
}
欄位
sources[]

object (Source)

使用者資料來源。

previousResourceNames[]

string

僅供輸出。這位使用者曾經擁有的資源名稱。僅針對含有同步憑證的 people.connections.list 要求填入。

新增或移除連結聯絡人和個人資料的欄位 (例如已驗證的電子郵件、已驗證的電話號碼或個人資料網址) 時,資源名稱可能會有所變更。

linkedPeopleResourceNames[]

string

僅供輸出。連結至這項資源的使用者資源名稱。

deleted

boolean

僅供輸出。如果人員資源已遭刪除,則傳回 True。僅針對 people.connections.listotherContacts.list 同步處理要求填入。

objectType
(deprecated)

enum (ObjectType)

僅供輸出。已淘汰 (請改用 person.metadata.sources.profileMetadata.objectType)

Person 物件的類型。

資料來源

欄位的來源。

JSON 表示法
{
  "type": enum (SourceType),
  "id": string,
  "etag": string,
  "updateTime": string,
  "profileMetadata": {
    object (ProfileMetadata)
  }
}
欄位
type

enum (SourceType)

來源類型。

id

string

伺服器產生的來源類型專屬 ID。

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 網域共用聯絡人

個人資料中繼資料

設定檔的相關中繼資料。

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 使用者。

Address

使用者的實際地址。可以是郵政信箱或街道地址。所有欄位均為選填欄位。

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。

sourcePrimary

boolean

如果該欄位是 source 的主要欄位,則傳回 True。每個來源最多只能有一個欄位,並將 sourcePrimary 設為 true。

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 二十一歲。

年齡層類型

個人年齡層。

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 文字。

生日

某人的生日。至少指定了 datetext 欄位。datetext 欄位通常代表相同的日期,但不保證會如此。用戶端在忽略生日時一律應設定 date 欄位。

JSON 表示法
{
  "metadata": {
    object (FieldMetadata)
  },
  "date": {
    object (Date)
  },
  "text": string
}
欄位
metadata

object (FieldMetadata)

生日的相關中繼資料。

date

object (Date)

生日的結構化日期。

text
(deprecated)

string

如果已設定,則建議使用 date 欄位。

這個任意形式的字串代表使用者的生日。此值未通過驗證。

日期

表示完整或部分日曆日期,例如生日。時段和時區是在其他位置指定,或是未指定;日期為相對公日曆。可能代表下列其中一項:

  • 完整日期,包含非零年、月、日。
  • 月份和日期,而且年份為零 (例如週年紀念日)。
  • 一年零,一年零零。
  • 年份和月份,而且日期為零 (例如信用卡到期日)。

相關類型:

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

日曆網址

使用者的日曆網址。

JSON 表示法
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "type": string,
  "formattedType": string
}
欄位
metadata

object (FieldMetadata)

日曆網址的相關中繼資料。

url

string

日曆網址。

type

string

日曆網址的類型。類型可以是自訂,或是以下其中一個預先定義的值:

  • home
  • freeBusy
  • work
formattedType

string

僅供輸出。日曆網址的類型,以檢視者的帳戶語言代碼或 Accept-Language HTTP 標頭語言代碼的形式顯示及格式化。

用戶端資料

由用戶端填入的任意用戶端資料。允許重複的鍵和值。

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

封面相片的網址。

default

boolean

如果封面相片是預設的封面相片,則傳回 True;如果封面相片是使用者提供的封面相片,則傳回 False。

電子郵件地址

使用者的電子郵件地址。

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 標頭語言代碼表示) 經過翻譯與格式化。

外部 ID

與這個人相關的外部實體 ID,

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 標頭語言代碼表示) 經過翻譯與格式化。

檔案

必須用來排序清單中使用者的名稱。

JSON 表示法
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
欄位
metadata

object (FieldMetadata)

file-as 的相關中繼資料。

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

客戶

某人的即時通訊用戶端。

JSON 表示法
{
  "metadata": {
    object (FieldMetadata)
  },
  "username": string,
  "type": string,
  "formattedType": string,
  "protocol": string,
  "formattedProtocol": string
}
欄位
metadata

object (FieldMetadata)

IM 用戶端的相關中繼資料。

username

string

即時訊息用戶端的使用者名稱。

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

僅供輸出。聯絡人群組成員的聯絡群組編號。

contactGroupResourceName

string

由伺服器指派的聯絡人群組的資源名稱。ASCII 字串,格式為 contactGroups/{contactGroupId}。只有 contactGroupResourceName 才可以修改成員資格。您可以移除任何聯絡人群組成員資格,但只能新增使用者群組或「myContacts」或「已加星號」的系統群組成員。聯絡人必須至少具備一個聯絡人群組成員資格。

網域成員資格

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 主旨的 Outlook 欄位。
OUTLOOK_USER 使用者的 Outlook 欄位。
HOME 主畫面。
WORK 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)

暱稱的類型。

暱稱類型

暱稱的類型。

列舉
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

機構內員工的全職等效千分比 (100000 = 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

相片的網址。想要變更所需大小,請在網址結尾加上查詢參數 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

標語

已淘汰:系統不會傳回任何資料,而只會提供使用者個人的簡短一行說明。

JSON 表示法
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
欄位
metadata

object (FieldMetadata)

與標語相關的中繼資料。

value

string

標語。

網址

使用者的相關網址。

JSON 表示法
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
欄位
metadata

object (FieldMetadata)

網址的相關中繼資料。

value

string

網址。

type

string

網址的類型。類型可以是自訂,或是以下其中一個預先定義的值:

  • home
  • work
  • blog
  • profile
  • homePage
  • ftp
  • reservations
  • appInstallPage:Currents 應用程式的網站。
  • other
formattedType

string

僅供輸出。網址類型,以觀眾的帳戶語言代碼或 Accept-Language HTTP 標頭語言代碼的形式顯示及格式化。

使用者定義

由使用者填入的任意使用者資料。

JSON 表示法
{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}
欄位
metadata

object (FieldMetadata)

使用者定義資料的相關中繼資料。

key

string

使用者指定資料的指定鍵。

value

string

使用者定義的資料 (使用者定義的值)。

方法

batchCreateContacts

建立一批新聯絡人,並傳回新聯絡人的 PersonResponses

建議您依序傳送相同使用者的變更要求,以避免延遲和失敗。

batchDeleteContacts

刪除聯絡人。

batchUpdateContacts

更新一批聯絡人,並將資源名稱的對應地圖傳回給更新人員的 PersonResponses。

createContact

請建立新的聯絡人並傳回該聯絡人的使用者資源。

deleteContact

刪除聯絡人。

deleteContactPhoto

刪除聯絡人的相片。

get

指定資源名稱,以提供使用者的相關資訊。

getBatchGet

指定要求資源名稱清單,以提供特定使用者清單的資訊。

listDirectoryPeople

在已驗證使用者的網域目錄中提供網域設定檔和網域聯絡人清單。

searchContacts

在已驗證使用者的已分組聯絡人清單中,提供符合搜尋查詢的聯絡人清單。

searchDirectoryPeople

在已驗證使用者的網域目錄中提供符合搜尋查詢的網域設定檔和網域聯絡人清單。

updateContact

更新現有聯絡人的聯絡人資料。

updateContactPhoto

更新聯絡人的相片。