REST Resource: people

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

object (Source)

使用者的資料來源。

string

僅供輸出。這位使用者曾用過的任何資源名稱。系統只會針對包含同步權杖的 people.connections.list 要求填入資料。

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

string

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

boolean

僅供輸出。如果刪除使用者資源，則為「是」。只會針對 people.connections.list 和 otherContacts.list 同步處理要求填入資料。

enum (ObjectType)

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

人員物件的類型。

{
  "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.
}

enum (SourceType)

來源類型。

string

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

string

只會在 person.metadata.sources 中填入。

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

string (Timestamp format)

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

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

RFC3339 世界標準時間「Zulu」的時間戳記格式，解析度為奈秒，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

object (ProfileMetadata)

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

關於「PROFILE」類型來源的中繼資料。

{
  "objectType": enum (ObjectType),
  "userTypes": [
    enum (UserType)
  ]
}

enum (ObjectType)

僅供輸出。設定檔物件類型。

enum (UserType)

僅供輸出。使用者輸入的內容。

{
  "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
}

object (FieldMetadata)

地址的中繼資料。

string

地址的非結構化值。如果使用者未設定，系統會自動透過結構化值建構。

string

地址的類型。類型可以是自訂值，也可以是下列其中一個預先定義的值：

• home
• work
• other

string

僅供輸出。依據檢視者帳戶語言代碼或 Accept-Language HTTP 標頭語言代碼所翻譯及設定的地址類型。

string

郵政方塊內輸入地址

string

街道地址。

string

地址的延伸地址；例如公寓號碼

string

地址所在的城市。

string

位址所在區域；例如州或省

string

地址的郵遞區號。

string

地址所在國家/地區。

string

地址的 ISO 3166-1 alpha-2 國家/地區代碼。

{
  "primary": boolean,
  "sourcePrimary": boolean,
  "verified": boolean,
  "source": {
    object (Source)
  }
}

boolean

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

boolean

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

boolean

僅供輸出。如果欄位已通過驗證，則為「是」；如果欄位未驗證，則為 false。已驗證的欄位通常包括名稱、電子郵件地址、電話號碼或網站，且經確認為本人所有。

object (Source)

欄位來源。

{
  "metadata": {
    object (FieldMetadata)
  },
  "ageRange": enum (AgeRange)
}

object (FieldMetadata)

年齡層的中繼資料。

enum (AgeRange)

年齡層。

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "contentType": enum (ContentType)
}

object (FieldMetadata)

簡介的中繼資料。

string

個人簡介。

enum (ContentType)

簡介的內容類型，

{
  "metadata": {
    object (FieldMetadata)
  },
  "date": {
    object (Date)
  },
  "text": string
}

object (FieldMetadata)

生日相關中繼資料。

object (Date)

結構化的生日日期。

string

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

代表使用者的生日的任意格式字串。這個值未經驗證。

{
  "year": integer,
  "month": integer,
  "day": integer
}

integer

日期的年份。這個值必須介於 1 至 9999，或 0 之間可指定不含年份的日期。

integer

一年中的月份。必須介於 1 到 12 之間，或 0 可以指定不含月份和日期的年份。

integer

一個月中的第幾天。這個值必須介於 1 至 31 之間，且有效的年份和月份；或 0 可讓您指定本身或年份和月份，但這些日期不明顯。

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

object (FieldMetadata)

輝煌事權的中繼資料。

string

輝煌事蹟；例如 climbed mount everest。

{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "type": string,
  "formattedType": string
}

object (FieldMetadata)

日曆網址的中繼資料。

string

日曆網址。

string

日曆網址的類型。類型可以是自訂值，也可以是下列其中一個預先定義的值：

• home
• freeBusy
• work

string

僅供輸出。日曆網址的類型，按照檢視者的帳戶語言代碼或 Accept-Language HTTP 標頭語言代碼進行翻譯。

{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}

object (FieldMetadata)

客戶資料的中繼資料。

string

用戶端指定的客戶資料金鑰。

string

用戶端指定客戶資料的值。

{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}

object (FieldMetadata)

封面相片的中繼資料。

string

封面相片的網址。

boolean

如果封面相片是預設的封面相片，則為「是」；如果封面相片是使用者提供的封面相片，則為「false」。

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string,
  "displayName": string
}

object (FieldMetadata)

電子郵件地址的中繼資料。

string

電子郵件地址。

string

電子郵件地址的類型。類型可以是自訂值，也可以是下列其中一個預先定義的值：

• home
• work
• other

string

僅供輸出。根據檢視者帳戶語言代碼或 Accept-Language HTTP 標頭語言代碼，翻譯及設定的電子郵件地址類型。

string

