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

此人的资源名称，由服务器分配。格式为 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.list 和 otherContacts.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.list 和 otherContacts.list，电话号码数量不得超过 100 个。如果一个 Person 有多个电话号码，则可通过调用 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

仅供输出。如果人员资源已删除，则为“true”。仅为 people.connections.list 和 otherContacts.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

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

string

仅在 person.metadata.sources 中填充。

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

string (Timestamp format)

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

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

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

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

boolean

如果该字段是 source 的主要字段，则为 true。每个来源最多只能包含一个 sourcePrimary 设置为 true 的字段。
verified

boolean

仅供输出。如果该字段通过验证，则为 true；如果字段未经验证，则为 false。已验证字段通常是用户已确认其拥有的名称、电子邮件地址、电话号码或网站。
source

object (Source)

字段的来源。

AgeRange

已弃用（请改用 person.ageRanges）

个人的年龄段。

枚举
AGE_RANGE_UNSPECIFIED 未指定。
LESS_THAN_EIGHTEEN 未满 18 岁。
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 文本。

生日

个人的生日。至少指定了 date 和 text 字段中其中一个。date 和 text 字段通常表示同一日期，但不能保证。更改生日时，客户端应始终设置 date 字段。

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

object (FieldMetadata)

关于生日的元数据。
date

object (Date)

结构化的生日日期。
text
(deprecated)

string

如果已设置，请优先使用 date 字段。

表示用户生日的自由格式字符串。此值未通过验证。

日期

表示整个或部分日历日期，例如生日。时段和时区要么在别处指定，要么不重要。该日期相对于公历。这可能表示以下类型之一：

  • 包含非零年、月和日值的完整日期。
  • 年份和月份，年份为 0（例如周年纪念日）。
  • 单独的一年，零月和零日。
  • 年份和月份，日期为 0（例如，信用卡失效日期）。

相关类型：

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。

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

与此人相关的外部实体中的标识符。

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)

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

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 标头语言区域的格式。

关注度

此人的兴趣之一。

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

建筑物标识符。
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 网域，则为 true。

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 工作。
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

用户姓名的简短版本。

Occupation

个人的职业。

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

照片的网址。您可以通过在网址末尾附加查询参数 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

 更新联系人的照片。