REST Resource: people

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

object (Source)

用户的数据来源。

string

仅供输出。此人以前拥有的所有资源名称。仅针对包含同步令牌的 people.connections.list 请求填充。

添加或移除关联联系人和个人资料的字段（如经过验证的电子邮件地址、经过验证的电话号码或个人资料网址）时，资源名称可能会更改。

string

仅供输出。与此资源相关联的用户的资源名称。

boolean

仅供输出。如果人员资源已被删除，则为 true。仅针对 people.connections.list 和 otherContacts.list 同步请求填充。

enum (ObjectType)

仅供输出。已弃用（请改用 person.metadata.sources.profileMetadata.objectType）

人物对象的类型。

{
  "type": enum (SourceType),
  "id": string,
  "etag": string,
  "updateTime": string,
  "profileMetadata": {
    object (ProfileMetadata)
  }
}

enum (SourceType)

来源类型。

string

由服务器生成的来源类型中的唯一标识符。

string

仅在 person.metadata.sources 中填充。

来源的 HTTP 实体标记。用于网络缓存验证。

string (Timestamp format)

仅供输出。仅在 person.metadata.sources 中填充。

此来源的上次更新时间戳。

时间戳采用 RFC3339 世界协调时间 (UTC)（即“祖鲁时”）格式，分辨率为纳秒，最多包含九个小数位。示例："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

仅供输出。如果该字段是人员中所有来源的主要字段，则为 True。每个人最多只能有一个字段，其中 primary 设为 true。

boolean

如果该字段是 source 的主字段，则为 true。每个来源最多只能有一个字段，其中 sourcePrimary 设为 true。

boolean

仅供输出。如果字段已验证，则为 true；如果字段未经验证，则为 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

如果封面照片是默认封面照片，则为 true；如果封面照片是用户提供的封面照片，则为 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)

与 IM 客户端相关的元数据。

string

IM 客户端中使用的用户名。

string

IM 客户端的类型。类型可以是自定义，也可以是以下某个预定义值：

• home
• work
• other

string

仅供输出。IM 客户端的类型，在查看者的帐号语言区域或 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

建筑物标识符。

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 网域中，则设为 true。

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

如果组织是此人的当前组织，则为 true；如果组织是过去的组织，则为 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

如果照片是默认照片，则为 true；如果照片是用户提供的照片，则为 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

最终用户指定的用户指定的值。