電子郵件的顯示名稱。

{
  "metadata": {
    object (FieldMetadata)
  },
  "date": {
    object (Date)
  },
  "type": string,
  "formattedType": string
}

object (FieldMetadata)

事件的中繼資料。

object (Date)

事件的日期。

string

事件的類型。類型可以是自訂值，也可以是下列其中一個預先定義的值：

• anniversary
• other

string

僅供輸出。事件類型，採用檢視者帳戶語言代碼或 Accept-Language HTTP 標頭語言代碼，且已翻譯及設定格式。

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}

object (FieldMetadata)

外部 ID 的相關中繼資料。

string

外部 ID 的值。

string

外部 ID 的類型。類型可以是自訂值，也可以是下列其中一個預先定義的值：

• account
• customer
• loginId
• network
• organization

string

僅供輸出。事件類型，採用檢視者帳戶語言代碼或 Accept-Language HTTP 標頭語言代碼，且已翻譯及設定格式。

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

object (FieldMetadata)

關於檔案的中繼資料。

string

檔案做為值

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string,
  "addressMeAs": string
}

object (FieldMetadata)

性別中繼資料。

string

聯絡人的性別。性別可以是自訂或下列其中一個預先定義的值：

• male
• female
• unspecified

string

僅供輸出。依據觀眾帳戶語言代碼或 Accept-Language HTTP 標頭語言代碼中，翻譯及格式化的性別值。未指定或自訂的值不會本地化。

string

任意形式的代名詞文字欄位，用來稱呼對方。常見的值如下：

• he/him
• she/her
• they/them

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

object (FieldMetadata)

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

string

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

string

即時訊息用戶端的類型。類型可以是自訂值，也可以是下列其中一個預先定義的值：

• home
• work
• other

string

僅供輸出。根據檢視者帳戶語言代碼或 Accept-Language HTTP 標頭語言代碼，翻譯及設定格式的即時訊息用戶端類型。

string

IM 用戶端的通訊協定。通訊協定可以是自訂值，或下列其中一個預先定義的值：

• aim
• msn
• yahoo
• skype
• qq
• googleTalk
• icq
• jabber
• netMeeting

string

僅供輸出。採用觀眾帳戶語言代碼或 Accept-Language HTTP 標頭語言代碼中的 IM 用戶端通訊協定。

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

object (FieldMetadata)

興趣的相關中繼資料。

string

利益；例如 stargazing。

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

object (FieldMetadata)

語言代碼的相關中繼資料。

string

格式正確的 IETF BCP 47 語言標記，代表語言代碼。

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

object (FieldMetadata)

位置的相關中繼資料。

string

地點的任意形式值。

string

地點的類型。類型可以是自訂值，也可以是下列其中一個預先定義的值：

• desk
• grewUp

boolean

指出位置是否為目前所在位置。

string

建築物 ID。

string

樓層名稱或號碼。

string

「floor_name」的樓層。

string

個別桌面位置。

{
  "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.
}

object (FieldMetadata)

成員資格的中繼資料。

object (ContactGroupMembership)

聯絡人群組成員。

object (DomainMembership)

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

{
  "contactGroupId": string,
  "contactGroupResourceName": string
}

string

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

string

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

{
  "inViewerDomain": boolean
}

boolean

如果使用者是檢視者的 Google Workspace 網域，則為「是」。

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

object (FieldMetadata)

其他關鍵字的相關中繼資料。

string

其他關鍵字的值。

enum (KeywordType)

其他關鍵字類型。

string

僅供輸出。其他經翻譯及格式化的關鍵字類型，採用檢視者的帳戶語言代碼或 Accept-Language HTTP 標頭語言代碼。

{
  "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
}

object (FieldMetadata)

名稱的相關中繼資料。

string

僅供輸出。根據觀眾帳戶或 Accept-Language HTTP 標頭指定的語言代碼設定顯示名稱。

string

僅供輸出。顯示姓氏的名字 (根據觀眾帳戶或 Accept-Language HTTP 標頭指定的語言代碼)。

string

任意形式的名稱值。

string

姓氏。

string

指定名稱。

string

中間名。

string

熱門前置字元，例如 Mrs. 或 Dr.

string

榮譽字尾，例如 Jr.

string

全名拼出完整姓名。

string

姓氏的拼音。

string

名字拼出這個名字。

string

中間名的拼音。

string

以原音拼出的名詞首字母拼出。

string

這句話是出自於發音的榮耀。

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": enum (NicknameType)
}

object (FieldMetadata)

暱稱的中繼資料。

string

暱稱。

enum (NicknameType)

暱稱的類型。

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

object (FieldMetadata)

職業的中繼資料。

string

職業；例如 carpenter。

