Person
Stay organized with collections
Save and categorize content based on your preferences.
Object to represent a person.
| JSON representation |
{
"name": string,
"obfuscatedId": string,
"personNames": [
{
object (Name)
}
],
"emailAddresses": [
{
object (EmailAddress)
}
],
"phoneNumbers": [
{
object (PhoneNumber)
}
],
"photos": [
{
object (Photo)
}
]
} |
| Fields |
name |
string
The resource name of the person to provide information about. See People.get from the Google People API.
|
obfuscatedId |
string
Obfuscated id of a person.
|
personNames[] |
object (Name)
The person's name
|
emailAddresses[] |
object (EmailAddress)
The person's email addresses
|
phoneNumbers[] |
object (PhoneNumber)
The person's phone numbers
|
photos[] |
object (Photo)
A person's read-only photo. A picture shown next to the person's name to help others recognize the person in search results.
|
Name
| JSON representation |
{
"displayName": string
} |
| Fields |
displayName |
string
The read-only display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.
|
EmailAddress
A person's email address.
| JSON representation |
{
"emailAddress": string,
"primary": boolean,
"type": string,
"customType": string,
"emailUrl": string
} |
| Fields |
emailAddress |
string
The email address.
|
primary |
boolean
Indicates if this is the user's primary email. Only one entry can be marked as primary.
|
type |
string
The type of the email account. Acceptable values are: "custom", "home", "other", "work".
|
customType |
string
If the value of type is custom, this property contains the custom type string.
|
emailUrl |
string
The URL to send email.
|
PhoneNumber.PhoneNumberType
| Enums |
OTHER |
|
MOBILE |
|
OFFICE |
|
Photo
| JSON representation |
{
"url": string
} |
| Fields |
url |
string
The URL of the photo.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-04 UTC.
[null,null,["Last updated 2025-04-04 UTC."],[],[],null,["# Person\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [Name](#Name)\n - [JSON representation](#Name.SCHEMA_REPRESENTATION)\n- [EmailAddress](#EmailAddress)\n - [JSON representation](#EmailAddress.SCHEMA_REPRESENTATION)\n- [PhoneNumber](#PhoneNumber)\n - [JSON representation](#PhoneNumber.SCHEMA_REPRESENTATION)\n- [PhoneNumber.PhoneNumberType](#PhoneNumber.PhoneNumberType)\n- [Photo](#Photo)\n - [JSON representation](#Photo.SCHEMA_REPRESENTATION)\n\nObject to represent a person.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"obfuscatedId\": string, \"personNames\": [ { object (/workspace/cloud-search/docs/reference/rest/v1/Person#Name) } ], \"emailAddresses\": [ { object (/workspace/cloud-search/docs/reference/rest/v1/Person#EmailAddress) } ], \"phoneNumbers\": [ { object (/workspace/cloud-search/docs/reference/rest/v1/Person#PhoneNumber) } ], \"photos\": [ { object (/workspace/cloud-search/docs/reference/rest/v1/Person#Photo) } ] } ``` |\n\n| Fields ||\n|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The resource name of the person to provide information about. See [`People.get`](https://developers.google.com/people/api/rest/v1/people/get) from the Google People API. |\n| `obfuscatedId` | `string` Obfuscated id of a person. |\n| `personNames[]` | `object (`[Name](/workspace/cloud-search/docs/reference/rest/v1/Person#Name)`)` The person's name |\n| `emailAddresses[]` | `object (`[EmailAddress](/workspace/cloud-search/docs/reference/rest/v1/Person#EmailAddress)`)` The person's email addresses |\n| `phoneNumbers[]` | `object (`[PhoneNumber](/workspace/cloud-search/docs/reference/rest/v1/Person#PhoneNumber)`)` The person's phone numbers |\n| `photos[]` | `object (`[Photo](/workspace/cloud-search/docs/reference/rest/v1/Person#Photo)`)` A person's read-only photo. A picture shown next to the person's name to help others recognize the person in search results. |\n\nName\n----\n\nA person's name.\n\n| JSON representation |\n|-----------------------------------|\n| ``` { \"displayName\": string } ``` |\n\n| Fields ||\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| `displayName` | `string` The read-only display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header. |\n\nEmailAddress\n------------\n\nA person's email address.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------|\n| ``` { \"emailAddress\": string, \"primary\": boolean, \"type\": string, \"customType\": string, \"emailUrl\": string } ``` |\n\n| Fields ||\n|----------------|---------------------------------------------------------------------------------------------------|\n| `emailAddress` | `string` The email address. |\n| `primary` | `boolean` Indicates if this is the user's primary email. Only one entry can be marked as primary. |\n| `type` | `string` The type of the email account. Acceptable values are: \"custom\", \"home\", \"other\", \"work\". |\n| `customType` | `string` If the value of type is custom, this property contains the custom type string. |\n| `emailUrl` | `string` The URL to send email. |\n\nPhoneNumber\n-----------\n\nA person's Phone Number\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"phoneNumber\": string, \"type\": enum (/workspace/cloud-search/docs/reference/rest/v1/Person#PhoneNumber.PhoneNumberType) } ``` |\n\n| Fields ||\n|---------------|-----------------------------------------------------------------------------------------------------------------------------|\n| `phoneNumber` | `string` The phone number of the person. |\n| `type` | `enum (`[PhoneNumber.PhoneNumberType](/workspace/cloud-search/docs/reference/rest/v1/Person#PhoneNumber.PhoneNumberType)`)` |\n\nPhoneNumber.PhoneNumberType\n---------------------------\n\nPhone number type enum.\n\n| Enums ||\n|----------|---|\n| `OTHER` | |\n| `MOBILE` | |\n| `OFFICE` | |\n\nPhoto\n-----\n\nA person's photo.\n\n| JSON representation |\n|---------------------------|\n| ``` { \"url\": string } ``` |\n\n| Fields ||\n|-------|--------------------------------|\n| `url` | `string` The URL of the photo. |"]]
