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。如果 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.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

人物对象的类型。

来源

字段的来源。

JSON 表示法
{
  "type": enum (SourceType),
  "id": string,
  "etag": string,
  "updateTime": string,
  "profileMetadata": {
    object (ProfileMetadata)
  }
}
字段
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"

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)

字段的来源。

AgeRange

已弃用(请改用 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,则表示仅指定年份,也可以指定年份和月份,但不指定日期。

晒一晒

已弃用:不会返回任何人的自夸权利。

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。

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 标头语言区域中,经过翻译和格式设置的事件的类型。

外部 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)

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

username

string

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

type

string

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

  • home
  • work
  • other
formattedType

string

仅供输出。IM 客户端的类型,在查看者的帐号语言区域或 Accept-Language HTTP 标头语言区域中进行了翻译和格式设置。

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

建筑物标识符。

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

仅供输出。联系人群组成员资格的联系人群组 ID。

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

用户姓名的简短版本。

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

人员在组织内的全职同等比例(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

创建一批新联系人并返回针对新联系人的 PersonResponse

应依序发送针对同一用户的转变请求,以避免延迟时间增加和失败。

batchDeleteContacts

删除一批联系人。

batchUpdateContacts

更新一批联系人,并为更新后的联系人返回资源名称到 PersonResponse 的映射。

createContact

创建一个新的联系人并返回该联系人的人员资源。

deleteContact

删除联系人。

deleteContactPhoto

删除联系人的照片。

get

通过指定资源名称来提供某人的相关信息。

getBatchGet

通过指定所请求资源名称的列表,提供关于特定人员列表的信息。

listDirectoryPeople

提供经过身份验证的用户网域目录中的网域个人资料和网域联系人的列表。

searchContacts

提供已通过身份验证的用户的分组联系人中与搜索查询匹配的联系人列表。

searchDirectoryPeople

提供经过身份验证的用户网域目录中与搜索查询相匹配的网域个人资料和网域联系人的列表。

updateContact

更新现有联系人的联系人数据。

updateContactPhoto

更新联系人的照片。