{
  "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
}

object (FieldMetadata)

機構的相關中繼資料。

string

機構類型。類型可以是自訂值，也可以是下列其中一個預先定義的值：

• work
• school

string

僅供輸出。採用檢視者帳戶語言代碼或 Accept-Language HTTP 標頭語言代碼的翻譯及格式機構類型。

object (Date)

人員加入機構的開始日期。

object (Date)

使用者離職時的結束日期。

boolean

如果機構是使用者目前的機構，則為「是」；如果機構是過去的機構，則為 false。

string

機構名稱。

string

機構拼音名稱。

string

機構中人員的部門。

string

使用者在機構中的職稱。

string

人員在機構的職務說明。

string

與機構相關的符號；例如股票代號、縮寫或首字母縮寫

string

與機構相關聯的網域名稱；例如 google.com。

string

聯絡人在機構辦公室的所在位置。

string

機構員工的成本中心。

integer

機構內該名員工的全職同等毫秒數 (100000 = 100%)。

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "canonicalForm": string,
  "type": string,
  "formattedType": string
}

object (FieldMetadata)

電話號碼相關中繼資料。

string

電話號碼。

string

僅供輸出。電話號碼的標準 ITU-T E.164 格式。

string

電話號碼的類型。類型可以是自訂值，也可以是下列其中一個預先定義的值：

• home
• work
• mobile
• homeFax
• workFax
• otherFax
• pager
• workMobile
• workPager
• main
• googleVoice
• other

string

僅供輸出。按照觀眾帳戶語言代碼或 Accept-Language HTTP 標頭語言代碼中，翻譯及設定的電話號碼類型。

{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}

object (FieldMetadata)

相片的中繼資料。

string

相片的網址。如要變更所需大小，請在網址結尾附加查詢參數 sz={size}，其中 {size} 代表大小 (以像素為單位)。範例：https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

boolean

如果相片是預設相片，則為「是」；如果相片是使用者提供的相片，則為「false」。

{
  "metadata": {
    object (FieldMetadata)
  },
  "person": string,
  "type": string,
  "formattedType": string
}

object (FieldMetadata)

關於關係的中繼資料。

string

這個關係所指的他人姓名。

string

對方之間的關係。類型可以是自訂值，也可以是下列其中一個預先定義的值：

• spouse
• child
• mother
• father
• parent
• brother
• sister
• friend
• relative
• domesticPartner
• manager
• assistant
• referredBy
• partner

string

僅供輸出。依據觀眾帳戶語言代碼或 Accept-Language HTTP 標頭中指定的語言代碼，翻譯及設定格式的關係類型。

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}

object (FieldMetadata)

關於關係興趣的中繼資料。

string

對方正在尋找的關係類型。自訂值可以是自訂值，也可以輸入下列其中一個預先定義的值：

• friend
• date
• relationship
• networking

string

僅供輸出。以觀眾帳戶語言代碼或 Accept-Language HTTP 標頭中指定的語言代碼，翻譯及設定關係興趣的值。

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}

object (FieldMetadata)

關係狀態的中繼資料。

string

關係狀態。自訂值可以是自訂值，也可以輸入下列其中一個預先定義的值：

• single
• inARelationship
• engaged
• married
• itsComplicated
• openRelationship
• widowed
• inDomesticPartnership
• inCivilUnion

string

僅供輸出。透過檢視者帳戶語言代碼或 Accept-Language HTTP 標頭語言代碼，翻譯及設定關係狀態的值。

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "current": boolean
}

object (FieldMetadata)

住家的中繼資料。

string

居住地址。

boolean

如果居住地為對方目前的居住地，則為 True；如果居留為之前的居住地，則為 false。

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}

object (FieldMetadata)

SIP 位址的相關中繼資料。

string

RFC 3261 19.1 SIP URI 格式的 SIP 位址。

string

SIP 位址的類型。類型可以是自訂值，也可以是下列其中一個預先定義的值：

• home
• work
• mobile
• other

string

僅供輸出。依據檢視者帳戶語言代碼或「Accept-Language」HTTP 標頭語言代碼翻譯及格式化的 SIP 位址類型。

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

object (FieldMetadata)

技能的中繼資料。

string

技能；例如 underwater basket weaving。

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

object (FieldMetadata)

標語的中繼資料。

string

標語。

{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}

object (FieldMetadata)

網址的中繼資料。

string

網址。

string

網址的類型。類型可以是自訂值，也可以是下列其中一個預先定義的值：

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

string

僅供輸出。採用檢視者帳戶語言代碼或 Accept-Language HTTP 標頭語言代碼的翻譯及格式網址類型。

{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}

object (FieldMetadata)

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

string

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

string

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