REST Resource: people

資源:Person

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

大部分欄位可以包含多個項目。欄位中的項目沒有保證順序,但每個非空白欄位保證只有一個欄位,且 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

使用者的資源名稱,由伺服器指派。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)

對方的日曆網址。

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)

使用者定義的資料。

PersonMetadata

個人的中繼資料。

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

僅供輸出。如果個人資源已遭刪除,則為「是」。僅針對 people.connections.listotherContacts.list 同步要求填入。

objectType
(deprecated)

enum (ObjectType)

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

個人物件的類型。

來源

欄位的來源。

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

伺服器產生來源類型內的唯一 ID。

etag

string

僅在 person.metadata.sources 中填入。

來源的 HTTP 實體標記。用於驗證網頁快取。

updateTime

string (Timestamp format)

僅供輸出。僅在 person.metadata.sources 中填入。

這個來源的上次更新時間戳記。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度和最多九個小數位數。範例:"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 表示法
{
  "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

僅供輸出。如果這個欄位是使用者所有來源的主要欄位,則為「是」。每位使用者最多只能有一個欄位,而且 primary 設為 true。

sourcePrimary

boolean

如果這個欄位是 source 的主要欄位,則為「true」。每個來源最多只能有一個欄位,且 sourcePrimary 設為 true。

verified

boolean

僅供輸出。如果欄位已通過驗證,則為「true」;如果是未經驗證的欄位,則為 false。已驗證的欄位通常是確認為個人擁有的姓名、電子郵件地址、電話號碼或網站。

source

object (Source)

欄位來源。

AgeRange

已淘汰 (請改用 person.ageRanges)

某人的年齡層。

列舉
AGE_RANGE_UNSPECIFIED 未指明
LESS_THAN_EIGHTEEN 未滿十八歲
EIGHTEEN_TO_TWENTY 介於十八到二十之間
TWENTY_ONE_OR_OLDER 21 歲以上。

AgeRangeType

使用者的年齡層。

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 之間;如要指定不含月和日的年份,請輸入 1 至 0。

day

integer

日期,值必須介於 1 至 31 之間且有效的年份和月份。如要單獨指定年份,或指定年份和月份,則不重要。

BraggingRights

已淘汰:系統不會傳回任何人的耀眼權利。

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

object (FieldMetadata)

有關誇張權利的中繼資料。

value

string

誇張的權利,例如 climbed mount everest

CalendarUrl

個人的日曆網址。

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 標頭語言代碼所翻譯和格式化的日曆網址類型。

ClientData

由用戶端填入的任意客戶資料。索引鍵和值可以重複。

JSON 表示法
{
  "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

封面相片的網址。

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

與個人相關的外部實體的 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 標頭語言代碼進行翻譯及格式化。

FileAs

排列清單中聯絡人時應使用的名稱。

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

object (FieldMetadata)

檔案原型中繼資料。

value

string

檔案值

性別

某人的性別。

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)

關於即時訊息用戶端的中繼資料。

username

string

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

type

string

IM 用戶端的類型。類型可以是自訂值,也可以是以下任一預先定義的值:

  • home
  • work
  • other
formattedType

string

僅供輸出。根據檢視者帳戶語言代碼或 Accept-Language HTTP 標頭語言代碼所轉譯和格式的 SIM 卡用戶端類型。

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)

僅供輸出。網域成員資格。

ContactGroupMembership

Google 聯絡人群組成員。

JSON 表示法
{
  "contactGroupId": string,
  "contactGroupResourceName": string
}
欄位
contactGroupId
(deprecated)

string

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

contactGroupResourceName

string

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

DomainMembership

具備 Google Workspace 網域成員資格。

JSON 表示法
{
  "inViewerDomain": boolean
}
欄位
inViewerDomain

boolean

如果該使用者屬於檢視者的 Google Workspace 網域,則為「是」。

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

該名人員在機構中相當於全職時間的千分比 (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 標頭中指定的語言代碼,翻譯和格式的關係類型。

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

採用 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 標頭語言代碼所翻譯和格式化的網址類型。

UserDefined

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

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

object (FieldMetadata)

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

key

string

使用者定義資料的鍵。

value

string

使用者定義資料的指定值。

方法

batchCreateContacts

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

請為同一位使用者依序傳送 Mutate 要求,以避免延遲時間增加和失敗。

batchDeleteContacts

刪除一批聯絡人。

batchUpdateContacts

針對已更新的聯絡人更新大量聯絡人,並將資源名稱對應關係傳回到 PersonResponses。

createContact

建立新聯絡人,並傳回該聯絡人的人員資源。

deleteContact

刪除聯絡人。

deleteContactPhoto

刪除聯絡人的相片。

get

透過指定資源名稱來提供人員相關資訊。

getBatchGet

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

listDirectoryPeople

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

searchContacts

提供已驗證使用者的已分組聯絡人清單,當中列出與搜尋查詢相符的聯絡人。

searchDirectoryPeople

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

updateContact

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

updateContactPhoto

更新聯絡人的相片。