- Resource: Person
- JSON representation
- PersonMetadata
- Source
- SourceType
- ProfileMetadata
- ObjectType
- UserType
- Address
- FieldMetadata
- AgeRange
- AgeRangeType
- Biography
- ContentType
- Birthday
- Date
- BraggingRights
- CalendarUrl
- ClientData
- CoverPhoto
- EmailAddress
- Event
- ExternalId
- FileAs
- Gender
- ImClient
- Interest
- Locale
- Location
- Membership
- ContactGroupMembership
- DomainMembership
- MiscKeyword
- KeywordType
- Name
- Nickname
- NicknameType
- Occupation
- Organization
- PhoneNumber
- Photo
- Relation
- RelationshipInterest
- RelationshipStatus
- Residence
- SipAddress
- Skill
- Tagline
- Url
- UserDefined
- Methods
Resource: Person
Information about a person merged from various data sources such as the authenticated user's contacts and profile data.
Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with metadata.primary
set to true.
JSON representation | |
---|---|
{ "resourceName": string, "etag": string, "metadata": { object ( |
Fields | |
---|---|
resourceName |
The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of |
etag |
The HTTP entity tag of the resource. Used for web cache validation. |
metadata |
Output only. Metadata about the person. |
addresses[] |
The person's street addresses. |
ageRange |
Output only. DEPRECATED (Please use The person's age range. |
ageRanges[] |
Output only. The person's age ranges. |
biographies[] |
The person's biographies. This field is a singleton for contact sources. |
birthdays[] |
The person's birthdays. This field is a singleton for contact sources. |
braggingRights[] |
DEPRECATED: No data will be returned The person's bragging rights. |
calendarUrls[] |
The person's calendar URLs. |
clientData[] |
The person's client data. |
coverPhotos[] |
Output only. The person's cover photos. |
emailAddresses[] |
The person's email addresses. |
events[] |
The person's events. |
externalIds[] |
The person's external IDs. |
fileAses[] |
The person's file-ases. |
genders[] |
The person's genders. This field is a singleton for contact sources. |
imClients[] |
The person's instant messaging clients. |
interests[] |
The person's interests. |
locales[] |
The person's locale preferences. |
locations[] |
The person's locations. |
memberships[] |
The person's group memberships. |
miscKeywords[] |
The person's miscellaneous keywords. |
names[] |
The person's names. This field is a singleton for contact sources. |
nicknames[] |
The person's nicknames. |
occupations[] |
The person's occupations. |
organizations[] |
The person's past or current organizations. |
phoneNumbers[] |
The person's phone numbers. |
photos[] |
Output only. The person's photos. |
relations[] |
The person's relations. |
relationshipInterests[] |
Output only. DEPRECATED: No data will be returned The person's relationship interests. |
relationshipStatuses[] |
Output only. DEPRECATED: No data will be returned The person's relationship statuses. |
residences[] |
DEPRECATED: (Please use |
sipAddresses[] |
The person's SIP addresses. |
skills[] |
The person's skills. |
taglines[] |
Output only. DEPRECATED: No data will be returned The person's taglines. |
urls[] |
The person's associated URLs. |
userDefined[] |
The person's user defined data. |
PersonMetadata
The metadata about a person.
JSON representation | |
---|---|
{ "sources": [ { object ( |
Fields | |
---|---|
sources[] |
The sources of data for the person. |
previousResourceNames[] |
Output only. Any former resource names this person has had. Populated only for The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL. |
linkedPeopleResourceNames[] |
Output only. Resource names of people linked to this resource. |
deleted |
Output only. True if the person resource has been deleted. Populated only for |
objectType |
Output only. DEPRECATED (Please use The type of the person object. |
Source
The source of a field.
JSON representation | |
---|---|
{ "type": enum ( |
Fields | |
---|---|
type |
The source type. |
id |
The unique identifier within the source type generated by the server. |
etag |
Only populated in The HTTP entity tag of the source. Used for web cache validation. |
updateTime |
Output only. Only populated in Last update timestamp of this source. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
profileMetadata |
Output only. Only populated in Metadata about a source of type PROFILE. |
SourceType
The type of a source.
Enums | |
---|---|
SOURCE_TYPE_UNSPECIFIED |
Unspecified. |
ACCOUNT |
Google Account. |
PROFILE |
Google profile. You can view the profile at https://profiles.google.com/{id}, where {id} is the source id. |
DOMAIN_PROFILE |
G Suite domain profile. |
CONTACT |
Google contact. You can view the contact at https://contact.google.com/{id}, where {id} is the source id. |
OTHER_CONTACT |
Google "Other contact". |
DOMAIN_CONTACT |
G Suite domain shared contact. |
ProfileMetadata
The metadata about a profile.
JSON representation | |
---|---|
{ "objectType": enum ( |
Fields | |
---|---|
objectType |
Output only. The profile object type. |
userTypes[] |
Output only. The user types. |
ObjectType
The type of a person object.
Enums | |
---|---|
OBJECT_TYPE_UNSPECIFIED |
Unspecified. |
PERSON |
Person. |
PAGE |
Currents Page. |
UserType
The type of the user.
Enums | |
---|---|
USER_TYPE_UNKNOWN |
The user type is not known. |
GOOGLE_USER |
The user is a Google user. |
GPLUS_USER |
The user is a Currents user. |
GOOGLE_APPS_USER |
The user is a G Suite user. |
Address
A person's physical address. May be a P.O. box or street address. All fields are optional.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the address. |
formattedValue |
The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values. |
type |
The type of the address. The type can be custom or one of these predefined values:
|
formattedType |
Output only. The type of the address translated and formatted in the viewer's account locale or the |
poBox |
The P.O. box of the address. |
streetAddress |
The street address. |
extendedAddress |
The extended address of the address; for example, the apartment number. |
city |
The city of the address. |
region |
The region of the address; for example, the state or province. |
postalCode |
The postal code of the address. |
country |
The country of the address. |
countryCode |
The ISO 3166-1 alpha-2 country code of the address. |
FieldMetadata
Metadata about a field.
JSON representation | |
---|---|
{
"primary": boolean,
"verified": boolean,
"source": {
object ( |
Fields | |
---|---|
primary |
True if the field is the primary field; false if the field is a secondary field. |
verified |
Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person. |
source |
The source of the field. |
AgeRange
DEPRECATED (Please use person.ageRanges
instead)
An age range of a person.
Enums | |
---|---|
AGE_RANGE_UNSPECIFIED |
Unspecified. |
LESS_THAN_EIGHTEEN |
Younger than eighteen. |
EIGHTEEN_TO_TWENTY |
Between eighteen and twenty. |
TWENTY_ONE_OR_OLDER |
Twenty-one and older. |
AgeRangeType
A person's age range.
JSON representation | |
---|---|
{ "metadata": { object ( |
Fields | |
---|---|
metadata |
Metadata about the age range. |
ageRange |
The age range. |
Biography
A person's short biography.
JSON representation | |
---|---|
{ "metadata": { object ( |
Fields | |
---|---|
metadata |
Metadata about the biography. |
value |
The short biography. |
contentType |
The content type of the biography. |
ContentType
The type of content.
Enums | |
---|---|
CONTENT_TYPE_UNSPECIFIED |
Unspecified. |
TEXT_PLAIN |
Plain text. |
TEXT_HTML |
HTML text. |
Birthday
A person's birthday. At least one of the date
and text
fields are specified. The date
and text
fields typically represent the same date, but are not guaranteed to.
JSON representation | |
---|---|
{ "metadata": { object ( |
Fields | |
---|---|
metadata |
Metadata about the birthday. |
date |
The date of the birthday. |
text |
A free-form string representing the user's birthday. |
Date
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:
- A full date, with non-zero year, month, and day values
- A month and day value, with a zero year, such as an anniversary
- A year on its own, with zero month and day values
- A year and month value, with a zero day, such as a credit card expiration date
Related types are google.type.TimeOfDay
and google.protobuf.Timestamp
.
JSON representation | |
---|---|
{ "year": integer, "month": integer, "day": integer } |
Fields | |
---|---|
year |
Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
month |
Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
day |
Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
BraggingRights
DEPRECATED: No data will be returned A person's bragging rights.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the bragging rights. |
value |
The bragging rights; for example, |
CalendarUrl
A person's calendar URL.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the calendar URL. |
url |
The calendar URL. |
type |
The type of the calendar URL. The type can be custom or one of these predefined values:
|
formattedType |
Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the |
ClientData
Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the client data. |
key |
The client specified key of the client data. |
value |
The client specified value of the client data. |
CoverPhoto
A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the cover photo. |
url |
The URL of the cover photo. |
default |
True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo. |
EmailAddress
A person's email address.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the email address. |
value |
The email address. |
type |
The type of the email address. The type can be custom or one of these predefined values:
|
formattedType |
Output only. The type of the email address translated and formatted in the viewer's account locale or the |
displayName |
The display name of the email. |
Event
An event related to the person.
JSON representation | |
---|---|
{ "metadata": { object ( |
Fields | |
---|---|
metadata |
Metadata about the event. |
date |
The date of the event. |
type |
The type of the event. The type can be custom or one of these predefined values:
|
formattedType |
Output only. The type of the event translated and formatted in the viewer's account locale or the |
ExternalId
An identifier from an external entity related to the person.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the external ID. |
value |
The value of the external ID. |
type |
The type of the external ID. The type can be custom or one of these predefined values:
|
formattedType |
Output only. The type of the event translated and formatted in the viewer's account locale or the |
FileAs
The name that should be used to sort the person in a list.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the file-as. |
value |
The file-as value |
Gender
A person's gender.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the gender. |
value |
The gender for the person. The gender can be custom or one of these predefined values:
|
formattedValue |
Output only. The value of the gender translated and formatted in the viewer's account locale or the |
addressMeAs |
The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values:
|
ImClient
A person's instant messaging client.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the IM client. |
username |
The user name used in the IM client. |
type |
The type of the IM client. The type can be custom or one of these predefined values:
|
formattedType |
Output only. The type of the IM client translated and formatted in the viewer's account locale or the |
protocol |
The protocol of the IM client. The protocol can be custom or one of these predefined values:
|
formattedProtocol |
Output only. The protocol of the IM client formatted in the viewer's account locale or the |
Interest
One of the person's interests.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the interest. |
value |
The interest; for example, |
Locale
A person's locale preference.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the locale. |
value |
The well-formed IETF BCP 47 language tag representing the locale. |
Location
A person's location.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the location. |
value |
The free-form value of the location. |
type |
The type of the location. The type can be custom or one of these predefined values:
|
current |
Whether the location is the current location. |
buildingId |
The building identifier. |
floor |
The floor name or number. |
floorSection |
The floor section in |
deskCode |
The individual desk location. |
Membership
A person's membership in a group. Only contact group memberships can be modified.
JSON representation | |
---|---|
{ "metadata": { object ( |
Fields | ||
---|---|---|
metadata |
Metadata about the membership. |
|
Union field membership . The membership. membership can be only one of the following: |
||
contactGroupMembership |
The contact group membership. |
|
domainMembership |
Output only. The domain membership. |
ContactGroupMembership
A Google contact group membership.
JSON representation | |
---|---|
{ "contactGroupId": string, "contactGroupResourceName": string } |
Fields | |
---|---|
contactGroupId |
Output only. The contact group ID for the contact group membership. |
contactGroupResourceName |
The resource name for the contact group, assigned by the server. An ASCII string, in the form of |
DomainMembership
A G Suite Domain membership.
JSON representation | |
---|---|
{ "inViewerDomain": boolean } |
Fields | |
---|---|
inViewerDomain |
True if the person is in the viewer's G Suite domain. |
MiscKeyword
A person's miscellaneous keyword.
JSON representation | |
---|---|
{ "metadata": { object ( |
Fields | |
---|---|
metadata |
Metadata about the miscellaneous keyword. |
value |
The value of the miscellaneous keyword. |
type |
The miscellaneous keyword type. |
formattedType |
Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the |
KeywordType
Type of miscellaneous keyword.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Unspecified. |
OUTLOOK_BILLING_INFORMATION |
Outlook field for billing information. |
OUTLOOK_DIRECTORY_SERVER |
Outlook field for directory server. |
OUTLOOK_KEYWORD |
Outlook field for keyword. |
OUTLOOK_MILEAGE |
Outlook field for mileage. |
OUTLOOK_PRIORITY |
Outlook field for priority. |
OUTLOOK_SENSITIVITY |
Outlook field for sensitivity. |
OUTLOOK_SUBJECT |
Outlook field for subject. |
OUTLOOK_USER |
Outlook field for user. |
HOME |
Home. |
WORK |
Work. |
OTHER |
Other. |
Name
A person's name. If the name is a mononym, the family name is empty.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the name. |
displayName |
Output only. The display name formatted according to the locale specified by the viewer's account or the |
displayNameLastFirst |
Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the |
unstructuredName |
The free form name value. |
familyName |
The family name. |
givenName |
The given name. |
middleName |
The middle name(s). |
honorificPrefix |
The honorific prefixes, such as |
honorificSuffix |
The honorific suffixes, such as |
phoneticFullName |
The full name spelled as it sounds. |
phoneticFamilyName |
The family name spelled as it sounds. |
phoneticGivenName |
The given name spelled as it sounds. |
phoneticMiddleName |
The middle name(s) spelled as they sound. |
phoneticHonorificPrefix |
The honorific prefixes spelled as they sound. |
phoneticHonorificSuffix |
The honorific suffixes spelled as they sound. |
Nickname
A person's nickname.
JSON representation | |
---|---|
{ "metadata": { object ( |
Fields | |
---|---|
metadata |
Metadata about the nickname. |
value |
The nickname. |
type |
The type of the nickname. |
NicknameType
The type of a nickname.
Enums | |
---|---|
DEFAULT |
Generic nickname. |
MAIDEN_NAME |
Maiden name or birth family name. Used when the person's family name has changed as a result of marriage. |
INITIALS |
Initials. |
GPLUS |
Google+ profile nickname. |
OTHER_NAME |
A professional affiliation or other name; for example, |
ALTERNATE_NAME |
Alternate name person is known by. |
SHORT_NAME |
A shorter version of the person's name. |
Occupation
A person's occupation.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the occupation. |
value |
The occupation; for example, |
Organization
A person's past or current organization. Overlapping date ranges are permitted.
JSON representation | |
---|---|
{ "metadata": { object ( |
Fields | |
---|---|
metadata |
Metadata about the organization. |
type |
The type of the organization. The type can be custom or one of these predefined values:
|
formattedType |
Output only. The type of the organization translated and formatted in the viewer's account locale or the |
startDate |
The start date when the person joined the organization. |
endDate |
The end date when the person left the organization. |
current |
True if the organization is the person's current organization; false if the organization is a past organization. |
name |
The name of the organization. |
phoneticName |
The phonetic name of the organization. |
department |
The person's department at the organization. |
title |
The person's job title at the organization. |
jobDescription |
The person's job description at the organization. |
symbol |
The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym. |
domain |
The domain name associated with the organization; for example, |
location |
The location of the organization office the person works at. |
PhoneNumber
A person's phone number.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the phone number. |
value |
The phone number. |
canonicalForm |
Output only. The canonicalized ITU-T E.164 form of the phone number. |
type |
The type of the phone number. The type can be custom or one of these predefined values:
|
formattedType |
Output only. The type of the phone number translated and formatted in the viewer's account locale or the |
Photo
A person's photo. A picture shown next to the person's name to help others recognize the person.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the photo. |
url |
The URL of the photo. You can change the desired size by appending a query parameter |
default |
True if the photo is a default photo; false if the photo is a user-provided photo. |
Relation
A person's relation to another person.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the relation. |
person |
The name of the other person this relation refers to. |
type |
The person's relation to the other person. The type can be custom or one of these predefined values:
|
formattedType |
Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header. |
RelationshipInterest
DEPRECATED: No data will be returned A person's relationship interest .
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the relationship interest. |
value |
The kind of relationship the person is looking for. The value can be custom or one of these predefined values:
|
formattedValue |
Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header. |
RelationshipStatus
DEPRECATED: No data will be returned A person's relationship status.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the relationship status. |
value |
The relationship status. The value can be custom or one of these predefined values:
|
formattedValue |
Output only. The value of the relationship status translated and formatted in the viewer's account locale or the |
Residence
DEPRECATED: Please use person.locations
instead. A person's past or current residence.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the residence. |
value |
The address of the residence. |
current |
True if the residence is the person's current residence; false if the residence is a past residence. |
SipAddress
A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the SIP address. |
value |
The SIP address in the RFC 3261 19.1 SIP URI format. |
type |
The type of the SIP address. The type can be custom or or one of these predefined values:
|
formattedType |
Output only. The type of the SIP address translated and formatted in the viewer's account locale or the |
Skill
A skill that the person has.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the skill. |
value |
The skill; for example, |
Tagline
DEPRECATED: No data will be returned A brief one-line description of the person.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the tagline. |
value |
The tagline. |
Url
A person's associated URLs.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the URL. |
value |
The URL. |
type |
The type of the URL. The type can be custom or one of these predefined values:
|
formattedType |
Output only. The type of the URL translated and formatted in the viewer's account locale or the |
UserDefined
Arbitrary user data that is populated by the end users.
JSON representation | |
---|---|
{
"metadata": {
object ( |
Fields | |
---|---|
metadata |
Metadata about the user defined data. |
key |
The end user specified key of the user defined data. |
value |
The end user specified value of the user defined data. |
Methods |
|
---|---|
|
Create a new contact and return the person resource for that contact. |
|
Delete a contact person. |
|
Delete a contact's photo. |
|
Provides information about a person by specifying a resource name. |
|
Provides information about a list of specific people by specifying a list of requested resource names. |
|
Provides a list of domain profiles and domain contacts in the authenticated user's domain directory. |
|
Provides a list of contacts in the authenticated user's grouped contacts that matches the search query. |
|
Provides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query. |
|
Update contact data for an existing contact person. |
|
Update a contact's photo. |