chore: update generated docs (#1115)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/2ed9ab0e-55b4-4ab2-aede-c95e765f7376/targets
- [x] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/discovery-artifact-manager/commit/0bed8bdae25d545e796cfcdd7a9bfffff11e69da
Source-Link: https://github.com/googleapis/synthtool/commit/c2de32114ec484aa708d32012d1fa8d75232daf5
diff --git a/docs/dyn/people_v1.people.html b/docs/dyn/people_v1.people.html
index ea56f32..9913377 100644
--- a/docs/dyn/people_v1.people.html
+++ b/docs/dyn/people_v1.people.html
@@ -83,34 +83,34 @@
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
- <code><a href="#createContact">createContact(body=None, personFields=None, sources=None, x__xgafv=None)</a></code></p>
+ <code><a href="#createContact">createContact(body=None, sources=None, personFields=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a new contact and return the person resource for that contact. The request returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names</p>
<p class="toc_element">
<code><a href="#deleteContact">deleteContact(resourceName, x__xgafv=None)</a></code></p>
<p class="firstline">Delete a contact person. Any non-contact data will not be deleted.</p>
<p class="toc_element">
- <code><a href="#deleteContactPhoto">deleteContactPhoto(resourceName, sources=None, personFields=None, x__xgafv=None)</a></code></p>
+ <code><a href="#deleteContactPhoto">deleteContactPhoto(resourceName, personFields=None, sources=None, x__xgafv=None)</a></code></p>
<p class="firstline">Delete a contact's photo.</p>
<p class="toc_element">
- <code><a href="#get">get(resourceName, requestMask_includeField=None, sources=None, personFields=None, x__xgafv=None)</a></code></p>
+ <code><a href="#get">get(resourceName, requestMask_includeField=None, personFields=None, sources=None, x__xgafv=None)</a></code></p>
<p class="firstline">Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.</p>
<p class="toc_element">
- <code><a href="#getBatchGet">getBatchGet(resourceNames=None, requestMask_includeField=None, personFields=None, sources=None, x__xgafv=None)</a></code></p>
+ <code><a href="#getBatchGet">getBatchGet(personFields=None, requestMask_includeField=None, resourceNames=None, sources=None, x__xgafv=None)</a></code></p>
<p class="firstline">Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.</p>
<p class="toc_element">
- <code><a href="#listDirectoryPeople">listDirectoryPeople(mergeSources=None, readMask=None, syncToken=None, pageSize=None, sources=None, requestSyncToken=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#listDirectoryPeople">listDirectoryPeople(syncToken=None, pageSize=None, readMask=None, requestSyncToken=None, sources=None, mergeSources=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Provides a list of domain profiles and domain contacts in the authenticated user's domain directory.</p>
<p class="toc_element">
<code><a href="#listDirectoryPeople_next">listDirectoryPeople_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#searchDirectoryPeople">searchDirectoryPeople(mergeSources=None, pageSize=None, pageToken=None, query=None, readMask=None, sources=None, x__xgafv=None)</a></code></p>
+ <code><a href="#searchDirectoryPeople">searchDirectoryPeople(mergeSources=None, query=None, sources=None, pageToken=None, readMask=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Provides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query.</p>
<p class="toc_element">
<code><a href="#searchDirectoryPeople_next">searchDirectoryPeople_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#updateContact">updateContact(resourceName, body=None, sources=None, updatePersonFields=None, personFields=None, x__xgafv=None)</a></code></p>
+ <code><a href="#updateContact">updateContact(resourceName, body=None, personFields=None, sources=None, updatePersonFields=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update contact data for an existing contact person. Any non-contact data will not be modified. Any non-contact data in the person to update will be ignored. All fields specified in the `update_mask` will be replaced. The server returns a 400 error if `person.metadata.sources` is not specified for the contact to be updated or if there is no contact source. The server returns a 400 error with reason `"failedPrecondition"` if `person.metadata.sources.etag` is different than the contact's etag, which indicates the contact has changed since its data was read. Clients should get the latest person and merge their updates into the latest person. The server returns a 400 error if `memberships` are being updated and there are no contact group memberships specified on the person. The server returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names</p>
<p class="toc_element">
<code><a href="#updateContactPhoto">updateContactPhoto(resourceName, body=None, x__xgafv=None)</a></code></p>
@@ -122,7 +122,7 @@
</div>
<div class="method">
- <code class="details" id="createContact">createContact(body=None, personFields=None, sources=None, x__xgafv=None)</code>
+ <code class="details" id="createContact">createContact(body=None, sources=None, personFields=None, x__xgafv=None)</code>
<pre>Create a new contact and return the person resource for that contact. The request returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names
Args:
@@ -130,855 +130,855 @@
The object takes the form of:
{ # 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.
- "emailAddresses": [ # The person's email addresses.
- { # A person's email address.
- "value": "A String", # The email address.
- "formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the email address.
+ "clientData": [ # The person's client data.
+ { # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
+ "key": "A String", # The client specified key of the client data.
+ "metadata": { # Metadata about a field. # Metadata about the client data.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "displayName": "A String", # The display name of the email.
- "type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ "value": "A String", # The client specified value of the client data.
},
],
- "addresses": [ # The person's street addresses.
- { # A person's physical address. May be a P.O. box or street address. All fields are optional.
- "streetAddress": "A String", # The street address.
- "poBox": "A String", # The P.O. box of the address.
- "region": "A String", # The region of the address; for example, the state or province.
- "type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
- "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
- "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "postalCode": "A String", # The postal code of the address.
- "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
- "city": "A String", # The city of the address.
- "country": "A String", # The country of the address.
- "metadata": { # Metadata about a field. # Metadata about the address.
+ "ageRanges": [ # Output only. The person's age ranges.
+ { # A person's age range.
+ "ageRange": "A String", # The age range.
+ "metadata": { # Metadata about a field. # Metadata about the age range.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
- "interests": [ # The person's interests.
- { # One of the person's interests.
- "value": "A String", # The interest; for example, `stargazing`.
- "metadata": { # Metadata about a field. # Metadata about the interest.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "locations": [ # The person's locations.
- { # A person's location.
- "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
- "floor": "A String", # The floor name or number.
- "deskCode": "A String", # The individual desk location.
- "floorSection": "A String", # The floor section in `floor_name`.
- "value": "A String", # The free-form value of the location.
- "metadata": { # Metadata about a field. # Metadata about the location.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "buildingId": "A String", # The building identifier.
- "current": True or False, # Whether the location is the current location.
- },
- ],
- "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
- { # **DEPRECATED**: No data will be returned A person's relationship interest .
- "formattedValue": "A String", # 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.
- "value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
- "metadata": { # Metadata about a field. # Metadata about the relationship interest.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "names": [ # The person's names. This field is a singleton for contact sources.
- { # A person's name. If the name is a mononym, the family name is empty.
- "metadata": { # Metadata about a field. # Metadata about the name.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "phoneticFamilyName": "A String", # The family name spelled as it sounds.
- "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
- "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
- "familyName": "A String", # The family name.
- "phoneticGivenName": "A String", # The given name spelled as it sounds.
- "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
- "middleName": "A String", # The middle name(s).
- "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
- "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
- "unstructuredName": "A String", # The free form name value.
- "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
- "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
- "phoneticFullName": "A String", # The full name spelled as it sounds.
- "givenName": "A String", # The given name.
- },
- ],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
- "value": "A String", # The URL.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the URL. The type can be custom or one of these predefined values: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Currents application. * `other`
+ "value": "A String", # The URL.
"metadata": { # Metadata about a field. # Metadata about the URL.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "nicknames": [ # The person's nicknames.
- { # A person's nickname.
- "type": "A String", # The type of the nickname.
- "metadata": { # Metadata about a field. # Metadata about the nickname.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The nickname.
- },
- ],
- "imClients": [ # The person's instant messaging clients.
- { # A person's instant messaging client.
- "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "username": "A String", # The user name used in the IM client.
- "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
- "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "metadata": { # Metadata about a field. # Metadata about the IM client.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.
{ # **DEPRECATED**: No data will be returned A person's bragging rights.
"metadata": { # Metadata about a field. # Metadata about the bragging rights.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
"value": "A String", # The bragging rights; for example, `climbed mount everest`.
},
],
- "metadata": { # The metadata about a person. # Output only. Metadata about the person.
- "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. 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.
- "A String",
- ],
- "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
- "sources": [ # The sources of data for the person.
- { # The source of a field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- ],
- "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
- "A String",
- ],
- "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
- },
- "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.
- "ageRanges": [ # Output only. The person's age ranges.
- { # A person's age range.
- "ageRange": "A String", # The age range.
- "metadata": { # Metadata about a field. # Metadata about the age range.
+ "sipAddresses": [ # The person's SIP addresses.
+ { # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
+ "metadata": { # Metadata about a field. # Metadata about the SIP address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
+ "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
- "formattedType": "A String", # 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.
- "person": "A String", # The name of the other person this relation refers to.
- "type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
"metadata": { # Metadata about a field. # Metadata about the relation.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- },
- ],
- "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
- { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
- "metadata": { # Metadata about a field. # Metadata about the residence.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
- "value": "A String", # The address of the residence.
- },
- ],
- "phoneNumbers": [ # The person's phone numbers.
- { # A person's phone number.
- "value": "A String", # The phone number.
- "canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
- "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "type": "A String", # The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
- "metadata": { # Metadata about a field. # Metadata about the phone number.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
- { # **DEPRECATED**: No data will be returned A brief one-line description of the person.
- "value": "A String", # The tagline.
- "metadata": { # Metadata about a field. # Metadata about the tagline.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "genders": [ # The person's genders. This field is a singleton for contact sources.
- { # A person's gender.
- "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.
- "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`
- "metadata": { # Metadata about a field. # Metadata about the gender.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
- },
- ],
- "biographies": [ # The person's biographies. This field is a singleton for contact sources.
- { # A person's short biography.
- "value": "A String", # The short biography.
- "contentType": "A String", # The content type of the biography.
- "metadata": { # Metadata about a field. # Metadata about the biography.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
+ "formattedType": "A String", # 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.
+ "type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
+ "person": "A String", # The name of the other person this relation refers to.
},
],
"miscKeywords": [ # The person's miscellaneous keywords.
{ # A person's miscellaneous keyword.
- "type": "A String", # The miscellaneous keyword type.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "type": "A String", # The miscellaneous keyword type.
"formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"value": "A String", # The value of the miscellaneous keyword.
},
],
- "sipAddresses": [ # The person's SIP addresses.
- { # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
- "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
- "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
- "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the SIP address.
+ "biographies": [ # The person's biographies. This field is a singleton for contact sources.
+ { # A person's short biography.
+ "contentType": "A String", # The content type of the biography.
+ "metadata": { # Metadata about a field. # Metadata about the biography.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "value": "A String", # The short biography.
},
],
- "externalIds": [ # The person's external IDs.
- { # An identifier from an external entity related to the person.
- "metadata": { # Metadata about a field. # Metadata about the external ID.
+ "userDefined": [ # The person's user defined data.
+ { # Arbitrary user data that is populated by the end users.
+ "metadata": { # Metadata about a field. # Metadata about the user defined data.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "value": "A String", # The value of the external ID.
- "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
+ "key": "A String", # The end user specified key of the user defined data.
+ "value": "A String", # The end user specified value of the user defined data.
},
],
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"skills": [ # The person's skills.
{ # A skill that the person has.
+ "value": "A String", # The skill; for example, `underwater basket weaving`.
"metadata": { # Metadata about a field. # Metadata about the skill.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "value": "A String", # The skill; for example, `underwater basket weaving`.
},
],
- "birthdays": [ # The person's birthdays. This field is a singleton for contact sources.
- { # 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.
- "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "locations": [ # The person's locations.
+ { # A person's location.
+ "deskCode": "A String", # The individual desk location.
+ "buildingId": "A String", # The building identifier.
+ "value": "A String", # The free-form value of the location.
+ "current": True or False, # Whether the location is the current location.
+ "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
+ "metadata": { # Metadata about a field. # Metadata about the location.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
+ },
+ "floor": "A String", # The floor name or number.
+ "floorSection": "A String", # The floor section in `floor_name`.
+ },
+ ],
+ "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.
+ "occupations": [ # The person's occupations.
+ { # A person's occupation.
+ "value": "A String", # The occupation; for example, `carpenter`.
+ "metadata": { # Metadata about a field. # Metadata about the occupation.
"verified": True or False, # 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.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "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`. # The date of the birthday.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
+ },
+ ],
+ "fileAses": [ # The person's file-ases.
+ { # The name that should be used to sort the person in a list.
+ "metadata": { # Metadata about a field. # Metadata about the file-as.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "text": "A String", # A free-form string representing the user's birthday.
+ "value": "A String", # The file-as value
+ },
+ ],
+ "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
+ { # **DEPRECATED**: No data will be returned A person's relationship interest .
+ "formattedValue": "A String", # 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.
+ "metadata": { # Metadata about a field. # Metadata about the relationship interest.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # 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.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
"url": "A String", # The URL of the cover photo.
},
],
- "fileAses": [ # The person's file-ases.
- { # The name that should be used to sort the person in a list.
- "metadata": { # Metadata about a field. # Metadata about the file-as.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The file-as value
- },
- ],
- "clientData": [ # The person's client data.
- { # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
- "metadata": { # Metadata about a field. # Metadata about the client data.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "key": "A String", # The client specified key of the client data.
- "value": "A String", # The client specified value of the client data.
- },
- ],
- "events": [ # The person's events.
- { # An event related to the person.
- "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`. # The date of the event.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`
- "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the event.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "userDefined": [ # The person's user defined data.
- { # Arbitrary user data that is populated by the end users.
- "metadata": { # Metadata about a field. # Metadata about the user defined data.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "key": "A String", # The end user specified key of the user defined data.
- "value": "A String", # The end user specified value of the user defined data.
- },
- ],
- "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
- "organizations": [ # The person's past or current organizations.
- { # A person's past or current organization. Overlapping date ranges are permitted.
- "endDate": { # 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`. # The end date when the person left the organization.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "name": "A String", # The name of the organization.
- "metadata": { # Metadata about a field. # Metadata about the organization.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "location": "A String", # The location of the organization office the person works at.
- "title": "A String", # The person's job title at the organization.
- "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
- "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
- "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
- "phoneticName": "A String", # The phonetic name of the organization.
- "formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "department": "A String", # The person's department at the organization.
- "startDate": { # 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`. # The start date when the person joined the organization.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "jobDescription": "A String", # The person's job description at the organization.
- "type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
- },
- ],
- "occupations": [ # The person's occupations.
- { # A person's occupation.
- "metadata": { # Metadata about a field. # Metadata about the occupation.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The occupation; for example, `carpenter`.
- },
- ],
- "calendarUrls": [ # The person's calendar URLs.
- { # A person's calendar URL.
- "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
- "url": "A String", # The calendar URL.
- "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the calendar URL.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "locales": [ # The person's locale preferences.
- { # A person's locale preference.
- "metadata": { # Metadata about a field. # Metadata about the locale.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
- },
- ],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
},
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
- "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
+ "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
- "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
- { # **DEPRECATED**: No data will be returned A person's relationship status.
- "metadata": { # Metadata about a field. # Metadata about the relationship status.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
- "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- },
- ],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"metadata": { # Metadata about a field. # Metadata about the photo.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
+ },
+ "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
+ "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
+ },
+ ],
+ "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
+ { # **DEPRECATED**: No data will be returned A person's relationship status.
+ "value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
+ "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "metadata": { # Metadata about a field. # Metadata about the relationship status.
"verified": True or False, # 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.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
- "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
+ },
+ ],
+ "names": [ # The person's names. This field is a singleton for contact sources.
+ { # A person's name. If the name is a mononym, the family name is empty.
+ "familyName": "A String", # The family name.
+ "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
+ "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
+ "phoneticFamilyName": "A String", # The family name spelled as it sounds.
+ "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
+ "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
+ "phoneticFullName": "A String", # The full name spelled as it sounds.
+ "phoneticGivenName": "A String", # The given name spelled as it sounds.
+ "unstructuredName": "A String", # The free form name value.
+ "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
+ "givenName": "A String", # The given name.
+ "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
+ "metadata": { # Metadata about a field. # Metadata about the name.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "middleName": "A String", # The middle name(s).
+ "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
+ },
+ ],
+ "metadata": { # The metadata about a person. # Output only. Metadata about the person.
+ "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. 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.
+ "A String",
+ ],
+ "sources": [ # The sources of data for the person.
+ { # The source of a field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ ],
+ "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
+ "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
+ },
+ "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
+ "nicknames": [ # The person's nicknames.
+ { # A person's nickname.
+ "value": "A String", # The nickname.
+ "metadata": { # Metadata about a field. # Metadata about the nickname.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "type": "A String", # The type of the nickname.
+ },
+ ],
+ "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
+ { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
+ "metadata": { # Metadata about a field. # Metadata about the residence.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The address of the residence.
+ "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
+ },
+ ],
+ "emailAddresses": [ # The person's email addresses.
+ { # A person's email address.
+ "metadata": { # Metadata about a field. # Metadata about the email address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "displayName": "A String", # The display name of the email.
+ "value": "A String", # The email address.
+ "formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ },
+ ],
+ "locales": [ # The person's locale preferences.
+ { # A person's locale preference.
+ "metadata": { # Metadata about a field. # Metadata about the locale.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
+ },
+ ],
+ "phoneNumbers": [ # The person's phone numbers.
+ { # A person's phone number.
+ "metadata": { # Metadata about a field. # Metadata about the phone number.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
+ "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
+ "value": "A String", # The phone number.
+ },
+ ],
+ "birthdays": [ # The person's birthdays. This field is a singleton for contact sources.
+ { # 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.
+ "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "text": "A String", # 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`. # The date of the birthday.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ },
+ ],
+ "events": [ # The person's events.
+ { # An event related to the person.
+ "type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`
+ "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`. # The date of the event.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "metadata": { # Metadata about a field. # Metadata about the event.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ },
+ ],
+ "imClients": [ # The person's instant messaging clients.
+ { # A person's instant messaging client.
+ "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
+ "metadata": { # Metadata about a field. # Metadata about the IM client.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ "username": "A String", # The user name used in the IM client.
+ "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ },
+ ],
+ "organizations": [ # The person's past or current organizations.
+ { # A person's past or current organization. Overlapping date ranges are permitted.
+ "phoneticName": "A String", # The phonetic name of the organization.
+ "title": "A String", # The person's job title at the organization.
+ "type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
+ "endDate": { # 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`. # The end date when the person left the organization.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "jobDescription": "A String", # The person's job description at the organization.
+ "name": "A String", # The name of the organization.
+ "metadata": { # Metadata about a field. # Metadata about the organization.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
+ "startDate": { # 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`. # The start date when the person joined the organization.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "location": "A String", # The location of the organization office the person works at.
+ "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
+ "department": "A String", # The person's department at the organization.
+ "formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
+ },
+ ],
+ "externalIds": [ # The person's external IDs.
+ { # An identifier from an external entity related to the person.
+ "value": "A String", # The value of the external ID.
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
+ "metadata": { # Metadata about a field. # Metadata about the external ID.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ },
+ ],
+ "addresses": [ # The person's street addresses.
+ { # A person's physical address. May be a P.O. box or street address. All fields are optional.
+ "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
+ "streetAddress": "A String", # The street address.
+ "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
+ "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "city": "A String", # The city of the address.
+ "metadata": { # Metadata about a field. # Metadata about the address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "poBox": "A String", # The P.O. box of the address.
+ "region": "A String", # The region of the address; for example, the state or province.
+ "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
+ "postalCode": "A String", # The postal code of the address.
+ "country": "A String", # The country of the address.
+ "type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ },
+ ],
+ "taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
+ { # **DEPRECATED**: No data will be returned A brief one-line description of the person.
+ "metadata": { # Metadata about a field. # Metadata about the tagline.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The tagline.
+ },
+ ],
+ "genders": [ # The person's genders. This field is a singleton for contact sources.
+ { # A person's gender.
+ "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`
+ "metadata": { # Metadata about a field. # Metadata about the gender.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.
+ "value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
+ },
+ ],
+ "calendarUrls": [ # The person's calendar URLs.
+ { # A person's calendar URL.
+ "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
+ "metadata": { # Metadata about a field. # Metadata about the calendar URL.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "url": "A String", # The calendar URL.
+ },
+ ],
+ "interests": [ # The person's interests.
+ { # One of the person's interests.
+ "value": "A String", # The interest; for example, `stargazing`.
+ "metadata": { # Metadata about a field. # Metadata about the interest.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
},
],
}
- personFields: string, Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
sources: string, Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set. (repeated)
Allowed values
READ_SOURCE_TYPE_UNSPECIFIED - Unspecified.
READ_SOURCE_TYPE_PROFILE - Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.
READ_SOURCE_TYPE_CONTACT - Returns SourceType.CONTACT.
READ_SOURCE_TYPE_DOMAIN_CONTACT - Returns SourceType.DOMAIN_CONTACT.
+ personFields: string, Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -988,844 +988,844 @@
An object of the form:
{ # 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.
- "emailAddresses": [ # The person's email addresses.
- { # A person's email address.
- "value": "A String", # The email address.
- "formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the email address.
+ "clientData": [ # The person's client data.
+ { # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
+ "key": "A String", # The client specified key of the client data.
+ "metadata": { # Metadata about a field. # Metadata about the client data.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "displayName": "A String", # The display name of the email.
- "type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ "value": "A String", # The client specified value of the client data.
},
],
- "addresses": [ # The person's street addresses.
- { # A person's physical address. May be a P.O. box or street address. All fields are optional.
- "streetAddress": "A String", # The street address.
- "poBox": "A String", # The P.O. box of the address.
- "region": "A String", # The region of the address; for example, the state or province.
- "type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
- "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
- "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "postalCode": "A String", # The postal code of the address.
- "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
- "city": "A String", # The city of the address.
- "country": "A String", # The country of the address.
- "metadata": { # Metadata about a field. # Metadata about the address.
+ "ageRanges": [ # Output only. The person's age ranges.
+ { # A person's age range.
+ "ageRange": "A String", # The age range.
+ "metadata": { # Metadata about a field. # Metadata about the age range.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
- "interests": [ # The person's interests.
- { # One of the person's interests.
- "value": "A String", # The interest; for example, `stargazing`.
- "metadata": { # Metadata about a field. # Metadata about the interest.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "locations": [ # The person's locations.
- { # A person's location.
- "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
- "floor": "A String", # The floor name or number.
- "deskCode": "A String", # The individual desk location.
- "floorSection": "A String", # The floor section in `floor_name`.
- "value": "A String", # The free-form value of the location.
- "metadata": { # Metadata about a field. # Metadata about the location.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "buildingId": "A String", # The building identifier.
- "current": True or False, # Whether the location is the current location.
- },
- ],
- "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
- { # **DEPRECATED**: No data will be returned A person's relationship interest .
- "formattedValue": "A String", # 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.
- "value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
- "metadata": { # Metadata about a field. # Metadata about the relationship interest.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "names": [ # The person's names. This field is a singleton for contact sources.
- { # A person's name. If the name is a mononym, the family name is empty.
- "metadata": { # Metadata about a field. # Metadata about the name.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "phoneticFamilyName": "A String", # The family name spelled as it sounds.
- "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
- "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
- "familyName": "A String", # The family name.
- "phoneticGivenName": "A String", # The given name spelled as it sounds.
- "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
- "middleName": "A String", # The middle name(s).
- "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
- "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
- "unstructuredName": "A String", # The free form name value.
- "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
- "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
- "phoneticFullName": "A String", # The full name spelled as it sounds.
- "givenName": "A String", # The given name.
- },
- ],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
- "value": "A String", # The URL.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the URL. The type can be custom or one of these predefined values: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Currents application. * `other`
+ "value": "A String", # The URL.
"metadata": { # Metadata about a field. # Metadata about the URL.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "nicknames": [ # The person's nicknames.
- { # A person's nickname.
- "type": "A String", # The type of the nickname.
- "metadata": { # Metadata about a field. # Metadata about the nickname.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The nickname.
- },
- ],
- "imClients": [ # The person's instant messaging clients.
- { # A person's instant messaging client.
- "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "username": "A String", # The user name used in the IM client.
- "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
- "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "metadata": { # Metadata about a field. # Metadata about the IM client.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.
{ # **DEPRECATED**: No data will be returned A person's bragging rights.
"metadata": { # Metadata about a field. # Metadata about the bragging rights.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
"value": "A String", # The bragging rights; for example, `climbed mount everest`.
},
],
- "metadata": { # The metadata about a person. # Output only. Metadata about the person.
- "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. 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.
- "A String",
- ],
- "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
- "sources": [ # The sources of data for the person.
- { # The source of a field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- ],
- "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
- "A String",
- ],
- "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
- },
- "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.
- "ageRanges": [ # Output only. The person's age ranges.
- { # A person's age range.
- "ageRange": "A String", # The age range.
- "metadata": { # Metadata about a field. # Metadata about the age range.
+ "sipAddresses": [ # The person's SIP addresses.
+ { # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
+ "metadata": { # Metadata about a field. # Metadata about the SIP address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
+ "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
- "formattedType": "A String", # 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.
- "person": "A String", # The name of the other person this relation refers to.
- "type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
"metadata": { # Metadata about a field. # Metadata about the relation.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- },
- ],
- "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
- { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
- "metadata": { # Metadata about a field. # Metadata about the residence.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
- "value": "A String", # The address of the residence.
- },
- ],
- "phoneNumbers": [ # The person's phone numbers.
- { # A person's phone number.
- "value": "A String", # The phone number.
- "canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
- "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "type": "A String", # The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
- "metadata": { # Metadata about a field. # Metadata about the phone number.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
- { # **DEPRECATED**: No data will be returned A brief one-line description of the person.
- "value": "A String", # The tagline.
- "metadata": { # Metadata about a field. # Metadata about the tagline.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "genders": [ # The person's genders. This field is a singleton for contact sources.
- { # A person's gender.
- "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.
- "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`
- "metadata": { # Metadata about a field. # Metadata about the gender.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
- },
- ],
- "biographies": [ # The person's biographies. This field is a singleton for contact sources.
- { # A person's short biography.
- "value": "A String", # The short biography.
- "contentType": "A String", # The content type of the biography.
- "metadata": { # Metadata about a field. # Metadata about the biography.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
+ "formattedType": "A String", # 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.
+ "type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
+ "person": "A String", # The name of the other person this relation refers to.
},
],
"miscKeywords": [ # The person's miscellaneous keywords.
{ # A person's miscellaneous keyword.
- "type": "A String", # The miscellaneous keyword type.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "type": "A String", # The miscellaneous keyword type.
"formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"value": "A String", # The value of the miscellaneous keyword.
},
],
- "sipAddresses": [ # The person's SIP addresses.
- { # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
- "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
- "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
- "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the SIP address.
+ "biographies": [ # The person's biographies. This field is a singleton for contact sources.
+ { # A person's short biography.
+ "contentType": "A String", # The content type of the biography.
+ "metadata": { # Metadata about a field. # Metadata about the biography.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "value": "A String", # The short biography.
},
],
- "externalIds": [ # The person's external IDs.
- { # An identifier from an external entity related to the person.
- "metadata": { # Metadata about a field. # Metadata about the external ID.
+ "userDefined": [ # The person's user defined data.
+ { # Arbitrary user data that is populated by the end users.
+ "metadata": { # Metadata about a field. # Metadata about the user defined data.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "value": "A String", # The value of the external ID.
- "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
+ "key": "A String", # The end user specified key of the user defined data.
+ "value": "A String", # The end user specified value of the user defined data.
},
],
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"skills": [ # The person's skills.
{ # A skill that the person has.
+ "value": "A String", # The skill; for example, `underwater basket weaving`.
"metadata": { # Metadata about a field. # Metadata about the skill.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "value": "A String", # The skill; for example, `underwater basket weaving`.
},
],
- "birthdays": [ # The person's birthdays. This field is a singleton for contact sources.
- { # 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.
- "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "locations": [ # The person's locations.
+ { # A person's location.
+ "deskCode": "A String", # The individual desk location.
+ "buildingId": "A String", # The building identifier.
+ "value": "A String", # The free-form value of the location.
+ "current": True or False, # Whether the location is the current location.
+ "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
+ "metadata": { # Metadata about a field. # Metadata about the location.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
+ },
+ "floor": "A String", # The floor name or number.
+ "floorSection": "A String", # The floor section in `floor_name`.
+ },
+ ],
+ "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.
+ "occupations": [ # The person's occupations.
+ { # A person's occupation.
+ "value": "A String", # The occupation; for example, `carpenter`.
+ "metadata": { # Metadata about a field. # Metadata about the occupation.
"verified": True or False, # 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.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "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`. # The date of the birthday.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
+ },
+ ],
+ "fileAses": [ # The person's file-ases.
+ { # The name that should be used to sort the person in a list.
+ "metadata": { # Metadata about a field. # Metadata about the file-as.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "text": "A String", # A free-form string representing the user's birthday.
+ "value": "A String", # The file-as value
+ },
+ ],
+ "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
+ { # **DEPRECATED**: No data will be returned A person's relationship interest .
+ "formattedValue": "A String", # 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.
+ "metadata": { # Metadata about a field. # Metadata about the relationship interest.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # 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.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
"url": "A String", # The URL of the cover photo.
},
],
- "fileAses": [ # The person's file-ases.
- { # The name that should be used to sort the person in a list.
- "metadata": { # Metadata about a field. # Metadata about the file-as.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The file-as value
- },
- ],
- "clientData": [ # The person's client data.
- { # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
- "metadata": { # Metadata about a field. # Metadata about the client data.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "key": "A String", # The client specified key of the client data.
- "value": "A String", # The client specified value of the client data.
- },
- ],
- "events": [ # The person's events.
- { # An event related to the person.
- "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`. # The date of the event.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`
- "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the event.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "userDefined": [ # The person's user defined data.
- { # Arbitrary user data that is populated by the end users.
- "metadata": { # Metadata about a field. # Metadata about the user defined data.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "key": "A String", # The end user specified key of the user defined data.
- "value": "A String", # The end user specified value of the user defined data.
- },
- ],
- "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
- "organizations": [ # The person's past or current organizations.
- { # A person's past or current organization. Overlapping date ranges are permitted.
- "endDate": { # 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`. # The end date when the person left the organization.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "name": "A String", # The name of the organization.
- "metadata": { # Metadata about a field. # Metadata about the organization.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "location": "A String", # The location of the organization office the person works at.
- "title": "A String", # The person's job title at the organization.
- "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
- "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
- "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
- "phoneticName": "A String", # The phonetic name of the organization.
- "formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "department": "A String", # The person's department at the organization.
- "startDate": { # 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`. # The start date when the person joined the organization.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "jobDescription": "A String", # The person's job description at the organization.
- "type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
- },
- ],
- "occupations": [ # The person's occupations.
- { # A person's occupation.
- "metadata": { # Metadata about a field. # Metadata about the occupation.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The occupation; for example, `carpenter`.
- },
- ],
- "calendarUrls": [ # The person's calendar URLs.
- { # A person's calendar URL.
- "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
- "url": "A String", # The calendar URL.
- "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the calendar URL.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "locales": [ # The person's locale preferences.
- { # A person's locale preference.
- "metadata": { # Metadata about a field. # Metadata about the locale.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
- },
- ],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
},
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
- "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
+ "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
- "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
- { # **DEPRECATED**: No data will be returned A person's relationship status.
- "metadata": { # Metadata about a field. # Metadata about the relationship status.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
- "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- },
- ],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"metadata": { # Metadata about a field. # Metadata about the photo.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
+ },
+ "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
+ "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
+ },
+ ],
+ "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
+ { # **DEPRECATED**: No data will be returned A person's relationship status.
+ "value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
+ "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "metadata": { # Metadata about a field. # Metadata about the relationship status.
"verified": True or False, # 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.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
- "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
+ },
+ ],
+ "names": [ # The person's names. This field is a singleton for contact sources.
+ { # A person's name. If the name is a mononym, the family name is empty.
+ "familyName": "A String", # The family name.
+ "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
+ "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
+ "phoneticFamilyName": "A String", # The family name spelled as it sounds.
+ "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
+ "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
+ "phoneticFullName": "A String", # The full name spelled as it sounds.
+ "phoneticGivenName": "A String", # The given name spelled as it sounds.
+ "unstructuredName": "A String", # The free form name value.
+ "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
+ "givenName": "A String", # The given name.
+ "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
+ "metadata": { # Metadata about a field. # Metadata about the name.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "middleName": "A String", # The middle name(s).
+ "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
+ },
+ ],
+ "metadata": { # The metadata about a person. # Output only. Metadata about the person.
+ "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. 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.
+ "A String",
+ ],
+ "sources": [ # The sources of data for the person.
+ { # The source of a field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ ],
+ "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
+ "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
+ },
+ "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
+ "nicknames": [ # The person's nicknames.
+ { # A person's nickname.
+ "value": "A String", # The nickname.
+ "metadata": { # Metadata about a field. # Metadata about the nickname.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "type": "A String", # The type of the nickname.
+ },
+ ],
+ "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
+ { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
+ "metadata": { # Metadata about a field. # Metadata about the residence.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The address of the residence.
+ "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
+ },
+ ],
+ "emailAddresses": [ # The person's email addresses.
+ { # A person's email address.
+ "metadata": { # Metadata about a field. # Metadata about the email address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "displayName": "A String", # The display name of the email.
+ "value": "A String", # The email address.
+ "formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ },
+ ],
+ "locales": [ # The person's locale preferences.
+ { # A person's locale preference.
+ "metadata": { # Metadata about a field. # Metadata about the locale.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
+ },
+ ],
+ "phoneNumbers": [ # The person's phone numbers.
+ { # A person's phone number.
+ "metadata": { # Metadata about a field. # Metadata about the phone number.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
+ "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
+ "value": "A String", # The phone number.
+ },
+ ],
+ "birthdays": [ # The person's birthdays. This field is a singleton for contact sources.
+ { # 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.
+ "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "text": "A String", # 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`. # The date of the birthday.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ },
+ ],
+ "events": [ # The person's events.
+ { # An event related to the person.
+ "type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`
+ "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`. # The date of the event.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "metadata": { # Metadata about a field. # Metadata about the event.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ },
+ ],
+ "imClients": [ # The person's instant messaging clients.
+ { # A person's instant messaging client.
+ "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
+ "metadata": { # Metadata about a field. # Metadata about the IM client.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ "username": "A String", # The user name used in the IM client.
+ "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ },
+ ],
+ "organizations": [ # The person's past or current organizations.
+ { # A person's past or current organization. Overlapping date ranges are permitted.
+ "phoneticName": "A String", # The phonetic name of the organization.
+ "title": "A String", # The person's job title at the organization.
+ "type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
+ "endDate": { # 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`. # The end date when the person left the organization.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "jobDescription": "A String", # The person's job description at the organization.
+ "name": "A String", # The name of the organization.
+ "metadata": { # Metadata about a field. # Metadata about the organization.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
+ "startDate": { # 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`. # The start date when the person joined the organization.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "location": "A String", # The location of the organization office the person works at.
+ "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
+ "department": "A String", # The person's department at the organization.
+ "formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
+ },
+ ],
+ "externalIds": [ # The person's external IDs.
+ { # An identifier from an external entity related to the person.
+ "value": "A String", # The value of the external ID.
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
+ "metadata": { # Metadata about a field. # Metadata about the external ID.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ },
+ ],
+ "addresses": [ # The person's street addresses.
+ { # A person's physical address. May be a P.O. box or street address. All fields are optional.
+ "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
+ "streetAddress": "A String", # The street address.
+ "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
+ "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "city": "A String", # The city of the address.
+ "metadata": { # Metadata about a field. # Metadata about the address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "poBox": "A String", # The P.O. box of the address.
+ "region": "A String", # The region of the address; for example, the state or province.
+ "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
+ "postalCode": "A String", # The postal code of the address.
+ "country": "A String", # The country of the address.
+ "type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ },
+ ],
+ "taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
+ { # **DEPRECATED**: No data will be returned A brief one-line description of the person.
+ "metadata": { # Metadata about a field. # Metadata about the tagline.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The tagline.
+ },
+ ],
+ "genders": [ # The person's genders. This field is a singleton for contact sources.
+ { # A person's gender.
+ "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`
+ "metadata": { # Metadata about a field. # Metadata about the gender.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.
+ "value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
+ },
+ ],
+ "calendarUrls": [ # The person's calendar URLs.
+ { # A person's calendar URL.
+ "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
+ "metadata": { # Metadata about a field. # Metadata about the calendar URL.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "url": "A String", # The calendar URL.
+ },
+ ],
+ "interests": [ # The person's interests.
+ { # One of the person's interests.
+ "value": "A String", # The interest; for example, `stargazing`.
+ "metadata": { # Metadata about a field. # Metadata about the interest.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
},
],
}</pre>
@@ -1850,18 +1850,18 @@
</div>
<div class="method">
- <code class="details" id="deleteContactPhoto">deleteContactPhoto(resourceName, sources=None, personFields=None, x__xgafv=None)</code>
+ <code class="details" id="deleteContactPhoto">deleteContactPhoto(resourceName, personFields=None, sources=None, x__xgafv=None)</code>
<pre>Delete a contact's photo.
Args:
resourceName: string, Required. The resource name of the contact whose photo will be deleted. (required)
+ personFields: string, Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
sources: string, Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set. (repeated)
Allowed values
READ_SOURCE_TYPE_UNSPECIFIED - Unspecified.
READ_SOURCE_TYPE_PROFILE - Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.
READ_SOURCE_TYPE_CONTACT - Returns SourceType.CONTACT.
READ_SOURCE_TYPE_DOMAIN_CONTACT - Returns SourceType.DOMAIN_CONTACT.
- personFields: string, Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -1872,844 +1872,844 @@
{ # The response for deleteing a contact's photo.
"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. # The updated person, if person_fields is set in the DeleteContactPhotoRequest; otherwise this will be unset.
- "emailAddresses": [ # The person's email addresses.
- { # A person's email address.
- "value": "A String", # The email address.
- "formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the email address.
+ "clientData": [ # The person's client data.
+ { # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
+ "key": "A String", # The client specified key of the client data.
+ "metadata": { # Metadata about a field. # Metadata about the client data.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "displayName": "A String", # The display name of the email.
- "type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ "value": "A String", # The client specified value of the client data.
},
],
- "addresses": [ # The person's street addresses.
- { # A person's physical address. May be a P.O. box or street address. All fields are optional.
- "streetAddress": "A String", # The street address.
- "poBox": "A String", # The P.O. box of the address.
- "region": "A String", # The region of the address; for example, the state or province.
- "type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
- "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
- "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "postalCode": "A String", # The postal code of the address.
- "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
- "city": "A String", # The city of the address.
- "country": "A String", # The country of the address.
- "metadata": { # Metadata about a field. # Metadata about the address.
+ "ageRanges": [ # Output only. The person's age ranges.
+ { # A person's age range.
+ "ageRange": "A String", # The age range.
+ "metadata": { # Metadata about a field. # Metadata about the age range.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
- "interests": [ # The person's interests.
- { # One of the person's interests.
- "value": "A String", # The interest; for example, `stargazing`.
- "metadata": { # Metadata about a field. # Metadata about the interest.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "locations": [ # The person's locations.
- { # A person's location.
- "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
- "floor": "A String", # The floor name or number.
- "deskCode": "A String", # The individual desk location.
- "floorSection": "A String", # The floor section in `floor_name`.
- "value": "A String", # The free-form value of the location.
- "metadata": { # Metadata about a field. # Metadata about the location.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "buildingId": "A String", # The building identifier.
- "current": True or False, # Whether the location is the current location.
- },
- ],
- "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
- { # **DEPRECATED**: No data will be returned A person's relationship interest .
- "formattedValue": "A String", # 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.
- "value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
- "metadata": { # Metadata about a field. # Metadata about the relationship interest.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "names": [ # The person's names. This field is a singleton for contact sources.
- { # A person's name. If the name is a mononym, the family name is empty.
- "metadata": { # Metadata about a field. # Metadata about the name.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "phoneticFamilyName": "A String", # The family name spelled as it sounds.
- "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
- "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
- "familyName": "A String", # The family name.
- "phoneticGivenName": "A String", # The given name spelled as it sounds.
- "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
- "middleName": "A String", # The middle name(s).
- "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
- "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
- "unstructuredName": "A String", # The free form name value.
- "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
- "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
- "phoneticFullName": "A String", # The full name spelled as it sounds.
- "givenName": "A String", # The given name.
- },
- ],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
- "value": "A String", # The URL.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the URL. The type can be custom or one of these predefined values: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Currents application. * `other`
+ "value": "A String", # The URL.
"metadata": { # Metadata about a field. # Metadata about the URL.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "nicknames": [ # The person's nicknames.
- { # A person's nickname.
- "type": "A String", # The type of the nickname.
- "metadata": { # Metadata about a field. # Metadata about the nickname.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The nickname.
- },
- ],
- "imClients": [ # The person's instant messaging clients.
- { # A person's instant messaging client.
- "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "username": "A String", # The user name used in the IM client.
- "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
- "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "metadata": { # Metadata about a field. # Metadata about the IM client.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.
{ # **DEPRECATED**: No data will be returned A person's bragging rights.
"metadata": { # Metadata about a field. # Metadata about the bragging rights.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
"value": "A String", # The bragging rights; for example, `climbed mount everest`.
},
],
- "metadata": { # The metadata about a person. # Output only. Metadata about the person.
- "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. 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.
- "A String",
- ],
- "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
- "sources": [ # The sources of data for the person.
- { # The source of a field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- ],
- "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
- "A String",
- ],
- "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
- },
- "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.
- "ageRanges": [ # Output only. The person's age ranges.
- { # A person's age range.
- "ageRange": "A String", # The age range.
- "metadata": { # Metadata about a field. # Metadata about the age range.
+ "sipAddresses": [ # The person's SIP addresses.
+ { # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
+ "metadata": { # Metadata about a field. # Metadata about the SIP address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
+ "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
- "formattedType": "A String", # 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.
- "person": "A String", # The name of the other person this relation refers to.
- "type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
"metadata": { # Metadata about a field. # Metadata about the relation.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- },
- ],
- "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
- { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
- "metadata": { # Metadata about a field. # Metadata about the residence.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
- "value": "A String", # The address of the residence.
- },
- ],
- "phoneNumbers": [ # The person's phone numbers.
- { # A person's phone number.
- "value": "A String", # The phone number.
- "canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
- "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "type": "A String", # The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
- "metadata": { # Metadata about a field. # Metadata about the phone number.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
- { # **DEPRECATED**: No data will be returned A brief one-line description of the person.
- "value": "A String", # The tagline.
- "metadata": { # Metadata about a field. # Metadata about the tagline.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "genders": [ # The person's genders. This field is a singleton for contact sources.
- { # A person's gender.
- "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.
- "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`
- "metadata": { # Metadata about a field. # Metadata about the gender.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
- },
- ],
- "biographies": [ # The person's biographies. This field is a singleton for contact sources.
- { # A person's short biography.
- "value": "A String", # The short biography.
- "contentType": "A String", # The content type of the biography.
- "metadata": { # Metadata about a field. # Metadata about the biography.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
+ "formattedType": "A String", # 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.
+ "type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
+ "person": "A String", # The name of the other person this relation refers to.
},
],
"miscKeywords": [ # The person's miscellaneous keywords.
{ # A person's miscellaneous keyword.
- "type": "A String", # The miscellaneous keyword type.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "type": "A String", # The miscellaneous keyword type.
"formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"value": "A String", # The value of the miscellaneous keyword.
},
],
- "sipAddresses": [ # The person's SIP addresses.
- { # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
- "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
- "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
- "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the SIP address.
+ "biographies": [ # The person's biographies. This field is a singleton for contact sources.
+ { # A person's short biography.
+ "contentType": "A String", # The content type of the biography.
+ "metadata": { # Metadata about a field. # Metadata about the biography.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "value": "A String", # The short biography.
},
],
- "externalIds": [ # The person's external IDs.
- { # An identifier from an external entity related to the person.
- "metadata": { # Metadata about a field. # Metadata about the external ID.
+ "userDefined": [ # The person's user defined data.
+ { # Arbitrary user data that is populated by the end users.
+ "metadata": { # Metadata about a field. # Metadata about the user defined data.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "value": "A String", # The value of the external ID.
- "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
+ "key": "A String", # The end user specified key of the user defined data.
+ "value": "A String", # The end user specified value of the user defined data.
},
],
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"skills": [ # The person's skills.
{ # A skill that the person has.
+ "value": "A String", # The skill; for example, `underwater basket weaving`.
"metadata": { # Metadata about a field. # Metadata about the skill.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "value": "A String", # The skill; for example, `underwater basket weaving`.
},
],
- "birthdays": [ # The person's birthdays. This field is a singleton for contact sources.
- { # 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.
- "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "locations": [ # The person's locations.
+ { # A person's location.
+ "deskCode": "A String", # The individual desk location.
+ "buildingId": "A String", # The building identifier.
+ "value": "A String", # The free-form value of the location.
+ "current": True or False, # Whether the location is the current location.
+ "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
+ "metadata": { # Metadata about a field. # Metadata about the location.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
+ },
+ "floor": "A String", # The floor name or number.
+ "floorSection": "A String", # The floor section in `floor_name`.
+ },
+ ],
+ "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.
+ "occupations": [ # The person's occupations.
+ { # A person's occupation.
+ "value": "A String", # The occupation; for example, `carpenter`.
+ "metadata": { # Metadata about a field. # Metadata about the occupation.
"verified": True or False, # 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.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "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`. # The date of the birthday.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
+ },
+ ],
+ "fileAses": [ # The person's file-ases.
+ { # The name that should be used to sort the person in a list.
+ "metadata": { # Metadata about a field. # Metadata about the file-as.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "text": "A String", # A free-form string representing the user's birthday.
+ "value": "A String", # The file-as value
+ },
+ ],
+ "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
+ { # **DEPRECATED**: No data will be returned A person's relationship interest .
+ "formattedValue": "A String", # 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.
+ "metadata": { # Metadata about a field. # Metadata about the relationship interest.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # 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.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
"url": "A String", # The URL of the cover photo.
},
],
- "fileAses": [ # The person's file-ases.
- { # The name that should be used to sort the person in a list.
- "metadata": { # Metadata about a field. # Metadata about the file-as.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The file-as value
- },
- ],
- "clientData": [ # The person's client data.
- { # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
- "metadata": { # Metadata about a field. # Metadata about the client data.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "key": "A String", # The client specified key of the client data.
- "value": "A String", # The client specified value of the client data.
- },
- ],
- "events": [ # The person's events.
- { # An event related to the person.
- "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`. # The date of the event.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`
- "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the event.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "userDefined": [ # The person's user defined data.
- { # Arbitrary user data that is populated by the end users.
- "metadata": { # Metadata about a field. # Metadata about the user defined data.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "key": "A String", # The end user specified key of the user defined data.
- "value": "A String", # The end user specified value of the user defined data.
- },
- ],
- "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
- "organizations": [ # The person's past or current organizations.
- { # A person's past or current organization. Overlapping date ranges are permitted.
- "endDate": { # 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`. # The end date when the person left the organization.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "name": "A String", # The name of the organization.
- "metadata": { # Metadata about a field. # Metadata about the organization.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "location": "A String", # The location of the organization office the person works at.
- "title": "A String", # The person's job title at the organization.
- "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
- "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
- "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
- "phoneticName": "A String", # The phonetic name of the organization.
- "formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "department": "A String", # The person's department at the organization.
- "startDate": { # 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`. # The start date when the person joined the organization.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "jobDescription": "A String", # The person's job description at the organization.
- "type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
- },
- ],
- "occupations": [ # The person's occupations.
- { # A person's occupation.
- "metadata": { # Metadata about a field. # Metadata about the occupation.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The occupation; for example, `carpenter`.
- },
- ],
- "calendarUrls": [ # The person's calendar URLs.
- { # A person's calendar URL.
- "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
- "url": "A String", # The calendar URL.
- "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the calendar URL.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "locales": [ # The person's locale preferences.
- { # A person's locale preference.
- "metadata": { # Metadata about a field. # Metadata about the locale.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
- },
- ],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
},
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
- "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
+ "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
- "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
- { # **DEPRECATED**: No data will be returned A person's relationship status.
- "metadata": { # Metadata about a field. # Metadata about the relationship status.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
- "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- },
- ],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"metadata": { # Metadata about a field. # Metadata about the photo.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
+ },
+ "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
+ "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
+ },
+ ],
+ "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
+ { # **DEPRECATED**: No data will be returned A person's relationship status.
+ "value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
+ "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "metadata": { # Metadata about a field. # Metadata about the relationship status.
"verified": True or False, # 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.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
- "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
+ },
+ ],
+ "names": [ # The person's names. This field is a singleton for contact sources.
+ { # A person's name. If the name is a mononym, the family name is empty.
+ "familyName": "A String", # The family name.
+ "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
+ "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
+ "phoneticFamilyName": "A String", # The family name spelled as it sounds.
+ "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
+ "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
+ "phoneticFullName": "A String", # The full name spelled as it sounds.
+ "phoneticGivenName": "A String", # The given name spelled as it sounds.
+ "unstructuredName": "A String", # The free form name value.
+ "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
+ "givenName": "A String", # The given name.
+ "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
+ "metadata": { # Metadata about a field. # Metadata about the name.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "middleName": "A String", # The middle name(s).
+ "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
+ },
+ ],
+ "metadata": { # The metadata about a person. # Output only. Metadata about the person.
+ "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. 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.
+ "A String",
+ ],
+ "sources": [ # The sources of data for the person.
+ { # The source of a field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ ],
+ "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
+ "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
+ },
+ "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
+ "nicknames": [ # The person's nicknames.
+ { # A person's nickname.
+ "value": "A String", # The nickname.
+ "metadata": { # Metadata about a field. # Metadata about the nickname.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "type": "A String", # The type of the nickname.
+ },
+ ],
+ "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
+ { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
+ "metadata": { # Metadata about a field. # Metadata about the residence.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The address of the residence.
+ "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
+ },
+ ],
+ "emailAddresses": [ # The person's email addresses.
+ { # A person's email address.
+ "metadata": { # Metadata about a field. # Metadata about the email address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "displayName": "A String", # The display name of the email.
+ "value": "A String", # The email address.
+ "formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ },
+ ],
+ "locales": [ # The person's locale preferences.
+ { # A person's locale preference.
+ "metadata": { # Metadata about a field. # Metadata about the locale.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
+ },
+ ],
+ "phoneNumbers": [ # The person's phone numbers.
+ { # A person's phone number.
+ "metadata": { # Metadata about a field. # Metadata about the phone number.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
+ "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
+ "value": "A String", # The phone number.
+ },
+ ],
+ "birthdays": [ # The person's birthdays. This field is a singleton for contact sources.
+ { # 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.
+ "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "text": "A String", # 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`. # The date of the birthday.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ },
+ ],
+ "events": [ # The person's events.
+ { # An event related to the person.
+ "type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`
+ "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`. # The date of the event.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "metadata": { # Metadata about a field. # Metadata about the event.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ },
+ ],
+ "imClients": [ # The person's instant messaging clients.
+ { # A person's instant messaging client.
+ "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
+ "metadata": { # Metadata about a field. # Metadata about the IM client.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ "username": "A String", # The user name used in the IM client.
+ "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ },
+ ],
+ "organizations": [ # The person's past or current organizations.
+ { # A person's past or current organization. Overlapping date ranges are permitted.
+ "phoneticName": "A String", # The phonetic name of the organization.
+ "title": "A String", # The person's job title at the organization.
+ "type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
+ "endDate": { # 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`. # The end date when the person left the organization.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "jobDescription": "A String", # The person's job description at the organization.
+ "name": "A String", # The name of the organization.
+ "metadata": { # Metadata about a field. # Metadata about the organization.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
+ "startDate": { # 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`. # The start date when the person joined the organization.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "location": "A String", # The location of the organization office the person works at.
+ "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
+ "department": "A String", # The person's department at the organization.
+ "formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
+ },
+ ],
+ "externalIds": [ # The person's external IDs.
+ { # An identifier from an external entity related to the person.
+ "value": "A String", # The value of the external ID.
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
+ "metadata": { # Metadata about a field. # Metadata about the external ID.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ },
+ ],
+ "addresses": [ # The person's street addresses.
+ { # A person's physical address. May be a P.O. box or street address. All fields are optional.
+ "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
+ "streetAddress": "A String", # The street address.
+ "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
+ "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "city": "A String", # The city of the address.
+ "metadata": { # Metadata about a field. # Metadata about the address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "poBox": "A String", # The P.O. box of the address.
+ "region": "A String", # The region of the address; for example, the state or province.
+ "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
+ "postalCode": "A String", # The postal code of the address.
+ "country": "A String", # The country of the address.
+ "type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ },
+ ],
+ "taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
+ { # **DEPRECATED**: No data will be returned A brief one-line description of the person.
+ "metadata": { # Metadata about a field. # Metadata about the tagline.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The tagline.
+ },
+ ],
+ "genders": [ # The person's genders. This field is a singleton for contact sources.
+ { # A person's gender.
+ "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`
+ "metadata": { # Metadata about a field. # Metadata about the gender.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.
+ "value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
+ },
+ ],
+ "calendarUrls": [ # The person's calendar URLs.
+ { # A person's calendar URL.
+ "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
+ "metadata": { # Metadata about a field. # Metadata about the calendar URL.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "url": "A String", # The calendar URL.
+ },
+ ],
+ "interests": [ # The person's interests.
+ { # One of the person's interests.
+ "value": "A String", # The interest; for example, `stargazing`.
+ "metadata": { # Metadata about a field. # Metadata about the interest.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
},
],
},
@@ -2717,19 +2717,19 @@
</div>
<div class="method">
- <code class="details" id="get">get(resourceName, requestMask_includeField=None, sources=None, personFields=None, x__xgafv=None)</code>
+ <code class="details" id="get">get(resourceName, requestMask_includeField=None, personFields=None, sources=None, x__xgafv=None)</code>
<pre>Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.
Args:
resourceName: string, Required. The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list). (required)
requestMask_includeField: string, Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.
+ personFields: string, Required. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
sources: string, Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_PROFILE and READ_SOURCE_TYPE_CONTACT if not set. (repeated)
Allowed values
READ_SOURCE_TYPE_UNSPECIFIED - Unspecified.
READ_SOURCE_TYPE_PROFILE - Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.
READ_SOURCE_TYPE_CONTACT - Returns SourceType.CONTACT.
READ_SOURCE_TYPE_DOMAIN_CONTACT - Returns SourceType.DOMAIN_CONTACT.
- personFields: string, Required. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -2739,857 +2739,857 @@
An object of the form:
{ # 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.
- "emailAddresses": [ # The person's email addresses.
- { # A person's email address.
- "value": "A String", # The email address.
- "formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the email address.
+ "clientData": [ # The person's client data.
+ { # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
+ "key": "A String", # The client specified key of the client data.
+ "metadata": { # Metadata about a field. # Metadata about the client data.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "displayName": "A String", # The display name of the email.
- "type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ "value": "A String", # The client specified value of the client data.
},
],
- "addresses": [ # The person's street addresses.
- { # A person's physical address. May be a P.O. box or street address. All fields are optional.
- "streetAddress": "A String", # The street address.
- "poBox": "A String", # The P.O. box of the address.
- "region": "A String", # The region of the address; for example, the state or province.
- "type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
- "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
- "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "postalCode": "A String", # The postal code of the address.
- "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
- "city": "A String", # The city of the address.
- "country": "A String", # The country of the address.
- "metadata": { # Metadata about a field. # Metadata about the address.
+ "ageRanges": [ # Output only. The person's age ranges.
+ { # A person's age range.
+ "ageRange": "A String", # The age range.
+ "metadata": { # Metadata about a field. # Metadata about the age range.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
- "interests": [ # The person's interests.
- { # One of the person's interests.
- "value": "A String", # The interest; for example, `stargazing`.
- "metadata": { # Metadata about a field. # Metadata about the interest.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "locations": [ # The person's locations.
- { # A person's location.
- "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
- "floor": "A String", # The floor name or number.
- "deskCode": "A String", # The individual desk location.
- "floorSection": "A String", # The floor section in `floor_name`.
- "value": "A String", # The free-form value of the location.
- "metadata": { # Metadata about a field. # Metadata about the location.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "buildingId": "A String", # The building identifier.
- "current": True or False, # Whether the location is the current location.
- },
- ],
- "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
- { # **DEPRECATED**: No data will be returned A person's relationship interest .
- "formattedValue": "A String", # 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.
- "value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
- "metadata": { # Metadata about a field. # Metadata about the relationship interest.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "names": [ # The person's names. This field is a singleton for contact sources.
- { # A person's name. If the name is a mononym, the family name is empty.
- "metadata": { # Metadata about a field. # Metadata about the name.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "phoneticFamilyName": "A String", # The family name spelled as it sounds.
- "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
- "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
- "familyName": "A String", # The family name.
- "phoneticGivenName": "A String", # The given name spelled as it sounds.
- "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
- "middleName": "A String", # The middle name(s).
- "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
- "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
- "unstructuredName": "A String", # The free form name value.
- "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
- "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
- "phoneticFullName": "A String", # The full name spelled as it sounds.
- "givenName": "A String", # The given name.
- },
- ],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
- "value": "A String", # The URL.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the URL. The type can be custom or one of these predefined values: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Currents application. * `other`
+ "value": "A String", # The URL.
"metadata": { # Metadata about a field. # Metadata about the URL.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "nicknames": [ # The person's nicknames.
- { # A person's nickname.
- "type": "A String", # The type of the nickname.
- "metadata": { # Metadata about a field. # Metadata about the nickname.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The nickname.
- },
- ],
- "imClients": [ # The person's instant messaging clients.
- { # A person's instant messaging client.
- "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "username": "A String", # The user name used in the IM client.
- "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
- "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "metadata": { # Metadata about a field. # Metadata about the IM client.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.
{ # **DEPRECATED**: No data will be returned A person's bragging rights.
"metadata": { # Metadata about a field. # Metadata about the bragging rights.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
"value": "A String", # The bragging rights; for example, `climbed mount everest`.
},
],
- "metadata": { # The metadata about a person. # Output only. Metadata about the person.
- "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. 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.
- "A String",
- ],
- "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
- "sources": [ # The sources of data for the person.
- { # The source of a field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- ],
- "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
- "A String",
- ],
- "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
- },
- "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.
- "ageRanges": [ # Output only. The person's age ranges.
- { # A person's age range.
- "ageRange": "A String", # The age range.
- "metadata": { # Metadata about a field. # Metadata about the age range.
+ "sipAddresses": [ # The person's SIP addresses.
+ { # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
+ "metadata": { # Metadata about a field. # Metadata about the SIP address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
+ "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
- "formattedType": "A String", # 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.
- "person": "A String", # The name of the other person this relation refers to.
- "type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
"metadata": { # Metadata about a field. # Metadata about the relation.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- },
- ],
- "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
- { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
- "metadata": { # Metadata about a field. # Metadata about the residence.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
- "value": "A String", # The address of the residence.
- },
- ],
- "phoneNumbers": [ # The person's phone numbers.
- { # A person's phone number.
- "value": "A String", # The phone number.
- "canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
- "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "type": "A String", # The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
- "metadata": { # Metadata about a field. # Metadata about the phone number.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
- { # **DEPRECATED**: No data will be returned A brief one-line description of the person.
- "value": "A String", # The tagline.
- "metadata": { # Metadata about a field. # Metadata about the tagline.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "genders": [ # The person's genders. This field is a singleton for contact sources.
- { # A person's gender.
- "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.
- "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`
- "metadata": { # Metadata about a field. # Metadata about the gender.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
- },
- ],
- "biographies": [ # The person's biographies. This field is a singleton for contact sources.
- { # A person's short biography.
- "value": "A String", # The short biography.
- "contentType": "A String", # The content type of the biography.
- "metadata": { # Metadata about a field. # Metadata about the biography.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
+ "formattedType": "A String", # 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.
+ "type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
+ "person": "A String", # The name of the other person this relation refers to.
},
],
"miscKeywords": [ # The person's miscellaneous keywords.
{ # A person's miscellaneous keyword.
- "type": "A String", # The miscellaneous keyword type.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "type": "A String", # The miscellaneous keyword type.
"formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"value": "A String", # The value of the miscellaneous keyword.
},
],
- "sipAddresses": [ # The person's SIP addresses.
- { # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
- "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
- "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
- "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the SIP address.
+ "biographies": [ # The person's biographies. This field is a singleton for contact sources.
+ { # A person's short biography.
+ "contentType": "A String", # The content type of the biography.
+ "metadata": { # Metadata about a field. # Metadata about the biography.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "value": "A String", # The short biography.
},
],
- "externalIds": [ # The person's external IDs.
- { # An identifier from an external entity related to the person.
- "metadata": { # Metadata about a field. # Metadata about the external ID.
+ "userDefined": [ # The person's user defined data.
+ { # Arbitrary user data that is populated by the end users.
+ "metadata": { # Metadata about a field. # Metadata about the user defined data.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "value": "A String", # The value of the external ID.
- "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
+ "key": "A String", # The end user specified key of the user defined data.
+ "value": "A String", # The end user specified value of the user defined data.
},
],
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"skills": [ # The person's skills.
{ # A skill that the person has.
+ "value": "A String", # The skill; for example, `underwater basket weaving`.
"metadata": { # Metadata about a field. # Metadata about the skill.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "value": "A String", # The skill; for example, `underwater basket weaving`.
},
],
- "birthdays": [ # The person's birthdays. This field is a singleton for contact sources.
- { # 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.
- "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "locations": [ # The person's locations.
+ { # A person's location.
+ "deskCode": "A String", # The individual desk location.
+ "buildingId": "A String", # The building identifier.
+ "value": "A String", # The free-form value of the location.
+ "current": True or False, # Whether the location is the current location.
+ "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
+ "metadata": { # Metadata about a field. # Metadata about the location.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
+ },
+ "floor": "A String", # The floor name or number.
+ "floorSection": "A String", # The floor section in `floor_name`.
+ },
+ ],
+ "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.
+ "occupations": [ # The person's occupations.
+ { # A person's occupation.
+ "value": "A String", # The occupation; for example, `carpenter`.
+ "metadata": { # Metadata about a field. # Metadata about the occupation.
"verified": True or False, # 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.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "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`. # The date of the birthday.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
+ },
+ ],
+ "fileAses": [ # The person's file-ases.
+ { # The name that should be used to sort the person in a list.
+ "metadata": { # Metadata about a field. # Metadata about the file-as.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "text": "A String", # A free-form string representing the user's birthday.
+ "value": "A String", # The file-as value
+ },
+ ],
+ "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
+ { # **DEPRECATED**: No data will be returned A person's relationship interest .
+ "formattedValue": "A String", # 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.
+ "metadata": { # Metadata about a field. # Metadata about the relationship interest.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # 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.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
"url": "A String", # The URL of the cover photo.
},
],
- "fileAses": [ # The person's file-ases.
- { # The name that should be used to sort the person in a list.
- "metadata": { # Metadata about a field. # Metadata about the file-as.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The file-as value
- },
- ],
- "clientData": [ # The person's client data.
- { # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
- "metadata": { # Metadata about a field. # Metadata about the client data.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "key": "A String", # The client specified key of the client data.
- "value": "A String", # The client specified value of the client data.
- },
- ],
- "events": [ # The person's events.
- { # An event related to the person.
- "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`. # The date of the event.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`
- "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the event.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "userDefined": [ # The person's user defined data.
- { # Arbitrary user data that is populated by the end users.
- "metadata": { # Metadata about a field. # Metadata about the user defined data.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "key": "A String", # The end user specified key of the user defined data.
- "value": "A String", # The end user specified value of the user defined data.
- },
- ],
- "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
- "organizations": [ # The person's past or current organizations.
- { # A person's past or current organization. Overlapping date ranges are permitted.
- "endDate": { # 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`. # The end date when the person left the organization.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "name": "A String", # The name of the organization.
- "metadata": { # Metadata about a field. # Metadata about the organization.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "location": "A String", # The location of the organization office the person works at.
- "title": "A String", # The person's job title at the organization.
- "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
- "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
- "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
- "phoneticName": "A String", # The phonetic name of the organization.
- "formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "department": "A String", # The person's department at the organization.
- "startDate": { # 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`. # The start date when the person joined the organization.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "jobDescription": "A String", # The person's job description at the organization.
- "type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
- },
- ],
- "occupations": [ # The person's occupations.
- { # A person's occupation.
- "metadata": { # Metadata about a field. # Metadata about the occupation.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The occupation; for example, `carpenter`.
- },
- ],
- "calendarUrls": [ # The person's calendar URLs.
- { # A person's calendar URL.
- "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
- "url": "A String", # The calendar URL.
- "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the calendar URL.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "locales": [ # The person's locale preferences.
- { # A person's locale preference.
- "metadata": { # Metadata about a field. # Metadata about the locale.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
- },
- ],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
},
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
- "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
+ "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
- "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
- { # **DEPRECATED**: No data will be returned A person's relationship status.
- "metadata": { # Metadata about a field. # Metadata about the relationship status.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
- "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- },
- ],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"metadata": { # Metadata about a field. # Metadata about the photo.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
+ },
+ "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
+ "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
+ },
+ ],
+ "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
+ { # **DEPRECATED**: No data will be returned A person's relationship status.
+ "value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
+ "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "metadata": { # Metadata about a field. # Metadata about the relationship status.
"verified": True or False, # 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.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
- "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
+ },
+ ],
+ "names": [ # The person's names. This field is a singleton for contact sources.
+ { # A person's name. If the name is a mononym, the family name is empty.
+ "familyName": "A String", # The family name.
+ "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
+ "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
+ "phoneticFamilyName": "A String", # The family name spelled as it sounds.
+ "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
+ "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
+ "phoneticFullName": "A String", # The full name spelled as it sounds.
+ "phoneticGivenName": "A String", # The given name spelled as it sounds.
+ "unstructuredName": "A String", # The free form name value.
+ "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
+ "givenName": "A String", # The given name.
+ "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
+ "metadata": { # Metadata about a field. # Metadata about the name.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "middleName": "A String", # The middle name(s).
+ "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
+ },
+ ],
+ "metadata": { # The metadata about a person. # Output only. Metadata about the person.
+ "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. 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.
+ "A String",
+ ],
+ "sources": [ # The sources of data for the person.
+ { # The source of a field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ ],
+ "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
+ "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
+ },
+ "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
+ "nicknames": [ # The person's nicknames.
+ { # A person's nickname.
+ "value": "A String", # The nickname.
+ "metadata": { # Metadata about a field. # Metadata about the nickname.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "type": "A String", # The type of the nickname.
+ },
+ ],
+ "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
+ { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
+ "metadata": { # Metadata about a field. # Metadata about the residence.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The address of the residence.
+ "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
+ },
+ ],
+ "emailAddresses": [ # The person's email addresses.
+ { # A person's email address.
+ "metadata": { # Metadata about a field. # Metadata about the email address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "displayName": "A String", # The display name of the email.
+ "value": "A String", # The email address.
+ "formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ },
+ ],
+ "locales": [ # The person's locale preferences.
+ { # A person's locale preference.
+ "metadata": { # Metadata about a field. # Metadata about the locale.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
+ },
+ ],
+ "phoneNumbers": [ # The person's phone numbers.
+ { # A person's phone number.
+ "metadata": { # Metadata about a field. # Metadata about the phone number.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
+ "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
+ "value": "A String", # The phone number.
+ },
+ ],
+ "birthdays": [ # The person's birthdays. This field is a singleton for contact sources.
+ { # 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.
+ "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "text": "A String", # 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`. # The date of the birthday.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ },
+ ],
+ "events": [ # The person's events.
+ { # An event related to the person.
+ "type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`
+ "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`. # The date of the event.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "metadata": { # Metadata about a field. # Metadata about the event.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ },
+ ],
+ "imClients": [ # The person's instant messaging clients.
+ { # A person's instant messaging client.
+ "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
+ "metadata": { # Metadata about a field. # Metadata about the IM client.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ "username": "A String", # The user name used in the IM client.
+ "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ },
+ ],
+ "organizations": [ # The person's past or current organizations.
+ { # A person's past or current organization. Overlapping date ranges are permitted.
+ "phoneticName": "A String", # The phonetic name of the organization.
+ "title": "A String", # The person's job title at the organization.
+ "type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
+ "endDate": { # 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`. # The end date when the person left the organization.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "jobDescription": "A String", # The person's job description at the organization.
+ "name": "A String", # The name of the organization.
+ "metadata": { # Metadata about a field. # Metadata about the organization.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
+ "startDate": { # 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`. # The start date when the person joined the organization.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "location": "A String", # The location of the organization office the person works at.
+ "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
+ "department": "A String", # The person's department at the organization.
+ "formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
+ },
+ ],
+ "externalIds": [ # The person's external IDs.
+ { # An identifier from an external entity related to the person.
+ "value": "A String", # The value of the external ID.
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
+ "metadata": { # Metadata about a field. # Metadata about the external ID.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ },
+ ],
+ "addresses": [ # The person's street addresses.
+ { # A person's physical address. May be a P.O. box or street address. All fields are optional.
+ "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
+ "streetAddress": "A String", # The street address.
+ "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
+ "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "city": "A String", # The city of the address.
+ "metadata": { # Metadata about a field. # Metadata about the address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "poBox": "A String", # The P.O. box of the address.
+ "region": "A String", # The region of the address; for example, the state or province.
+ "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
+ "postalCode": "A String", # The postal code of the address.
+ "country": "A String", # The country of the address.
+ "type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ },
+ ],
+ "taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
+ { # **DEPRECATED**: No data will be returned A brief one-line description of the person.
+ "metadata": { # Metadata about a field. # Metadata about the tagline.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The tagline.
+ },
+ ],
+ "genders": [ # The person's genders. This field is a singleton for contact sources.
+ { # A person's gender.
+ "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`
+ "metadata": { # Metadata about a field. # Metadata about the gender.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.
+ "value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
+ },
+ ],
+ "calendarUrls": [ # The person's calendar URLs.
+ { # A person's calendar URL.
+ "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
+ "metadata": { # Metadata about a field. # Metadata about the calendar URL.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "url": "A String", # The calendar URL.
+ },
+ ],
+ "interests": [ # The person's interests.
+ { # One of the person's interests.
+ "value": "A String", # The interest; for example, `stargazing`.
+ "metadata": { # Metadata about a field. # Metadata about the interest.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
},
],
}</pre>
</div>
<div class="method">
- <code class="details" id="getBatchGet">getBatchGet(resourceNames=None, requestMask_includeField=None, personFields=None, sources=None, x__xgafv=None)</code>
+ <code class="details" id="getBatchGet">getBatchGet(personFields=None, requestMask_includeField=None, resourceNames=None, sources=None, x__xgafv=None)</code>
<pre>Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.
Args:
- resourceNames: string, Required. The resource names of the people to provide information about. It's repeatable. The URL query parameter should be resourceNames=<name1>&resourceNames=<name2>&... - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list). You can include up to 50 resource names in one request. (repeated)
- requestMask_includeField: string, Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.
personFields: string, Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
+ requestMask_includeField: string, Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.
+ resourceNames: string, Required. The resource names of the people to provide information about. It's repeatable. The URL query parameter should be resourceNames=<name1>&resourceNames=<name2>&... - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list). You can include up to 50 resource names in one request. (repeated)
sources: string, Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set. (repeated)
Allowed values
READ_SOURCE_TYPE_UNSPECIFIED - Unspecified.
@@ -3607,882 +3607,882 @@
{ # The response to a get request for a list of people by resource name.
"responses": [ # The response for each requested resource name.
{ # The response for a single person
- "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The status of the response.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- },
"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. # The person.
- "emailAddresses": [ # The person's email addresses.
- { # A person's email address.
- "value": "A String", # The email address.
- "formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the email address.
+ "clientData": [ # The person's client data.
+ { # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
+ "key": "A String", # The client specified key of the client data.
+ "metadata": { # Metadata about a field. # Metadata about the client data.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "displayName": "A String", # The display name of the email.
- "type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ "value": "A String", # The client specified value of the client data.
},
],
- "addresses": [ # The person's street addresses.
- { # A person's physical address. May be a P.O. box or street address. All fields are optional.
- "streetAddress": "A String", # The street address.
- "poBox": "A String", # The P.O. box of the address.
- "region": "A String", # The region of the address; for example, the state or province.
- "type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
- "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
- "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "postalCode": "A String", # The postal code of the address.
- "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
- "city": "A String", # The city of the address.
- "country": "A String", # The country of the address.
- "metadata": { # Metadata about a field. # Metadata about the address.
+ "ageRanges": [ # Output only. The person's age ranges.
+ { # A person's age range.
+ "ageRange": "A String", # The age range.
+ "metadata": { # Metadata about a field. # Metadata about the age range.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
- "interests": [ # The person's interests.
- { # One of the person's interests.
- "value": "A String", # The interest; for example, `stargazing`.
- "metadata": { # Metadata about a field. # Metadata about the interest.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "locations": [ # The person's locations.
- { # A person's location.
- "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
- "floor": "A String", # The floor name or number.
- "deskCode": "A String", # The individual desk location.
- "floorSection": "A String", # The floor section in `floor_name`.
- "value": "A String", # The free-form value of the location.
- "metadata": { # Metadata about a field. # Metadata about the location.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "buildingId": "A String", # The building identifier.
- "current": True or False, # Whether the location is the current location.
- },
- ],
- "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
- { # **DEPRECATED**: No data will be returned A person's relationship interest .
- "formattedValue": "A String", # 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.
- "value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
- "metadata": { # Metadata about a field. # Metadata about the relationship interest.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "names": [ # The person's names. This field is a singleton for contact sources.
- { # A person's name. If the name is a mononym, the family name is empty.
- "metadata": { # Metadata about a field. # Metadata about the name.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "phoneticFamilyName": "A String", # The family name spelled as it sounds.
- "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
- "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
- "familyName": "A String", # The family name.
- "phoneticGivenName": "A String", # The given name spelled as it sounds.
- "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
- "middleName": "A String", # The middle name(s).
- "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
- "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
- "unstructuredName": "A String", # The free form name value.
- "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
- "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
- "phoneticFullName": "A String", # The full name spelled as it sounds.
- "givenName": "A String", # The given name.
- },
- ],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
- "value": "A String", # The URL.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the URL. The type can be custom or one of these predefined values: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Currents application. * `other`
+ "value": "A String", # The URL.
"metadata": { # Metadata about a field. # Metadata about the URL.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "nicknames": [ # The person's nicknames.
- { # A person's nickname.
- "type": "A String", # The type of the nickname.
- "metadata": { # Metadata about a field. # Metadata about the nickname.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The nickname.
- },
- ],
- "imClients": [ # The person's instant messaging clients.
- { # A person's instant messaging client.
- "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "username": "A String", # The user name used in the IM client.
- "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
- "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "metadata": { # Metadata about a field. # Metadata about the IM client.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.
{ # **DEPRECATED**: No data will be returned A person's bragging rights.
"metadata": { # Metadata about a field. # Metadata about the bragging rights.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
"value": "A String", # The bragging rights; for example, `climbed mount everest`.
},
],
- "metadata": { # The metadata about a person. # Output only. Metadata about the person.
- "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. 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.
- "A String",
- ],
- "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
- "sources": [ # The sources of data for the person.
- { # The source of a field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- ],
- "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
- "A String",
- ],
- "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
- },
- "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.
- "ageRanges": [ # Output only. The person's age ranges.
- { # A person's age range.
- "ageRange": "A String", # The age range.
- "metadata": { # Metadata about a field. # Metadata about the age range.
+ "sipAddresses": [ # The person's SIP addresses.
+ { # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
+ "metadata": { # Metadata about a field. # Metadata about the SIP address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
+ "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
- "formattedType": "A String", # 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.
- "person": "A String", # The name of the other person this relation refers to.
- "type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
"metadata": { # Metadata about a field. # Metadata about the relation.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- },
- ],
- "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
- { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
- "metadata": { # Metadata about a field. # Metadata about the residence.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
- "value": "A String", # The address of the residence.
- },
- ],
- "phoneNumbers": [ # The person's phone numbers.
- { # A person's phone number.
- "value": "A String", # The phone number.
- "canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
- "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "type": "A String", # The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
- "metadata": { # Metadata about a field. # Metadata about the phone number.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
- { # **DEPRECATED**: No data will be returned A brief one-line description of the person.
- "value": "A String", # The tagline.
- "metadata": { # Metadata about a field. # Metadata about the tagline.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "genders": [ # The person's genders. This field is a singleton for contact sources.
- { # A person's gender.
- "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.
- "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`
- "metadata": { # Metadata about a field. # Metadata about the gender.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
- },
- ],
- "biographies": [ # The person's biographies. This field is a singleton for contact sources.
- { # A person's short biography.
- "value": "A String", # The short biography.
- "contentType": "A String", # The content type of the biography.
- "metadata": { # Metadata about a field. # Metadata about the biography.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
+ "formattedType": "A String", # 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.
+ "type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
+ "person": "A String", # The name of the other person this relation refers to.
},
],
"miscKeywords": [ # The person's miscellaneous keywords.
{ # A person's miscellaneous keyword.
- "type": "A String", # The miscellaneous keyword type.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "type": "A String", # The miscellaneous keyword type.
"formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"value": "A String", # The value of the miscellaneous keyword.
},
],
- "sipAddresses": [ # The person's SIP addresses.
- { # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
- "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
- "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
- "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the SIP address.
+ "biographies": [ # The person's biographies. This field is a singleton for contact sources.
+ { # A person's short biography.
+ "contentType": "A String", # The content type of the biography.
+ "metadata": { # Metadata about a field. # Metadata about the biography.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "value": "A String", # The short biography.
},
],
- "externalIds": [ # The person's external IDs.
- { # An identifier from an external entity related to the person.
- "metadata": { # Metadata about a field. # Metadata about the external ID.
+ "userDefined": [ # The person's user defined data.
+ { # Arbitrary user data that is populated by the end users.
+ "metadata": { # Metadata about a field. # Metadata about the user defined data.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "value": "A String", # The value of the external ID.
- "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
+ "key": "A String", # The end user specified key of the user defined data.
+ "value": "A String", # The end user specified value of the user defined data.
},
],
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"skills": [ # The person's skills.
{ # A skill that the person has.
+ "value": "A String", # The skill; for example, `underwater basket weaving`.
"metadata": { # Metadata about a field. # Metadata about the skill.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "value": "A String", # The skill; for example, `underwater basket weaving`.
},
],
- "birthdays": [ # The person's birthdays. This field is a singleton for contact sources.
- { # 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.
- "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "locations": [ # The person's locations.
+ { # A person's location.
+ "deskCode": "A String", # The individual desk location.
+ "buildingId": "A String", # The building identifier.
+ "value": "A String", # The free-form value of the location.
+ "current": True or False, # Whether the location is the current location.
+ "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
+ "metadata": { # Metadata about a field. # Metadata about the location.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
+ },
+ "floor": "A String", # The floor name or number.
+ "floorSection": "A String", # The floor section in `floor_name`.
+ },
+ ],
+ "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.
+ "occupations": [ # The person's occupations.
+ { # A person's occupation.
+ "value": "A String", # The occupation; for example, `carpenter`.
+ "metadata": { # Metadata about a field. # Metadata about the occupation.
"verified": True or False, # 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.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "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`. # The date of the birthday.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
+ },
+ ],
+ "fileAses": [ # The person's file-ases.
+ { # The name that should be used to sort the person in a list.
+ "metadata": { # Metadata about a field. # Metadata about the file-as.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "text": "A String", # A free-form string representing the user's birthday.
+ "value": "A String", # The file-as value
+ },
+ ],
+ "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
+ { # **DEPRECATED**: No data will be returned A person's relationship interest .
+ "formattedValue": "A String", # 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.
+ "metadata": { # Metadata about a field. # Metadata about the relationship interest.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # 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.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
"url": "A String", # The URL of the cover photo.
},
],
- "fileAses": [ # The person's file-ases.
- { # The name that should be used to sort the person in a list.
- "metadata": { # Metadata about a field. # Metadata about the file-as.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The file-as value
- },
- ],
- "clientData": [ # The person's client data.
- { # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
- "metadata": { # Metadata about a field. # Metadata about the client data.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "key": "A String", # The client specified key of the client data.
- "value": "A String", # The client specified value of the client data.
- },
- ],
- "events": [ # The person's events.
- { # An event related to the person.
- "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`. # The date of the event.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`
- "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the event.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "userDefined": [ # The person's user defined data.
- { # Arbitrary user data that is populated by the end users.
- "metadata": { # Metadata about a field. # Metadata about the user defined data.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "key": "A String", # The end user specified key of the user defined data.
- "value": "A String", # The end user specified value of the user defined data.
- },
- ],
- "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
- "organizations": [ # The person's past or current organizations.
- { # A person's past or current organization. Overlapping date ranges are permitted.
- "endDate": { # 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`. # The end date when the person left the organization.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "name": "A String", # The name of the organization.
- "metadata": { # Metadata about a field. # Metadata about the organization.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "location": "A String", # The location of the organization office the person works at.
- "title": "A String", # The person's job title at the organization.
- "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
- "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
- "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
- "phoneticName": "A String", # The phonetic name of the organization.
- "formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "department": "A String", # The person's department at the organization.
- "startDate": { # 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`. # The start date when the person joined the organization.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "jobDescription": "A String", # The person's job description at the organization.
- "type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
- },
- ],
- "occupations": [ # The person's occupations.
- { # A person's occupation.
- "metadata": { # Metadata about a field. # Metadata about the occupation.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The occupation; for example, `carpenter`.
- },
- ],
- "calendarUrls": [ # The person's calendar URLs.
- { # A person's calendar URL.
- "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
- "url": "A String", # The calendar URL.
- "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the calendar URL.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "locales": [ # The person's locale preferences.
- { # A person's locale preference.
- "metadata": { # Metadata about a field. # Metadata about the locale.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
- },
- ],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
},
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
- "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
+ "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
- "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
- { # **DEPRECATED**: No data will be returned A person's relationship status.
- "metadata": { # Metadata about a field. # Metadata about the relationship status.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
- "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- },
- ],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"metadata": { # Metadata about a field. # Metadata about the photo.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
+ },
+ "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
+ "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
+ },
+ ],
+ "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
+ { # **DEPRECATED**: No data will be returned A person's relationship status.
+ "value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
+ "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "metadata": { # Metadata about a field. # Metadata about the relationship status.
"verified": True or False, # 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.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
- "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
+ },
+ ],
+ "names": [ # The person's names. This field is a singleton for contact sources.
+ { # A person's name. If the name is a mononym, the family name is empty.
+ "familyName": "A String", # The family name.
+ "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
+ "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
+ "phoneticFamilyName": "A String", # The family name spelled as it sounds.
+ "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
+ "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
+ "phoneticFullName": "A String", # The full name spelled as it sounds.
+ "phoneticGivenName": "A String", # The given name spelled as it sounds.
+ "unstructuredName": "A String", # The free form name value.
+ "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
+ "givenName": "A String", # The given name.
+ "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
+ "metadata": { # Metadata about a field. # Metadata about the name.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "middleName": "A String", # The middle name(s).
+ "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
+ },
+ ],
+ "metadata": { # The metadata about a person. # Output only. Metadata about the person.
+ "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. 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.
+ "A String",
+ ],
+ "sources": [ # The sources of data for the person.
+ { # The source of a field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ ],
+ "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
+ "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
+ },
+ "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
+ "nicknames": [ # The person's nicknames.
+ { # A person's nickname.
+ "value": "A String", # The nickname.
+ "metadata": { # Metadata about a field. # Metadata about the nickname.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "type": "A String", # The type of the nickname.
+ },
+ ],
+ "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
+ { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
+ "metadata": { # Metadata about a field. # Metadata about the residence.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The address of the residence.
+ "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
+ },
+ ],
+ "emailAddresses": [ # The person's email addresses.
+ { # A person's email address.
+ "metadata": { # Metadata about a field. # Metadata about the email address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "displayName": "A String", # The display name of the email.
+ "value": "A String", # The email address.
+ "formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ },
+ ],
+ "locales": [ # The person's locale preferences.
+ { # A person's locale preference.
+ "metadata": { # Metadata about a field. # Metadata about the locale.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
+ },
+ ],
+ "phoneNumbers": [ # The person's phone numbers.
+ { # A person's phone number.
+ "metadata": { # Metadata about a field. # Metadata about the phone number.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
+ "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
+ "value": "A String", # The phone number.
+ },
+ ],
+ "birthdays": [ # The person's birthdays. This field is a singleton for contact sources.
+ { # 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.
+ "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "text": "A String", # 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`. # The date of the birthday.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ },
+ ],
+ "events": [ # The person's events.
+ { # An event related to the person.
+ "type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`
+ "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`. # The date of the event.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "metadata": { # Metadata about a field. # Metadata about the event.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ },
+ ],
+ "imClients": [ # The person's instant messaging clients.
+ { # A person's instant messaging client.
+ "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
+ "metadata": { # Metadata about a field. # Metadata about the IM client.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ "username": "A String", # The user name used in the IM client.
+ "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ },
+ ],
+ "organizations": [ # The person's past or current organizations.
+ { # A person's past or current organization. Overlapping date ranges are permitted.
+ "phoneticName": "A String", # The phonetic name of the organization.
+ "title": "A String", # The person's job title at the organization.
+ "type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
+ "endDate": { # 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`. # The end date when the person left the organization.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "jobDescription": "A String", # The person's job description at the organization.
+ "name": "A String", # The name of the organization.
+ "metadata": { # Metadata about a field. # Metadata about the organization.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
+ "startDate": { # 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`. # The start date when the person joined the organization.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "location": "A String", # The location of the organization office the person works at.
+ "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
+ "department": "A String", # The person's department at the organization.
+ "formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
+ },
+ ],
+ "externalIds": [ # The person's external IDs.
+ { # An identifier from an external entity related to the person.
+ "value": "A String", # The value of the external ID.
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
+ "metadata": { # Metadata about a field. # Metadata about the external ID.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ },
+ ],
+ "addresses": [ # The person's street addresses.
+ { # A person's physical address. May be a P.O. box or street address. All fields are optional.
+ "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
+ "streetAddress": "A String", # The street address.
+ "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
+ "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "city": "A String", # The city of the address.
+ "metadata": { # Metadata about a field. # Metadata about the address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "poBox": "A String", # The P.O. box of the address.
+ "region": "A String", # The region of the address; for example, the state or province.
+ "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
+ "postalCode": "A String", # The postal code of the address.
+ "country": "A String", # The country of the address.
+ "type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ },
+ ],
+ "taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
+ { # **DEPRECATED**: No data will be returned A brief one-line description of the person.
+ "metadata": { # Metadata about a field. # Metadata about the tagline.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The tagline.
+ },
+ ],
+ "genders": [ # The person's genders. This field is a singleton for contact sources.
+ { # A person's gender.
+ "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`
+ "metadata": { # Metadata about a field. # Metadata about the gender.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.
+ "value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
+ },
+ ],
+ "calendarUrls": [ # The person's calendar URLs.
+ { # A person's calendar URL.
+ "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
+ "metadata": { # Metadata about a field. # Metadata about the calendar URL.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "url": "A String", # The calendar URL.
+ },
+ ],
+ "interests": [ # The person's interests.
+ { # One of the person's interests.
+ "value": "A String", # The interest; for example, `stargazing`.
+ "metadata": { # Metadata about a field. # Metadata about the interest.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
},
],
},
"requestedResourceName": "A String", # The original requested resource name. May be different than the resource name on the returned person. The resource name can change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or a profile URL.
"httpStatusCode": 42, # **DEPRECATED** (Please use status instead) [HTTP 1.1 status code] (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).
+ "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The status of the response.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
},
],
}</pre>
</div>
<div class="method">
- <code class="details" id="listDirectoryPeople">listDirectoryPeople(mergeSources=None, readMask=None, syncToken=None, pageSize=None, sources=None, requestSyncToken=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="listDirectoryPeople">listDirectoryPeople(syncToken=None, pageSize=None, readMask=None, requestSyncToken=None, sources=None, mergeSources=None, pageToken=None, x__xgafv=None)</code>
<pre>Provides a list of domain profiles and domain contacts in the authenticated user's domain directory.
Args:
- mergeSources: string, Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers. (repeated)
- Allowed values
- DIRECTORY_MERGE_SOURCE_TYPE_UNSPECIFIED - Unspecified.
- DIRECTORY_MERGE_SOURCE_TYPE_CONTACT - User owned contact.
- readMask: string, Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
syncToken: string, Optional. A sync token, received from a previous `ListDirectoryPeople` call. Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `ListDirectoryPeople` must match the call that provided the sync token.
pageSize: integer, Optional. The number of people to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.
+ readMask: string, Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
+ requestSyncToken: boolean, Optional. Whether the response should include `next_sync_token`, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead.
sources: string, Required. Directory sources to return. (repeated)
Allowed values
DIRECTORY_SOURCE_TYPE_UNSPECIFIED - Unspecified.
DIRECTORY_SOURCE_TYPE_DOMAIN_CONTACT - G Suite domain shared contact.
DIRECTORY_SOURCE_TYPE_DOMAIN_PROFILE - G Suite domain profile.
- requestSyncToken: boolean, Optional. Whether the response should include `next_sync_token`, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead.
+ mergeSources: string, Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers. (repeated)
+ Allowed values
+ DIRECTORY_MERGE_SOURCE_TYPE_UNSPECIFIED - Unspecified.
+ DIRECTORY_MERGE_SOURCE_TYPE_CONTACT - User owned contact.
pageToken: string, Optional. A page token, received from a previous `ListDirectoryPeople` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDirectoryPeople` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
@@ -4494,851 +4494,851 @@
{ # The response to a request for the authenticated user's domain directory.
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ "nextSyncToken": "A String", # A token, which can be sent as `sync_token` to retrieve changes since the last request. Request must set `request_sync_token` to return the sync token.
"people": [ # The list of people in the domain directory.
{ # 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.
- "emailAddresses": [ # The person's email addresses.
- { # A person's email address.
- "value": "A String", # The email address.
- "formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the email address.
+ "clientData": [ # The person's client data.
+ { # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
+ "key": "A String", # The client specified key of the client data.
+ "metadata": { # Metadata about a field. # Metadata about the client data.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "displayName": "A String", # The display name of the email.
- "type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ "value": "A String", # The client specified value of the client data.
},
],
- "addresses": [ # The person's street addresses.
- { # A person's physical address. May be a P.O. box or street address. All fields are optional.
- "streetAddress": "A String", # The street address.
- "poBox": "A String", # The P.O. box of the address.
- "region": "A String", # The region of the address; for example, the state or province.
- "type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
- "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
- "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "postalCode": "A String", # The postal code of the address.
- "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
- "city": "A String", # The city of the address.
- "country": "A String", # The country of the address.
- "metadata": { # Metadata about a field. # Metadata about the address.
+ "ageRanges": [ # Output only. The person's age ranges.
+ { # A person's age range.
+ "ageRange": "A String", # The age range.
+ "metadata": { # Metadata about a field. # Metadata about the age range.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
- "interests": [ # The person's interests.
- { # One of the person's interests.
- "value": "A String", # The interest; for example, `stargazing`.
- "metadata": { # Metadata about a field. # Metadata about the interest.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "locations": [ # The person's locations.
- { # A person's location.
- "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
- "floor": "A String", # The floor name or number.
- "deskCode": "A String", # The individual desk location.
- "floorSection": "A String", # The floor section in `floor_name`.
- "value": "A String", # The free-form value of the location.
- "metadata": { # Metadata about a field. # Metadata about the location.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "buildingId": "A String", # The building identifier.
- "current": True or False, # Whether the location is the current location.
- },
- ],
- "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
- { # **DEPRECATED**: No data will be returned A person's relationship interest .
- "formattedValue": "A String", # 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.
- "value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
- "metadata": { # Metadata about a field. # Metadata about the relationship interest.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "names": [ # The person's names. This field is a singleton for contact sources.
- { # A person's name. If the name is a mononym, the family name is empty.
- "metadata": { # Metadata about a field. # Metadata about the name.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "phoneticFamilyName": "A String", # The family name spelled as it sounds.
- "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
- "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
- "familyName": "A String", # The family name.
- "phoneticGivenName": "A String", # The given name spelled as it sounds.
- "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
- "middleName": "A String", # The middle name(s).
- "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
- "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
- "unstructuredName": "A String", # The free form name value.
- "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
- "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
- "phoneticFullName": "A String", # The full name spelled as it sounds.
- "givenName": "A String", # The given name.
- },
- ],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
- "value": "A String", # The URL.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the URL. The type can be custom or one of these predefined values: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Currents application. * `other`
+ "value": "A String", # The URL.
"metadata": { # Metadata about a field. # Metadata about the URL.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "nicknames": [ # The person's nicknames.
- { # A person's nickname.
- "type": "A String", # The type of the nickname.
- "metadata": { # Metadata about a field. # Metadata about the nickname.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The nickname.
- },
- ],
- "imClients": [ # The person's instant messaging clients.
- { # A person's instant messaging client.
- "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "username": "A String", # The user name used in the IM client.
- "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
- "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "metadata": { # Metadata about a field. # Metadata about the IM client.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.
{ # **DEPRECATED**: No data will be returned A person's bragging rights.
"metadata": { # Metadata about a field. # Metadata about the bragging rights.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
"value": "A String", # The bragging rights; for example, `climbed mount everest`.
},
],
- "metadata": { # The metadata about a person. # Output only. Metadata about the person.
- "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. 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.
- "A String",
- ],
- "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
- "sources": [ # The sources of data for the person.
- { # The source of a field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- ],
- "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
- "A String",
- ],
- "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
- },
- "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.
- "ageRanges": [ # Output only. The person's age ranges.
- { # A person's age range.
- "ageRange": "A String", # The age range.
- "metadata": { # Metadata about a field. # Metadata about the age range.
+ "sipAddresses": [ # The person's SIP addresses.
+ { # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
+ "metadata": { # Metadata about a field. # Metadata about the SIP address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
+ "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
- "formattedType": "A String", # 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.
- "person": "A String", # The name of the other person this relation refers to.
- "type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
"metadata": { # Metadata about a field. # Metadata about the relation.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- },
- ],
- "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
- { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
- "metadata": { # Metadata about a field. # Metadata about the residence.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
- "value": "A String", # The address of the residence.
- },
- ],
- "phoneNumbers": [ # The person's phone numbers.
- { # A person's phone number.
- "value": "A String", # The phone number.
- "canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
- "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "type": "A String", # The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
- "metadata": { # Metadata about a field. # Metadata about the phone number.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
- { # **DEPRECATED**: No data will be returned A brief one-line description of the person.
- "value": "A String", # The tagline.
- "metadata": { # Metadata about a field. # Metadata about the tagline.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "genders": [ # The person's genders. This field is a singleton for contact sources.
- { # A person's gender.
- "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.
- "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`
- "metadata": { # Metadata about a field. # Metadata about the gender.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
- },
- ],
- "biographies": [ # The person's biographies. This field is a singleton for contact sources.
- { # A person's short biography.
- "value": "A String", # The short biography.
- "contentType": "A String", # The content type of the biography.
- "metadata": { # Metadata about a field. # Metadata about the biography.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
+ "formattedType": "A String", # 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.
+ "type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
+ "person": "A String", # The name of the other person this relation refers to.
},
],
"miscKeywords": [ # The person's miscellaneous keywords.
{ # A person's miscellaneous keyword.
- "type": "A String", # The miscellaneous keyword type.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "type": "A String", # The miscellaneous keyword type.
"formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"value": "A String", # The value of the miscellaneous keyword.
},
],
- "sipAddresses": [ # The person's SIP addresses.
- { # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
- "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
- "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
- "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the SIP address.
+ "biographies": [ # The person's biographies. This field is a singleton for contact sources.
+ { # A person's short biography.
+ "contentType": "A String", # The content type of the biography.
+ "metadata": { # Metadata about a field. # Metadata about the biography.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "value": "A String", # The short biography.
},
],
- "externalIds": [ # The person's external IDs.
- { # An identifier from an external entity related to the person.
- "metadata": { # Metadata about a field. # Metadata about the external ID.
+ "userDefined": [ # The person's user defined data.
+ { # Arbitrary user data that is populated by the end users.
+ "metadata": { # Metadata about a field. # Metadata about the user defined data.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "value": "A String", # The value of the external ID.
- "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
+ "key": "A String", # The end user specified key of the user defined data.
+ "value": "A String", # The end user specified value of the user defined data.
},
],
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"skills": [ # The person's skills.
{ # A skill that the person has.
+ "value": "A String", # The skill; for example, `underwater basket weaving`.
"metadata": { # Metadata about a field. # Metadata about the skill.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "value": "A String", # The skill; for example, `underwater basket weaving`.
},
],
- "birthdays": [ # The person's birthdays. This field is a singleton for contact sources.
- { # 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.
- "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "locations": [ # The person's locations.
+ { # A person's location.
+ "deskCode": "A String", # The individual desk location.
+ "buildingId": "A String", # The building identifier.
+ "value": "A String", # The free-form value of the location.
+ "current": True or False, # Whether the location is the current location.
+ "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
+ "metadata": { # Metadata about a field. # Metadata about the location.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
+ },
+ "floor": "A String", # The floor name or number.
+ "floorSection": "A String", # The floor section in `floor_name`.
+ },
+ ],
+ "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.
+ "occupations": [ # The person's occupations.
+ { # A person's occupation.
+ "value": "A String", # The occupation; for example, `carpenter`.
+ "metadata": { # Metadata about a field. # Metadata about the occupation.
"verified": True or False, # 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.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "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`. # The date of the birthday.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
+ },
+ ],
+ "fileAses": [ # The person's file-ases.
+ { # The name that should be used to sort the person in a list.
+ "metadata": { # Metadata about a field. # Metadata about the file-as.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "text": "A String", # A free-form string representing the user's birthday.
+ "value": "A String", # The file-as value
+ },
+ ],
+ "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
+ { # **DEPRECATED**: No data will be returned A person's relationship interest .
+ "formattedValue": "A String", # 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.
+ "metadata": { # Metadata about a field. # Metadata about the relationship interest.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # 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.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
"url": "A String", # The URL of the cover photo.
},
],
- "fileAses": [ # The person's file-ases.
- { # The name that should be used to sort the person in a list.
- "metadata": { # Metadata about a field. # Metadata about the file-as.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The file-as value
- },
- ],
- "clientData": [ # The person's client data.
- { # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
- "metadata": { # Metadata about a field. # Metadata about the client data.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "key": "A String", # The client specified key of the client data.
- "value": "A String", # The client specified value of the client data.
- },
- ],
- "events": [ # The person's events.
- { # An event related to the person.
- "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`. # The date of the event.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`
- "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the event.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "userDefined": [ # The person's user defined data.
- { # Arbitrary user data that is populated by the end users.
- "metadata": { # Metadata about a field. # Metadata about the user defined data.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "key": "A String", # The end user specified key of the user defined data.
- "value": "A String", # The end user specified value of the user defined data.
- },
- ],
- "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
- "organizations": [ # The person's past or current organizations.
- { # A person's past or current organization. Overlapping date ranges are permitted.
- "endDate": { # 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`. # The end date when the person left the organization.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "name": "A String", # The name of the organization.
- "metadata": { # Metadata about a field. # Metadata about the organization.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "location": "A String", # The location of the organization office the person works at.
- "title": "A String", # The person's job title at the organization.
- "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
- "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
- "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
- "phoneticName": "A String", # The phonetic name of the organization.
- "formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "department": "A String", # The person's department at the organization.
- "startDate": { # 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`. # The start date when the person joined the organization.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "jobDescription": "A String", # The person's job description at the organization.
- "type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
- },
- ],
- "occupations": [ # The person's occupations.
- { # A person's occupation.
- "metadata": { # Metadata about a field. # Metadata about the occupation.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The occupation; for example, `carpenter`.
- },
- ],
- "calendarUrls": [ # The person's calendar URLs.
- { # A person's calendar URL.
- "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
- "url": "A String", # The calendar URL.
- "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the calendar URL.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "locales": [ # The person's locale preferences.
- { # A person's locale preference.
- "metadata": { # Metadata about a field. # Metadata about the locale.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
- },
- ],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
},
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
- "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
+ "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
- "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
- { # **DEPRECATED**: No data will be returned A person's relationship status.
- "metadata": { # Metadata about a field. # Metadata about the relationship status.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
- "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- },
- ],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"metadata": { # Metadata about a field. # Metadata about the photo.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
+ },
+ "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
+ "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
+ },
+ ],
+ "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
+ { # **DEPRECATED**: No data will be returned A person's relationship status.
+ "value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
+ "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "metadata": { # Metadata about a field. # Metadata about the relationship status.
"verified": True or False, # 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.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
- "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
+ },
+ ],
+ "names": [ # The person's names. This field is a singleton for contact sources.
+ { # A person's name. If the name is a mononym, the family name is empty.
+ "familyName": "A String", # The family name.
+ "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
+ "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
+ "phoneticFamilyName": "A String", # The family name spelled as it sounds.
+ "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
+ "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
+ "phoneticFullName": "A String", # The full name spelled as it sounds.
+ "phoneticGivenName": "A String", # The given name spelled as it sounds.
+ "unstructuredName": "A String", # The free form name value.
+ "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
+ "givenName": "A String", # The given name.
+ "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
+ "metadata": { # Metadata about a field. # Metadata about the name.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "middleName": "A String", # The middle name(s).
+ "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
+ },
+ ],
+ "metadata": { # The metadata about a person. # Output only. Metadata about the person.
+ "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. 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.
+ "A String",
+ ],
+ "sources": [ # The sources of data for the person.
+ { # The source of a field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ ],
+ "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
+ "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
+ },
+ "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
+ "nicknames": [ # The person's nicknames.
+ { # A person's nickname.
+ "value": "A String", # The nickname.
+ "metadata": { # Metadata about a field. # Metadata about the nickname.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "type": "A String", # The type of the nickname.
+ },
+ ],
+ "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
+ { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
+ "metadata": { # Metadata about a field. # Metadata about the residence.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The address of the residence.
+ "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
+ },
+ ],
+ "emailAddresses": [ # The person's email addresses.
+ { # A person's email address.
+ "metadata": { # Metadata about a field. # Metadata about the email address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "displayName": "A String", # The display name of the email.
+ "value": "A String", # The email address.
+ "formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ },
+ ],
+ "locales": [ # The person's locale preferences.
+ { # A person's locale preference.
+ "metadata": { # Metadata about a field. # Metadata about the locale.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
+ },
+ ],
+ "phoneNumbers": [ # The person's phone numbers.
+ { # A person's phone number.
+ "metadata": { # Metadata about a field. # Metadata about the phone number.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
+ "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
+ "value": "A String", # The phone number.
+ },
+ ],
+ "birthdays": [ # The person's birthdays. This field is a singleton for contact sources.
+ { # 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.
+ "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "text": "A String", # 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`. # The date of the birthday.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ },
+ ],
+ "events": [ # The person's events.
+ { # An event related to the person.
+ "type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`
+ "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`. # The date of the event.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "metadata": { # Metadata about a field. # Metadata about the event.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ },
+ ],
+ "imClients": [ # The person's instant messaging clients.
+ { # A person's instant messaging client.
+ "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
+ "metadata": { # Metadata about a field. # Metadata about the IM client.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ "username": "A String", # The user name used in the IM client.
+ "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ },
+ ],
+ "organizations": [ # The person's past or current organizations.
+ { # A person's past or current organization. Overlapping date ranges are permitted.
+ "phoneticName": "A String", # The phonetic name of the organization.
+ "title": "A String", # The person's job title at the organization.
+ "type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
+ "endDate": { # 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`. # The end date when the person left the organization.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "jobDescription": "A String", # The person's job description at the organization.
+ "name": "A String", # The name of the organization.
+ "metadata": { # Metadata about a field. # Metadata about the organization.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
+ "startDate": { # 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`. # The start date when the person joined the organization.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "location": "A String", # The location of the organization office the person works at.
+ "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
+ "department": "A String", # The person's department at the organization.
+ "formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
+ },
+ ],
+ "externalIds": [ # The person's external IDs.
+ { # An identifier from an external entity related to the person.
+ "value": "A String", # The value of the external ID.
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
+ "metadata": { # Metadata about a field. # Metadata about the external ID.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ },
+ ],
+ "addresses": [ # The person's street addresses.
+ { # A person's physical address. May be a P.O. box or street address. All fields are optional.
+ "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
+ "streetAddress": "A String", # The street address.
+ "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
+ "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "city": "A String", # The city of the address.
+ "metadata": { # Metadata about a field. # Metadata about the address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "poBox": "A String", # The P.O. box of the address.
+ "region": "A String", # The region of the address; for example, the state or province.
+ "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
+ "postalCode": "A String", # The postal code of the address.
+ "country": "A String", # The country of the address.
+ "type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ },
+ ],
+ "taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
+ { # **DEPRECATED**: No data will be returned A brief one-line description of the person.
+ "metadata": { # Metadata about a field. # Metadata about the tagline.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The tagline.
+ },
+ ],
+ "genders": [ # The person's genders. This field is a singleton for contact sources.
+ { # A person's gender.
+ "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`
+ "metadata": { # Metadata about a field. # Metadata about the gender.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.
+ "value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
+ },
+ ],
+ "calendarUrls": [ # The person's calendar URLs.
+ { # A person's calendar URL.
+ "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
+ "metadata": { # Metadata about a field. # Metadata about the calendar URL.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "url": "A String", # The calendar URL.
+ },
+ ],
+ "interests": [ # The person's interests.
+ { # One of the person's interests.
+ "value": "A String", # The interest; for example, `stargazing`.
+ "metadata": { # Metadata about a field. # Metadata about the interest.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
},
],
},
],
- "nextSyncToken": "A String", # A token, which can be sent as `sync_token` to retrieve changes since the last request. Request must set `request_sync_token` to return the sync token.
}</pre>
</div>
@@ -5357,7 +5357,7 @@
</div>
<div class="method">
- <code class="details" id="searchDirectoryPeople">searchDirectoryPeople(mergeSources=None, pageSize=None, pageToken=None, query=None, readMask=None, sources=None, x__xgafv=None)</code>
+ <code class="details" id="searchDirectoryPeople">searchDirectoryPeople(mergeSources=None, query=None, sources=None, pageToken=None, readMask=None, pageSize=None, x__xgafv=None)</code>
<pre>Provides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query.
Args:
@@ -5365,15 +5365,15 @@
Allowed values
DIRECTORY_MERGE_SOURCE_TYPE_UNSPECIFIED - Unspecified.
DIRECTORY_MERGE_SOURCE_TYPE_CONTACT - User owned contact.
- pageSize: integer, Optional. The number of people to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100 if not set or set to 0.
- pageToken: string, Optional. A page token, received from a previous `SearchDirectoryPeople` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchDirectoryPeople` must match the call that provided the page token.
query: string, Required. Prefix query that matches fields in the person. Does NOT use the read_mask for determining what fields to match.
- readMask: string, Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
sources: string, Required. Directory sources to return. (repeated)
Allowed values
DIRECTORY_SOURCE_TYPE_UNSPECIFIED - Unspecified.
DIRECTORY_SOURCE_TYPE_DOMAIN_CONTACT - G Suite domain shared contact.
DIRECTORY_SOURCE_TYPE_DOMAIN_PROFILE - G Suite domain profile.
+ pageToken: string, Optional. A page token, received from a previous `SearchDirectoryPeople` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchDirectoryPeople` must match the call that provided the page token.
+ readMask: string, Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
+ pageSize: integer, Optional. The number of people to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100 if not set or set to 0.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -5385,850 +5385,850 @@
{ # The response to a request for people in the authenticated user's domain directory that match the specified query.
"people": [ # The list of people in the domain directory that match the query.
{ # 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.
- "emailAddresses": [ # The person's email addresses.
- { # A person's email address.
- "value": "A String", # The email address.
- "formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the email address.
+ "clientData": [ # The person's client data.
+ { # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
+ "key": "A String", # The client specified key of the client data.
+ "metadata": { # Metadata about a field. # Metadata about the client data.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "displayName": "A String", # The display name of the email.
- "type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ "value": "A String", # The client specified value of the client data.
},
],
- "addresses": [ # The person's street addresses.
- { # A person's physical address. May be a P.O. box or street address. All fields are optional.
- "streetAddress": "A String", # The street address.
- "poBox": "A String", # The P.O. box of the address.
- "region": "A String", # The region of the address; for example, the state or province.
- "type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
- "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
- "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "postalCode": "A String", # The postal code of the address.
- "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
- "city": "A String", # The city of the address.
- "country": "A String", # The country of the address.
- "metadata": { # Metadata about a field. # Metadata about the address.
+ "ageRanges": [ # Output only. The person's age ranges.
+ { # A person's age range.
+ "ageRange": "A String", # The age range.
+ "metadata": { # Metadata about a field. # Metadata about the age range.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
- "interests": [ # The person's interests.
- { # One of the person's interests.
- "value": "A String", # The interest; for example, `stargazing`.
- "metadata": { # Metadata about a field. # Metadata about the interest.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "locations": [ # The person's locations.
- { # A person's location.
- "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
- "floor": "A String", # The floor name or number.
- "deskCode": "A String", # The individual desk location.
- "floorSection": "A String", # The floor section in `floor_name`.
- "value": "A String", # The free-form value of the location.
- "metadata": { # Metadata about a field. # Metadata about the location.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "buildingId": "A String", # The building identifier.
- "current": True or False, # Whether the location is the current location.
- },
- ],
- "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
- { # **DEPRECATED**: No data will be returned A person's relationship interest .
- "formattedValue": "A String", # 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.
- "value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
- "metadata": { # Metadata about a field. # Metadata about the relationship interest.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "names": [ # The person's names. This field is a singleton for contact sources.
- { # A person's name. If the name is a mononym, the family name is empty.
- "metadata": { # Metadata about a field. # Metadata about the name.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "phoneticFamilyName": "A String", # The family name spelled as it sounds.
- "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
- "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
- "familyName": "A String", # The family name.
- "phoneticGivenName": "A String", # The given name spelled as it sounds.
- "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
- "middleName": "A String", # The middle name(s).
- "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
- "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
- "unstructuredName": "A String", # The free form name value.
- "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
- "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
- "phoneticFullName": "A String", # The full name spelled as it sounds.
- "givenName": "A String", # The given name.
- },
- ],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
- "value": "A String", # The URL.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the URL. The type can be custom or one of these predefined values: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Currents application. * `other`
+ "value": "A String", # The URL.
"metadata": { # Metadata about a field. # Metadata about the URL.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "nicknames": [ # The person's nicknames.
- { # A person's nickname.
- "type": "A String", # The type of the nickname.
- "metadata": { # Metadata about a field. # Metadata about the nickname.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The nickname.
- },
- ],
- "imClients": [ # The person's instant messaging clients.
- { # A person's instant messaging client.
- "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "username": "A String", # The user name used in the IM client.
- "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
- "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "metadata": { # Metadata about a field. # Metadata about the IM client.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.
{ # **DEPRECATED**: No data will be returned A person's bragging rights.
"metadata": { # Metadata about a field. # Metadata about the bragging rights.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
"value": "A String", # The bragging rights; for example, `climbed mount everest`.
},
],
- "metadata": { # The metadata about a person. # Output only. Metadata about the person.
- "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. 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.
- "A String",
- ],
- "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
- "sources": [ # The sources of data for the person.
- { # The source of a field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- ],
- "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
- "A String",
- ],
- "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
- },
- "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.
- "ageRanges": [ # Output only. The person's age ranges.
- { # A person's age range.
- "ageRange": "A String", # The age range.
- "metadata": { # Metadata about a field. # Metadata about the age range.
+ "sipAddresses": [ # The person's SIP addresses.
+ { # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
+ "metadata": { # Metadata about a field. # Metadata about the SIP address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
+ "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
- "formattedType": "A String", # 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.
- "person": "A String", # The name of the other person this relation refers to.
- "type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
"metadata": { # Metadata about a field. # Metadata about the relation.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- },
- ],
- "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
- { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
- "metadata": { # Metadata about a field. # Metadata about the residence.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
- "value": "A String", # The address of the residence.
- },
- ],
- "phoneNumbers": [ # The person's phone numbers.
- { # A person's phone number.
- "value": "A String", # The phone number.
- "canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
- "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "type": "A String", # The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
- "metadata": { # Metadata about a field. # Metadata about the phone number.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
- { # **DEPRECATED**: No data will be returned A brief one-line description of the person.
- "value": "A String", # The tagline.
- "metadata": { # Metadata about a field. # Metadata about the tagline.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "genders": [ # The person's genders. This field is a singleton for contact sources.
- { # A person's gender.
- "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.
- "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`
- "metadata": { # Metadata about a field. # Metadata about the gender.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
- },
- ],
- "biographies": [ # The person's biographies. This field is a singleton for contact sources.
- { # A person's short biography.
- "value": "A String", # The short biography.
- "contentType": "A String", # The content type of the biography.
- "metadata": { # Metadata about a field. # Metadata about the biography.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
+ "formattedType": "A String", # 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.
+ "type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
+ "person": "A String", # The name of the other person this relation refers to.
},
],
"miscKeywords": [ # The person's miscellaneous keywords.
{ # A person's miscellaneous keyword.
- "type": "A String", # The miscellaneous keyword type.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "type": "A String", # The miscellaneous keyword type.
"formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"value": "A String", # The value of the miscellaneous keyword.
},
],
- "sipAddresses": [ # The person's SIP addresses.
- { # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
- "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
- "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
- "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the SIP address.
+ "biographies": [ # The person's biographies. This field is a singleton for contact sources.
+ { # A person's short biography.
+ "contentType": "A String", # The content type of the biography.
+ "metadata": { # Metadata about a field. # Metadata about the biography.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "value": "A String", # The short biography.
},
],
- "externalIds": [ # The person's external IDs.
- { # An identifier from an external entity related to the person.
- "metadata": { # Metadata about a field. # Metadata about the external ID.
+ "userDefined": [ # The person's user defined data.
+ { # Arbitrary user data that is populated by the end users.
+ "metadata": { # Metadata about a field. # Metadata about the user defined data.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "value": "A String", # The value of the external ID.
- "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
+ "key": "A String", # The end user specified key of the user defined data.
+ "value": "A String", # The end user specified value of the user defined data.
},
],
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"skills": [ # The person's skills.
{ # A skill that the person has.
+ "value": "A String", # The skill; for example, `underwater basket weaving`.
"metadata": { # Metadata about a field. # Metadata about the skill.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "value": "A String", # The skill; for example, `underwater basket weaving`.
},
],
- "birthdays": [ # The person's birthdays. This field is a singleton for contact sources.
- { # 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.
- "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "locations": [ # The person's locations.
+ { # A person's location.
+ "deskCode": "A String", # The individual desk location.
+ "buildingId": "A String", # The building identifier.
+ "value": "A String", # The free-form value of the location.
+ "current": True or False, # Whether the location is the current location.
+ "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
+ "metadata": { # Metadata about a field. # Metadata about the location.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
+ },
+ "floor": "A String", # The floor name or number.
+ "floorSection": "A String", # The floor section in `floor_name`.
+ },
+ ],
+ "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.
+ "occupations": [ # The person's occupations.
+ { # A person's occupation.
+ "value": "A String", # The occupation; for example, `carpenter`.
+ "metadata": { # Metadata about a field. # Metadata about the occupation.
"verified": True or False, # 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.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "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`. # The date of the birthday.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
+ },
+ ],
+ "fileAses": [ # The person's file-ases.
+ { # The name that should be used to sort the person in a list.
+ "metadata": { # Metadata about a field. # Metadata about the file-as.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "text": "A String", # A free-form string representing the user's birthday.
+ "value": "A String", # The file-as value
+ },
+ ],
+ "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
+ { # **DEPRECATED**: No data will be returned A person's relationship interest .
+ "formattedValue": "A String", # 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.
+ "metadata": { # Metadata about a field. # Metadata about the relationship interest.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # 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.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
"url": "A String", # The URL of the cover photo.
},
],
- "fileAses": [ # The person's file-ases.
- { # The name that should be used to sort the person in a list.
- "metadata": { # Metadata about a field. # Metadata about the file-as.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The file-as value
- },
- ],
- "clientData": [ # The person's client data.
- { # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
- "metadata": { # Metadata about a field. # Metadata about the client data.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "key": "A String", # The client specified key of the client data.
- "value": "A String", # The client specified value of the client data.
- },
- ],
- "events": [ # The person's events.
- { # An event related to the person.
- "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`. # The date of the event.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`
- "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the event.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "userDefined": [ # The person's user defined data.
- { # Arbitrary user data that is populated by the end users.
- "metadata": { # Metadata about a field. # Metadata about the user defined data.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "key": "A String", # The end user specified key of the user defined data.
- "value": "A String", # The end user specified value of the user defined data.
- },
- ],
- "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
- "organizations": [ # The person's past or current organizations.
- { # A person's past or current organization. Overlapping date ranges are permitted.
- "endDate": { # 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`. # The end date when the person left the organization.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "name": "A String", # The name of the organization.
- "metadata": { # Metadata about a field. # Metadata about the organization.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "location": "A String", # The location of the organization office the person works at.
- "title": "A String", # The person's job title at the organization.
- "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
- "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
- "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
- "phoneticName": "A String", # The phonetic name of the organization.
- "formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "department": "A String", # The person's department at the organization.
- "startDate": { # 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`. # The start date when the person joined the organization.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "jobDescription": "A String", # The person's job description at the organization.
- "type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
- },
- ],
- "occupations": [ # The person's occupations.
- { # A person's occupation.
- "metadata": { # Metadata about a field. # Metadata about the occupation.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The occupation; for example, `carpenter`.
- },
- ],
- "calendarUrls": [ # The person's calendar URLs.
- { # A person's calendar URL.
- "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
- "url": "A String", # The calendar URL.
- "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the calendar URL.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "locales": [ # The person's locale preferences.
- { # A person's locale preference.
- "metadata": { # Metadata about a field. # Metadata about the locale.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
- },
- ],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
},
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
- "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
+ "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
- "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
- { # **DEPRECATED**: No data will be returned A person's relationship status.
- "metadata": { # Metadata about a field. # Metadata about the relationship status.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
- "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- },
- ],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"metadata": { # Metadata about a field. # Metadata about the photo.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
+ },
+ "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
+ "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
+ },
+ ],
+ "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
+ { # **DEPRECATED**: No data will be returned A person's relationship status.
+ "value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
+ "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "metadata": { # Metadata about a field. # Metadata about the relationship status.
"verified": True or False, # 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.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
- "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
+ },
+ ],
+ "names": [ # The person's names. This field is a singleton for contact sources.
+ { # A person's name. If the name is a mononym, the family name is empty.
+ "familyName": "A String", # The family name.
+ "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
+ "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
+ "phoneticFamilyName": "A String", # The family name spelled as it sounds.
+ "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
+ "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
+ "phoneticFullName": "A String", # The full name spelled as it sounds.
+ "phoneticGivenName": "A String", # The given name spelled as it sounds.
+ "unstructuredName": "A String", # The free form name value.
+ "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
+ "givenName": "A String", # The given name.
+ "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
+ "metadata": { # Metadata about a field. # Metadata about the name.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "middleName": "A String", # The middle name(s).
+ "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
+ },
+ ],
+ "metadata": { # The metadata about a person. # Output only. Metadata about the person.
+ "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. 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.
+ "A String",
+ ],
+ "sources": [ # The sources of data for the person.
+ { # The source of a field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ ],
+ "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
+ "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
+ },
+ "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
+ "nicknames": [ # The person's nicknames.
+ { # A person's nickname.
+ "value": "A String", # The nickname.
+ "metadata": { # Metadata about a field. # Metadata about the nickname.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "type": "A String", # The type of the nickname.
+ },
+ ],
+ "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
+ { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
+ "metadata": { # Metadata about a field. # Metadata about the residence.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The address of the residence.
+ "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
+ },
+ ],
+ "emailAddresses": [ # The person's email addresses.
+ { # A person's email address.
+ "metadata": { # Metadata about a field. # Metadata about the email address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "displayName": "A String", # The display name of the email.
+ "value": "A String", # The email address.
+ "formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ },
+ ],
+ "locales": [ # The person's locale preferences.
+ { # A person's locale preference.
+ "metadata": { # Metadata about a field. # Metadata about the locale.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
+ },
+ ],
+ "phoneNumbers": [ # The person's phone numbers.
+ { # A person's phone number.
+ "metadata": { # Metadata about a field. # Metadata about the phone number.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
+ "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
+ "value": "A String", # The phone number.
+ },
+ ],
+ "birthdays": [ # The person's birthdays. This field is a singleton for contact sources.
+ { # 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.
+ "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "text": "A String", # 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`. # The date of the birthday.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ },
+ ],
+ "events": [ # The person's events.
+ { # An event related to the person.
+ "type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`
+ "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`. # The date of the event.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "metadata": { # Metadata about a field. # Metadata about the event.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ },
+ ],
+ "imClients": [ # The person's instant messaging clients.
+ { # A person's instant messaging client.
+ "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
+ "metadata": { # Metadata about a field. # Metadata about the IM client.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ "username": "A String", # The user name used in the IM client.
+ "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ },
+ ],
+ "organizations": [ # The person's past or current organizations.
+ { # A person's past or current organization. Overlapping date ranges are permitted.
+ "phoneticName": "A String", # The phonetic name of the organization.
+ "title": "A String", # The person's job title at the organization.
+ "type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
+ "endDate": { # 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`. # The end date when the person left the organization.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "jobDescription": "A String", # The person's job description at the organization.
+ "name": "A String", # The name of the organization.
+ "metadata": { # Metadata about a field. # Metadata about the organization.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
+ "startDate": { # 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`. # The start date when the person joined the organization.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "location": "A String", # The location of the organization office the person works at.
+ "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
+ "department": "A String", # The person's department at the organization.
+ "formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
+ },
+ ],
+ "externalIds": [ # The person's external IDs.
+ { # An identifier from an external entity related to the person.
+ "value": "A String", # The value of the external ID.
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
+ "metadata": { # Metadata about a field. # Metadata about the external ID.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ },
+ ],
+ "addresses": [ # The person's street addresses.
+ { # A person's physical address. May be a P.O. box or street address. All fields are optional.
+ "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
+ "streetAddress": "A String", # The street address.
+ "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
+ "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "city": "A String", # The city of the address.
+ "metadata": { # Metadata about a field. # Metadata about the address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "poBox": "A String", # The P.O. box of the address.
+ "region": "A String", # The region of the address; for example, the state or province.
+ "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
+ "postalCode": "A String", # The postal code of the address.
+ "country": "A String", # The country of the address.
+ "type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ },
+ ],
+ "taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
+ { # **DEPRECATED**: No data will be returned A brief one-line description of the person.
+ "metadata": { # Metadata about a field. # Metadata about the tagline.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The tagline.
+ },
+ ],
+ "genders": [ # The person's genders. This field is a singleton for contact sources.
+ { # A person's gender.
+ "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`
+ "metadata": { # Metadata about a field. # Metadata about the gender.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.
+ "value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
+ },
+ ],
+ "calendarUrls": [ # The person's calendar URLs.
+ { # A person's calendar URL.
+ "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
+ "metadata": { # Metadata about a field. # Metadata about the calendar URL.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "url": "A String", # The calendar URL.
+ },
+ ],
+ "interests": [ # The person's interests.
+ { # One of the person's interests.
+ "value": "A String", # The interest; for example, `stargazing`.
+ "metadata": { # Metadata about a field. # Metadata about the interest.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
},
],
},
],
- "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"totalSize": 42, # The total number of items in the list without pagination.
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>
@@ -6247,7 +6247,7 @@
</div>
<div class="method">
- <code class="details" id="updateContact">updateContact(resourceName, body=None, sources=None, updatePersonFields=None, personFields=None, x__xgafv=None)</code>
+ <code class="details" id="updateContact">updateContact(resourceName, body=None, personFields=None, sources=None, updatePersonFields=None, x__xgafv=None)</code>
<pre>Update contact data for an existing contact person. Any non-contact data will not be modified. Any non-contact data in the person to update will be ignored. All fields specified in the `update_mask` will be replaced. The server returns a 400 error if `person.metadata.sources` is not specified for the contact to be updated or if there is no contact source. The server returns a 400 error with reason `"failedPrecondition"` if `person.metadata.sources.etag` is different than the contact's etag, which indicates the contact has changed since its data was read. Clients should get the latest person and merge their updates into the latest person. The server returns a 400 error if `memberships` are being updated and there are no contact group memberships specified on the person. The server returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names
Args:
@@ -6256,848 +6256,849 @@
The object takes the form of:
{ # 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.
- "emailAddresses": [ # The person's email addresses.
- { # A person's email address.
- "value": "A String", # The email address.
- "formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the email address.
+ "clientData": [ # The person's client data.
+ { # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
+ "key": "A String", # The client specified key of the client data.
+ "metadata": { # Metadata about a field. # Metadata about the client data.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "displayName": "A String", # The display name of the email.
- "type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ "value": "A String", # The client specified value of the client data.
},
],
- "addresses": [ # The person's street addresses.
- { # A person's physical address. May be a P.O. box or street address. All fields are optional.
- "streetAddress": "A String", # The street address.
- "poBox": "A String", # The P.O. box of the address.
- "region": "A String", # The region of the address; for example, the state or province.
- "type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
- "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
- "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "postalCode": "A String", # The postal code of the address.
- "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
- "city": "A String", # The city of the address.
- "country": "A String", # The country of the address.
- "metadata": { # Metadata about a field. # Metadata about the address.
+ "ageRanges": [ # Output only. The person's age ranges.
+ { # A person's age range.
+ "ageRange": "A String", # The age range.
+ "metadata": { # Metadata about a field. # Metadata about the age range.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
- "interests": [ # The person's interests.
- { # One of the person's interests.
- "value": "A String", # The interest; for example, `stargazing`.
- "metadata": { # Metadata about a field. # Metadata about the interest.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "locations": [ # The person's locations.
- { # A person's location.
- "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
- "floor": "A String", # The floor name or number.
- "deskCode": "A String", # The individual desk location.
- "floorSection": "A String", # The floor section in `floor_name`.
- "value": "A String", # The free-form value of the location.
- "metadata": { # Metadata about a field. # Metadata about the location.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "buildingId": "A String", # The building identifier.
- "current": True or False, # Whether the location is the current location.
- },
- ],
- "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
- { # **DEPRECATED**: No data will be returned A person's relationship interest .
- "formattedValue": "A String", # 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.
- "value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
- "metadata": { # Metadata about a field. # Metadata about the relationship interest.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "names": [ # The person's names. This field is a singleton for contact sources.
- { # A person's name. If the name is a mononym, the family name is empty.
- "metadata": { # Metadata about a field. # Metadata about the name.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "phoneticFamilyName": "A String", # The family name spelled as it sounds.
- "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
- "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
- "familyName": "A String", # The family name.
- "phoneticGivenName": "A String", # The given name spelled as it sounds.
- "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
- "middleName": "A String", # The middle name(s).
- "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
- "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
- "unstructuredName": "A String", # The free form name value.
- "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
- "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
- "phoneticFullName": "A String", # The full name spelled as it sounds.
- "givenName": "A String", # The given name.
- },
- ],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
- "value": "A String", # The URL.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the URL. The type can be custom or one of these predefined values: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Currents application. * `other`
+ "value": "A String", # The URL.
"metadata": { # Metadata about a field. # Metadata about the URL.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "nicknames": [ # The person's nicknames.
- { # A person's nickname.
- "type": "A String", # The type of the nickname.
- "metadata": { # Metadata about a field. # Metadata about the nickname.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The nickname.
- },
- ],
- "imClients": [ # The person's instant messaging clients.
- { # A person's instant messaging client.
- "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "username": "A String", # The user name used in the IM client.
- "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
- "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "metadata": { # Metadata about a field. # Metadata about the IM client.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.
{ # **DEPRECATED**: No data will be returned A person's bragging rights.
"metadata": { # Metadata about a field. # Metadata about the bragging rights.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
"value": "A String", # The bragging rights; for example, `climbed mount everest`.
},
],
- "metadata": { # The metadata about a person. # Output only. Metadata about the person.
- "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. 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.
- "A String",
- ],
- "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
- "sources": [ # The sources of data for the person.
- { # The source of a field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- ],
- "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
- "A String",
- ],
- "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
- },
- "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.
- "ageRanges": [ # Output only. The person's age ranges.
- { # A person's age range.
- "ageRange": "A String", # The age range.
- "metadata": { # Metadata about a field. # Metadata about the age range.
+ "sipAddresses": [ # The person's SIP addresses.
+ { # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
+ "metadata": { # Metadata about a field. # Metadata about the SIP address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
+ "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
- "formattedType": "A String", # 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.
- "person": "A String", # The name of the other person this relation refers to.
- "type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
"metadata": { # Metadata about a field. # Metadata about the relation.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- },
- ],
- "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
- { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
- "metadata": { # Metadata about a field. # Metadata about the residence.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
- "value": "A String", # The address of the residence.
- },
- ],
- "phoneNumbers": [ # The person's phone numbers.
- { # A person's phone number.
- "value": "A String", # The phone number.
- "canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
- "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "type": "A String", # The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
- "metadata": { # Metadata about a field. # Metadata about the phone number.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
- { # **DEPRECATED**: No data will be returned A brief one-line description of the person.
- "value": "A String", # The tagline.
- "metadata": { # Metadata about a field. # Metadata about the tagline.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "genders": [ # The person's genders. This field is a singleton for contact sources.
- { # A person's gender.
- "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.
- "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`
- "metadata": { # Metadata about a field. # Metadata about the gender.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
- },
- ],
- "biographies": [ # The person's biographies. This field is a singleton for contact sources.
- { # A person's short biography.
- "value": "A String", # The short biography.
- "contentType": "A String", # The content type of the biography.
- "metadata": { # Metadata about a field. # Metadata about the biography.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
+ "formattedType": "A String", # 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.
+ "type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
+ "person": "A String", # The name of the other person this relation refers to.
},
],
"miscKeywords": [ # The person's miscellaneous keywords.
{ # A person's miscellaneous keyword.
- "type": "A String", # The miscellaneous keyword type.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "type": "A String", # The miscellaneous keyword type.
"formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"value": "A String", # The value of the miscellaneous keyword.
},
],
- "sipAddresses": [ # The person's SIP addresses.
- { # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
- "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
- "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
- "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the SIP address.
+ "biographies": [ # The person's biographies. This field is a singleton for contact sources.
+ { # A person's short biography.
+ "contentType": "A String", # The content type of the biography.
+ "metadata": { # Metadata about a field. # Metadata about the biography.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "value": "A String", # The short biography.
},
],
- "externalIds": [ # The person's external IDs.
- { # An identifier from an external entity related to the person.
- "metadata": { # Metadata about a field. # Metadata about the external ID.
+ "userDefined": [ # The person's user defined data.
+ { # Arbitrary user data that is populated by the end users.
+ "metadata": { # Metadata about a field. # Metadata about the user defined data.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "value": "A String", # The value of the external ID.
- "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
+ "key": "A String", # The end user specified key of the user defined data.
+ "value": "A String", # The end user specified value of the user defined data.
},
],
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"skills": [ # The person's skills.
{ # A skill that the person has.
+ "value": "A String", # The skill; for example, `underwater basket weaving`.
"metadata": { # Metadata about a field. # Metadata about the skill.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "value": "A String", # The skill; for example, `underwater basket weaving`.
},
],
- "birthdays": [ # The person's birthdays. This field is a singleton for contact sources.
- { # 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.
- "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "locations": [ # The person's locations.
+ { # A person's location.
+ "deskCode": "A String", # The individual desk location.
+ "buildingId": "A String", # The building identifier.
+ "value": "A String", # The free-form value of the location.
+ "current": True or False, # Whether the location is the current location.
+ "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
+ "metadata": { # Metadata about a field. # Metadata about the location.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
+ },
+ "floor": "A String", # The floor name or number.
+ "floorSection": "A String", # The floor section in `floor_name`.
+ },
+ ],
+ "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.
+ "occupations": [ # The person's occupations.
+ { # A person's occupation.
+ "value": "A String", # The occupation; for example, `carpenter`.
+ "metadata": { # Metadata about a field. # Metadata about the occupation.
"verified": True or False, # 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.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "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`. # The date of the birthday.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
+ },
+ ],
+ "fileAses": [ # The person's file-ases.
+ { # The name that should be used to sort the person in a list.
+ "metadata": { # Metadata about a field. # Metadata about the file-as.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "text": "A String", # A free-form string representing the user's birthday.
+ "value": "A String", # The file-as value
+ },
+ ],
+ "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
+ { # **DEPRECATED**: No data will be returned A person's relationship interest .
+ "formattedValue": "A String", # 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.
+ "metadata": { # Metadata about a field. # Metadata about the relationship interest.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # 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.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
"url": "A String", # The URL of the cover photo.
},
],
- "fileAses": [ # The person's file-ases.
- { # The name that should be used to sort the person in a list.
- "metadata": { # Metadata about a field. # Metadata about the file-as.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The file-as value
- },
- ],
- "clientData": [ # The person's client data.
- { # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
- "metadata": { # Metadata about a field. # Metadata about the client data.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "key": "A String", # The client specified key of the client data.
- "value": "A String", # The client specified value of the client data.
- },
- ],
- "events": [ # The person's events.
- { # An event related to the person.
- "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`. # The date of the event.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`
- "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the event.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "userDefined": [ # The person's user defined data.
- { # Arbitrary user data that is populated by the end users.
- "metadata": { # Metadata about a field. # Metadata about the user defined data.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "key": "A String", # The end user specified key of the user defined data.
- "value": "A String", # The end user specified value of the user defined data.
- },
- ],
- "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
- "organizations": [ # The person's past or current organizations.
- { # A person's past or current organization. Overlapping date ranges are permitted.
- "endDate": { # 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`. # The end date when the person left the organization.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "name": "A String", # The name of the organization.
- "metadata": { # Metadata about a field. # Metadata about the organization.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "location": "A String", # The location of the organization office the person works at.
- "title": "A String", # The person's job title at the organization.
- "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
- "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
- "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
- "phoneticName": "A String", # The phonetic name of the organization.
- "formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "department": "A String", # The person's department at the organization.
- "startDate": { # 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`. # The start date when the person joined the organization.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "jobDescription": "A String", # The person's job description at the organization.
- "type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
- },
- ],
- "occupations": [ # The person's occupations.
- { # A person's occupation.
- "metadata": { # Metadata about a field. # Metadata about the occupation.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The occupation; for example, `carpenter`.
- },
- ],
- "calendarUrls": [ # The person's calendar URLs.
- { # A person's calendar URL.
- "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
- "url": "A String", # The calendar URL.
- "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the calendar URL.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "locales": [ # The person's locale preferences.
- { # A person's locale preference.
- "metadata": { # Metadata about a field. # Metadata about the locale.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
- },
- ],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
},
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
- "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
+ "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
- "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
- { # **DEPRECATED**: No data will be returned A person's relationship status.
- "metadata": { # Metadata about a field. # Metadata about the relationship status.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
- "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- },
- ],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"metadata": { # Metadata about a field. # Metadata about the photo.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
+ },
+ "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
+ "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
+ },
+ ],
+ "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
+ { # **DEPRECATED**: No data will be returned A person's relationship status.
+ "value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
+ "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "metadata": { # Metadata about a field. # Metadata about the relationship status.
"verified": True or False, # 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.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
- "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
+ },
+ ],
+ "names": [ # The person's names. This field is a singleton for contact sources.
+ { # A person's name. If the name is a mononym, the family name is empty.
+ "familyName": "A String", # The family name.
+ "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
+ "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
+ "phoneticFamilyName": "A String", # The family name spelled as it sounds.
+ "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
+ "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
+ "phoneticFullName": "A String", # The full name spelled as it sounds.
+ "phoneticGivenName": "A String", # The given name spelled as it sounds.
+ "unstructuredName": "A String", # The free form name value.
+ "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
+ "givenName": "A String", # The given name.
+ "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
+ "metadata": { # Metadata about a field. # Metadata about the name.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "middleName": "A String", # The middle name(s).
+ "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
+ },
+ ],
+ "metadata": { # The metadata about a person. # Output only. Metadata about the person.
+ "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. 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.
+ "A String",
+ ],
+ "sources": [ # The sources of data for the person.
+ { # The source of a field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ ],
+ "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
+ "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
+ },
+ "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
+ "nicknames": [ # The person's nicknames.
+ { # A person's nickname.
+ "value": "A String", # The nickname.
+ "metadata": { # Metadata about a field. # Metadata about the nickname.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "type": "A String", # The type of the nickname.
+ },
+ ],
+ "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
+ { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
+ "metadata": { # Metadata about a field. # Metadata about the residence.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The address of the residence.
+ "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
+ },
+ ],
+ "emailAddresses": [ # The person's email addresses.
+ { # A person's email address.
+ "metadata": { # Metadata about a field. # Metadata about the email address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "displayName": "A String", # The display name of the email.
+ "value": "A String", # The email address.
+ "formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ },
+ ],
+ "locales": [ # The person's locale preferences.
+ { # A person's locale preference.
+ "metadata": { # Metadata about a field. # Metadata about the locale.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
+ },
+ ],
+ "phoneNumbers": [ # The person's phone numbers.
+ { # A person's phone number.
+ "metadata": { # Metadata about a field. # Metadata about the phone number.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
+ "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
+ "value": "A String", # The phone number.
+ },
+ ],
+ "birthdays": [ # The person's birthdays. This field is a singleton for contact sources.
+ { # 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.
+ "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "text": "A String", # 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`. # The date of the birthday.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ },
+ ],
+ "events": [ # The person's events.
+ { # An event related to the person.
+ "type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`
+ "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`. # The date of the event.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "metadata": { # Metadata about a field. # Metadata about the event.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ },
+ ],
+ "imClients": [ # The person's instant messaging clients.
+ { # A person's instant messaging client.
+ "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
+ "metadata": { # Metadata about a field. # Metadata about the IM client.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ "username": "A String", # The user name used in the IM client.
+ "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ },
+ ],
+ "organizations": [ # The person's past or current organizations.
+ { # A person's past or current organization. Overlapping date ranges are permitted.
+ "phoneticName": "A String", # The phonetic name of the organization.
+ "title": "A String", # The person's job title at the organization.
+ "type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
+ "endDate": { # 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`. # The end date when the person left the organization.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "jobDescription": "A String", # The person's job description at the organization.
+ "name": "A String", # The name of the organization.
+ "metadata": { # Metadata about a field. # Metadata about the organization.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
+ "startDate": { # 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`. # The start date when the person joined the organization.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "location": "A String", # The location of the organization office the person works at.
+ "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
+ "department": "A String", # The person's department at the organization.
+ "formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
+ },
+ ],
+ "externalIds": [ # The person's external IDs.
+ { # An identifier from an external entity related to the person.
+ "value": "A String", # The value of the external ID.
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
+ "metadata": { # Metadata about a field. # Metadata about the external ID.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ },
+ ],
+ "addresses": [ # The person's street addresses.
+ { # A person's physical address. May be a P.O. box or street address. All fields are optional.
+ "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
+ "streetAddress": "A String", # The street address.
+ "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
+ "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "city": "A String", # The city of the address.
+ "metadata": { # Metadata about a field. # Metadata about the address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "poBox": "A String", # The P.O. box of the address.
+ "region": "A String", # The region of the address; for example, the state or province.
+ "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
+ "postalCode": "A String", # The postal code of the address.
+ "country": "A String", # The country of the address.
+ "type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ },
+ ],
+ "taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
+ { # **DEPRECATED**: No data will be returned A brief one-line description of the person.
+ "metadata": { # Metadata about a field. # Metadata about the tagline.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The tagline.
+ },
+ ],
+ "genders": [ # The person's genders. This field is a singleton for contact sources.
+ { # A person's gender.
+ "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`
+ "metadata": { # Metadata about a field. # Metadata about the gender.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.
+ "value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
+ },
+ ],
+ "calendarUrls": [ # The person's calendar URLs.
+ { # A person's calendar URL.
+ "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
+ "metadata": { # Metadata about a field. # Metadata about the calendar URL.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "url": "A String", # The calendar URL.
+ },
+ ],
+ "interests": [ # The person's interests.
+ { # One of the person's interests.
+ "value": "A String", # The interest; for example, `stargazing`.
+ "metadata": { # Metadata about a field. # Metadata about the interest.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
},
],
}
+ personFields: string, Optional. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
sources: string, Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set. (repeated)
Allowed values
READ_SOURCE_TYPE_UNSPECIFIED - Unspecified.
@@ -7105,7 +7106,6 @@
READ_SOURCE_TYPE_CONTACT - Returns SourceType.CONTACT.
READ_SOURCE_TYPE_DOMAIN_CONTACT - Returns SourceType.DOMAIN_CONTACT.
updatePersonFields: string, Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * calendarUrls * clientData * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * sipAddresses * urls * userDefined
- personFields: string, Optional. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -7115,844 +7115,844 @@
An object of the form:
{ # 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.
- "emailAddresses": [ # The person's email addresses.
- { # A person's email address.
- "value": "A String", # The email address.
- "formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the email address.
+ "clientData": [ # The person's client data.
+ { # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
+ "key": "A String", # The client specified key of the client data.
+ "metadata": { # Metadata about a field. # Metadata about the client data.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "displayName": "A String", # The display name of the email.
- "type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ "value": "A String", # The client specified value of the client data.
},
],
- "addresses": [ # The person's street addresses.
- { # A person's physical address. May be a P.O. box or street address. All fields are optional.
- "streetAddress": "A String", # The street address.
- "poBox": "A String", # The P.O. box of the address.
- "region": "A String", # The region of the address; for example, the state or province.
- "type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
- "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
- "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "postalCode": "A String", # The postal code of the address.
- "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
- "city": "A String", # The city of the address.
- "country": "A String", # The country of the address.
- "metadata": { # Metadata about a field. # Metadata about the address.
+ "ageRanges": [ # Output only. The person's age ranges.
+ { # A person's age range.
+ "ageRange": "A String", # The age range.
+ "metadata": { # Metadata about a field. # Metadata about the age range.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
- "interests": [ # The person's interests.
- { # One of the person's interests.
- "value": "A String", # The interest; for example, `stargazing`.
- "metadata": { # Metadata about a field. # Metadata about the interest.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "locations": [ # The person's locations.
- { # A person's location.
- "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
- "floor": "A String", # The floor name or number.
- "deskCode": "A String", # The individual desk location.
- "floorSection": "A String", # The floor section in `floor_name`.
- "value": "A String", # The free-form value of the location.
- "metadata": { # Metadata about a field. # Metadata about the location.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "buildingId": "A String", # The building identifier.
- "current": True or False, # Whether the location is the current location.
- },
- ],
- "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
- { # **DEPRECATED**: No data will be returned A person's relationship interest .
- "formattedValue": "A String", # 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.
- "value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
- "metadata": { # Metadata about a field. # Metadata about the relationship interest.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "names": [ # The person's names. This field is a singleton for contact sources.
- { # A person's name. If the name is a mononym, the family name is empty.
- "metadata": { # Metadata about a field. # Metadata about the name.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "phoneticFamilyName": "A String", # The family name spelled as it sounds.
- "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
- "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
- "familyName": "A String", # The family name.
- "phoneticGivenName": "A String", # The given name spelled as it sounds.
- "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
- "middleName": "A String", # The middle name(s).
- "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
- "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
- "unstructuredName": "A String", # The free form name value.
- "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
- "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
- "phoneticFullName": "A String", # The full name spelled as it sounds.
- "givenName": "A String", # The given name.
- },
- ],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
- "value": "A String", # The URL.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the URL. The type can be custom or one of these predefined values: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Currents application. * `other`
+ "value": "A String", # The URL.
"metadata": { # Metadata about a field. # Metadata about the URL.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "nicknames": [ # The person's nicknames.
- { # A person's nickname.
- "type": "A String", # The type of the nickname.
- "metadata": { # Metadata about a field. # Metadata about the nickname.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The nickname.
- },
- ],
- "imClients": [ # The person's instant messaging clients.
- { # A person's instant messaging client.
- "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "username": "A String", # The user name used in the IM client.
- "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
- "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "metadata": { # Metadata about a field. # Metadata about the IM client.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.
{ # **DEPRECATED**: No data will be returned A person's bragging rights.
"metadata": { # Metadata about a field. # Metadata about the bragging rights.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
"value": "A String", # The bragging rights; for example, `climbed mount everest`.
},
],
- "metadata": { # The metadata about a person. # Output only. Metadata about the person.
- "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. 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.
- "A String",
- ],
- "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
- "sources": [ # The sources of data for the person.
- { # The source of a field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- ],
- "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
- "A String",
- ],
- "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
- },
- "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.
- "ageRanges": [ # Output only. The person's age ranges.
- { # A person's age range.
- "ageRange": "A String", # The age range.
- "metadata": { # Metadata about a field. # Metadata about the age range.
+ "sipAddresses": [ # The person's SIP addresses.
+ { # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
+ "metadata": { # Metadata about a field. # Metadata about the SIP address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
+ "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
- "formattedType": "A String", # 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.
- "person": "A String", # The name of the other person this relation refers to.
- "type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
"metadata": { # Metadata about a field. # Metadata about the relation.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- },
- ],
- "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
- { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
- "metadata": { # Metadata about a field. # Metadata about the residence.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
- "value": "A String", # The address of the residence.
- },
- ],
- "phoneNumbers": [ # The person's phone numbers.
- { # A person's phone number.
- "value": "A String", # The phone number.
- "canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
- "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "type": "A String", # The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
- "metadata": { # Metadata about a field. # Metadata about the phone number.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
- { # **DEPRECATED**: No data will be returned A brief one-line description of the person.
- "value": "A String", # The tagline.
- "metadata": { # Metadata about a field. # Metadata about the tagline.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "genders": [ # The person's genders. This field is a singleton for contact sources.
- { # A person's gender.
- "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.
- "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`
- "metadata": { # Metadata about a field. # Metadata about the gender.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
- },
- ],
- "biographies": [ # The person's biographies. This field is a singleton for contact sources.
- { # A person's short biography.
- "value": "A String", # The short biography.
- "contentType": "A String", # The content type of the biography.
- "metadata": { # Metadata about a field. # Metadata about the biography.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
+ "formattedType": "A String", # 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.
+ "type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
+ "person": "A String", # The name of the other person this relation refers to.
},
],
"miscKeywords": [ # The person's miscellaneous keywords.
{ # A person's miscellaneous keyword.
- "type": "A String", # The miscellaneous keyword type.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "type": "A String", # The miscellaneous keyword type.
"formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"value": "A String", # The value of the miscellaneous keyword.
},
],
- "sipAddresses": [ # The person's SIP addresses.
- { # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
- "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
- "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
- "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the SIP address.
+ "biographies": [ # The person's biographies. This field is a singleton for contact sources.
+ { # A person's short biography.
+ "contentType": "A String", # The content type of the biography.
+ "metadata": { # Metadata about a field. # Metadata about the biography.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "value": "A String", # The short biography.
},
],
- "externalIds": [ # The person's external IDs.
- { # An identifier from an external entity related to the person.
- "metadata": { # Metadata about a field. # Metadata about the external ID.
+ "userDefined": [ # The person's user defined data.
+ { # Arbitrary user data that is populated by the end users.
+ "metadata": { # Metadata about a field. # Metadata about the user defined data.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "value": "A String", # The value of the external ID.
- "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
+ "key": "A String", # The end user specified key of the user defined data.
+ "value": "A String", # The end user specified value of the user defined data.
},
],
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"skills": [ # The person's skills.
{ # A skill that the person has.
+ "value": "A String", # The skill; for example, `underwater basket weaving`.
"metadata": { # Metadata about a field. # Metadata about the skill.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "value": "A String", # The skill; for example, `underwater basket weaving`.
},
],
- "birthdays": [ # The person's birthdays. This field is a singleton for contact sources.
- { # 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.
- "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "locations": [ # The person's locations.
+ { # A person's location.
+ "deskCode": "A String", # The individual desk location.
+ "buildingId": "A String", # The building identifier.
+ "value": "A String", # The free-form value of the location.
+ "current": True or False, # Whether the location is the current location.
+ "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
+ "metadata": { # Metadata about a field. # Metadata about the location.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
+ },
+ "floor": "A String", # The floor name or number.
+ "floorSection": "A String", # The floor section in `floor_name`.
+ },
+ ],
+ "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.
+ "occupations": [ # The person's occupations.
+ { # A person's occupation.
+ "value": "A String", # The occupation; for example, `carpenter`.
+ "metadata": { # Metadata about a field. # Metadata about the occupation.
"verified": True or False, # 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.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "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`. # The date of the birthday.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
+ },
+ ],
+ "fileAses": [ # The person's file-ases.
+ { # The name that should be used to sort the person in a list.
+ "metadata": { # Metadata about a field. # Metadata about the file-as.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "text": "A String", # A free-form string representing the user's birthday.
+ "value": "A String", # The file-as value
+ },
+ ],
+ "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
+ { # **DEPRECATED**: No data will be returned A person's relationship interest .
+ "formattedValue": "A String", # 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.
+ "metadata": { # Metadata about a field. # Metadata about the relationship interest.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # 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.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
"url": "A String", # The URL of the cover photo.
},
],
- "fileAses": [ # The person's file-ases.
- { # The name that should be used to sort the person in a list.
- "metadata": { # Metadata about a field. # Metadata about the file-as.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The file-as value
- },
- ],
- "clientData": [ # The person's client data.
- { # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
- "metadata": { # Metadata about a field. # Metadata about the client data.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "key": "A String", # The client specified key of the client data.
- "value": "A String", # The client specified value of the client data.
- },
- ],
- "events": [ # The person's events.
- { # An event related to the person.
- "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`. # The date of the event.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`
- "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the event.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "userDefined": [ # The person's user defined data.
- { # Arbitrary user data that is populated by the end users.
- "metadata": { # Metadata about a field. # Metadata about the user defined data.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "key": "A String", # The end user specified key of the user defined data.
- "value": "A String", # The end user specified value of the user defined data.
- },
- ],
- "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
- "organizations": [ # The person's past or current organizations.
- { # A person's past or current organization. Overlapping date ranges are permitted.
- "endDate": { # 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`. # The end date when the person left the organization.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "name": "A String", # The name of the organization.
- "metadata": { # Metadata about a field. # Metadata about the organization.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "location": "A String", # The location of the organization office the person works at.
- "title": "A String", # The person's job title at the organization.
- "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
- "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
- "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
- "phoneticName": "A String", # The phonetic name of the organization.
- "formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "department": "A String", # The person's department at the organization.
- "startDate": { # 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`. # The start date when the person joined the organization.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "jobDescription": "A String", # The person's job description at the organization.
- "type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
- },
- ],
- "occupations": [ # The person's occupations.
- { # A person's occupation.
- "metadata": { # Metadata about a field. # Metadata about the occupation.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The occupation; for example, `carpenter`.
- },
- ],
- "calendarUrls": [ # The person's calendar URLs.
- { # A person's calendar URL.
- "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
- "url": "A String", # The calendar URL.
- "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the calendar URL.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "locales": [ # The person's locale preferences.
- { # A person's locale preference.
- "metadata": { # Metadata about a field. # Metadata about the locale.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
- },
- ],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
},
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
- "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
+ "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
- "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
- { # **DEPRECATED**: No data will be returned A person's relationship status.
- "metadata": { # Metadata about a field. # Metadata about the relationship status.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
- "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- },
- ],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"metadata": { # Metadata about a field. # Metadata about the photo.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
+ },
+ "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
+ "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
+ },
+ ],
+ "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
+ { # **DEPRECATED**: No data will be returned A person's relationship status.
+ "value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
+ "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "metadata": { # Metadata about a field. # Metadata about the relationship status.
"verified": True or False, # 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.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
- "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
+ },
+ ],
+ "names": [ # The person's names. This field is a singleton for contact sources.
+ { # A person's name. If the name is a mononym, the family name is empty.
+ "familyName": "A String", # The family name.
+ "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
+ "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
+ "phoneticFamilyName": "A String", # The family name spelled as it sounds.
+ "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
+ "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
+ "phoneticFullName": "A String", # The full name spelled as it sounds.
+ "phoneticGivenName": "A String", # The given name spelled as it sounds.
+ "unstructuredName": "A String", # The free form name value.
+ "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
+ "givenName": "A String", # The given name.
+ "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
+ "metadata": { # Metadata about a field. # Metadata about the name.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "middleName": "A String", # The middle name(s).
+ "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
+ },
+ ],
+ "metadata": { # The metadata about a person. # Output only. Metadata about the person.
+ "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. 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.
+ "A String",
+ ],
+ "sources": [ # The sources of data for the person.
+ { # The source of a field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ ],
+ "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
+ "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
+ },
+ "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
+ "nicknames": [ # The person's nicknames.
+ { # A person's nickname.
+ "value": "A String", # The nickname.
+ "metadata": { # Metadata about a field. # Metadata about the nickname.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "type": "A String", # The type of the nickname.
+ },
+ ],
+ "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
+ { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
+ "metadata": { # Metadata about a field. # Metadata about the residence.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The address of the residence.
+ "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
+ },
+ ],
+ "emailAddresses": [ # The person's email addresses.
+ { # A person's email address.
+ "metadata": { # Metadata about a field. # Metadata about the email address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "displayName": "A String", # The display name of the email.
+ "value": "A String", # The email address.
+ "formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ },
+ ],
+ "locales": [ # The person's locale preferences.
+ { # A person's locale preference.
+ "metadata": { # Metadata about a field. # Metadata about the locale.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
+ },
+ ],
+ "phoneNumbers": [ # The person's phone numbers.
+ { # A person's phone number.
+ "metadata": { # Metadata about a field. # Metadata about the phone number.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
+ "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
+ "value": "A String", # The phone number.
+ },
+ ],
+ "birthdays": [ # The person's birthdays. This field is a singleton for contact sources.
+ { # 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.
+ "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "text": "A String", # 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`. # The date of the birthday.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ },
+ ],
+ "events": [ # The person's events.
+ { # An event related to the person.
+ "type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`
+ "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`. # The date of the event.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "metadata": { # Metadata about a field. # Metadata about the event.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ },
+ ],
+ "imClients": [ # The person's instant messaging clients.
+ { # A person's instant messaging client.
+ "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
+ "metadata": { # Metadata about a field. # Metadata about the IM client.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ "username": "A String", # The user name used in the IM client.
+ "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ },
+ ],
+ "organizations": [ # The person's past or current organizations.
+ { # A person's past or current organization. Overlapping date ranges are permitted.
+ "phoneticName": "A String", # The phonetic name of the organization.
+ "title": "A String", # The person's job title at the organization.
+ "type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
+ "endDate": { # 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`. # The end date when the person left the organization.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "jobDescription": "A String", # The person's job description at the organization.
+ "name": "A String", # The name of the organization.
+ "metadata": { # Metadata about a field. # Metadata about the organization.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
+ "startDate": { # 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`. # The start date when the person joined the organization.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "location": "A String", # The location of the organization office the person works at.
+ "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
+ "department": "A String", # The person's department at the organization.
+ "formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
+ },
+ ],
+ "externalIds": [ # The person's external IDs.
+ { # An identifier from an external entity related to the person.
+ "value": "A String", # The value of the external ID.
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
+ "metadata": { # Metadata about a field. # Metadata about the external ID.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ },
+ ],
+ "addresses": [ # The person's street addresses.
+ { # A person's physical address. May be a P.O. box or street address. All fields are optional.
+ "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
+ "streetAddress": "A String", # The street address.
+ "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
+ "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "city": "A String", # The city of the address.
+ "metadata": { # Metadata about a field. # Metadata about the address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "poBox": "A String", # The P.O. box of the address.
+ "region": "A String", # The region of the address; for example, the state or province.
+ "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
+ "postalCode": "A String", # The postal code of the address.
+ "country": "A String", # The country of the address.
+ "type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ },
+ ],
+ "taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
+ { # **DEPRECATED**: No data will be returned A brief one-line description of the person.
+ "metadata": { # Metadata about a field. # Metadata about the tagline.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The tagline.
+ },
+ ],
+ "genders": [ # The person's genders. This field is a singleton for contact sources.
+ { # A person's gender.
+ "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`
+ "metadata": { # Metadata about a field. # Metadata about the gender.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.
+ "value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
+ },
+ ],
+ "calendarUrls": [ # The person's calendar URLs.
+ { # A person's calendar URL.
+ "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
+ "metadata": { # Metadata about a field. # Metadata about the calendar URL.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "url": "A String", # The calendar URL.
+ },
+ ],
+ "interests": [ # The person's interests.
+ { # One of the person's interests.
+ "value": "A String", # The interest; for example, `stargazing`.
+ "metadata": { # Metadata about a field. # Metadata about the interest.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
},
],
}</pre>
@@ -7985,844 +7985,844 @@
{ # The response for updating a contact's photo.
"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. # The updated person, if person_fields is set in the UpdateContactPhotoRequest; otherwise this will be unset.
- "emailAddresses": [ # The person's email addresses.
- { # A person's email address.
- "value": "A String", # The email address.
- "formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the email address.
+ "clientData": [ # The person's client data.
+ { # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
+ "key": "A String", # The client specified key of the client data.
+ "metadata": { # Metadata about a field. # Metadata about the client data.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "displayName": "A String", # The display name of the email.
- "type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ "value": "A String", # The client specified value of the client data.
},
],
- "addresses": [ # The person's street addresses.
- { # A person's physical address. May be a P.O. box or street address. All fields are optional.
- "streetAddress": "A String", # The street address.
- "poBox": "A String", # The P.O. box of the address.
- "region": "A String", # The region of the address; for example, the state or province.
- "type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
- "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
- "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "postalCode": "A String", # The postal code of the address.
- "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
- "city": "A String", # The city of the address.
- "country": "A String", # The country of the address.
- "metadata": { # Metadata about a field. # Metadata about the address.
+ "ageRanges": [ # Output only. The person's age ranges.
+ { # A person's age range.
+ "ageRange": "A String", # The age range.
+ "metadata": { # Metadata about a field. # Metadata about the age range.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
- "interests": [ # The person's interests.
- { # One of the person's interests.
- "value": "A String", # The interest; for example, `stargazing`.
- "metadata": { # Metadata about a field. # Metadata about the interest.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "locations": [ # The person's locations.
- { # A person's location.
- "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
- "floor": "A String", # The floor name or number.
- "deskCode": "A String", # The individual desk location.
- "floorSection": "A String", # The floor section in `floor_name`.
- "value": "A String", # The free-form value of the location.
- "metadata": { # Metadata about a field. # Metadata about the location.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "buildingId": "A String", # The building identifier.
- "current": True or False, # Whether the location is the current location.
- },
- ],
- "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
- { # **DEPRECATED**: No data will be returned A person's relationship interest .
- "formattedValue": "A String", # 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.
- "value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
- "metadata": { # Metadata about a field. # Metadata about the relationship interest.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "names": [ # The person's names. This field is a singleton for contact sources.
- { # A person's name. If the name is a mononym, the family name is empty.
- "metadata": { # Metadata about a field. # Metadata about the name.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "phoneticFamilyName": "A String", # The family name spelled as it sounds.
- "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
- "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
- "familyName": "A String", # The family name.
- "phoneticGivenName": "A String", # The given name spelled as it sounds.
- "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
- "middleName": "A String", # The middle name(s).
- "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
- "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
- "unstructuredName": "A String", # The free form name value.
- "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
- "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
- "phoneticFullName": "A String", # The full name spelled as it sounds.
- "givenName": "A String", # The given name.
- },
- ],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
- "value": "A String", # The URL.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the URL. The type can be custom or one of these predefined values: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Currents application. * `other`
+ "value": "A String", # The URL.
"metadata": { # Metadata about a field. # Metadata about the URL.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "nicknames": [ # The person's nicknames.
- { # A person's nickname.
- "type": "A String", # The type of the nickname.
- "metadata": { # Metadata about a field. # Metadata about the nickname.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The nickname.
- },
- ],
- "imClients": [ # The person's instant messaging clients.
- { # A person's instant messaging client.
- "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "username": "A String", # The user name used in the IM client.
- "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
- "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "metadata": { # Metadata about a field. # Metadata about the IM client.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.
{ # **DEPRECATED**: No data will be returned A person's bragging rights.
"metadata": { # Metadata about a field. # Metadata about the bragging rights.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
"value": "A String", # The bragging rights; for example, `climbed mount everest`.
},
],
- "metadata": { # The metadata about a person. # Output only. Metadata about the person.
- "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. 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.
- "A String",
- ],
- "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
- "sources": [ # The sources of data for the person.
- { # The source of a field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- ],
- "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
- "A String",
- ],
- "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
- },
- "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.
- "ageRanges": [ # Output only. The person's age ranges.
- { # A person's age range.
- "ageRange": "A String", # The age range.
- "metadata": { # Metadata about a field. # Metadata about the age range.
+ "sipAddresses": [ # The person's SIP addresses.
+ { # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
+ "metadata": { # Metadata about a field. # Metadata about the SIP address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
+ "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
- "formattedType": "A String", # 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.
- "person": "A String", # The name of the other person this relation refers to.
- "type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
"metadata": { # Metadata about a field. # Metadata about the relation.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- },
- ],
- "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
- { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
- "metadata": { # Metadata about a field. # Metadata about the residence.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
- "value": "A String", # The address of the residence.
- },
- ],
- "phoneNumbers": [ # The person's phone numbers.
- { # A person's phone number.
- "value": "A String", # The phone number.
- "canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
- "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "type": "A String", # The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
- "metadata": { # Metadata about a field. # Metadata about the phone number.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
- { # **DEPRECATED**: No data will be returned A brief one-line description of the person.
- "value": "A String", # The tagline.
- "metadata": { # Metadata about a field. # Metadata about the tagline.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "genders": [ # The person's genders. This field is a singleton for contact sources.
- { # A person's gender.
- "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.
- "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`
- "metadata": { # Metadata about a field. # Metadata about the gender.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
- },
- ],
- "biographies": [ # The person's biographies. This field is a singleton for contact sources.
- { # A person's short biography.
- "value": "A String", # The short biography.
- "contentType": "A String", # The content type of the biography.
- "metadata": { # Metadata about a field. # Metadata about the biography.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
+ "formattedType": "A String", # 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.
+ "type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
+ "person": "A String", # The name of the other person this relation refers to.
},
],
"miscKeywords": [ # The person's miscellaneous keywords.
{ # A person's miscellaneous keyword.
- "type": "A String", # The miscellaneous keyword type.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "type": "A String", # The miscellaneous keyword type.
"formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"value": "A String", # The value of the miscellaneous keyword.
},
],
- "sipAddresses": [ # The person's SIP addresses.
- { # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
- "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
- "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
- "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the SIP address.
+ "biographies": [ # The person's biographies. This field is a singleton for contact sources.
+ { # A person's short biography.
+ "contentType": "A String", # The content type of the biography.
+ "metadata": { # Metadata about a field. # Metadata about the biography.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
+ "value": "A String", # The short biography.
},
],
- "externalIds": [ # The person's external IDs.
- { # An identifier from an external entity related to the person.
- "metadata": { # Metadata about a field. # Metadata about the external ID.
+ "userDefined": [ # The person's user defined data.
+ { # Arbitrary user data that is populated by the end users.
+ "metadata": { # Metadata about a field. # Metadata about the user defined data.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "value": "A String", # The value of the external ID.
- "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
+ "key": "A String", # The end user specified key of the user defined data.
+ "value": "A String", # The end user specified value of the user defined data.
},
],
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"skills": [ # The person's skills.
{ # A skill that the person has.
+ "value": "A String", # The skill; for example, `underwater basket weaving`.
"metadata": { # Metadata about a field. # Metadata about the skill.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "value": "A String", # The skill; for example, `underwater basket weaving`.
},
],
- "birthdays": [ # The person's birthdays. This field is a singleton for contact sources.
- { # 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.
- "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "locations": [ # The person's locations.
+ { # A person's location.
+ "deskCode": "A String", # The individual desk location.
+ "buildingId": "A String", # The building identifier.
+ "value": "A String", # The free-form value of the location.
+ "current": True or False, # Whether the location is the current location.
+ "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
+ "metadata": { # Metadata about a field. # Metadata about the location.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
+ },
+ "floor": "A String", # The floor name or number.
+ "floorSection": "A String", # The floor section in `floor_name`.
+ },
+ ],
+ "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.
+ "occupations": [ # The person's occupations.
+ { # A person's occupation.
+ "value": "A String", # The occupation; for example, `carpenter`.
+ "metadata": { # Metadata about a field. # Metadata about the occupation.
"verified": True or False, # 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.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "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`. # The date of the birthday.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
+ },
+ ],
+ "fileAses": [ # The person's file-ases.
+ { # The name that should be used to sort the person in a list.
+ "metadata": { # Metadata about a field. # Metadata about the file-as.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "text": "A String", # A free-form string representing the user's birthday.
+ "value": "A String", # The file-as value
+ },
+ ],
+ "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
+ { # **DEPRECATED**: No data will be returned A person's relationship interest .
+ "formattedValue": "A String", # 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.
+ "metadata": { # Metadata about a field. # Metadata about the relationship interest.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # 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.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
"url": "A String", # The URL of the cover photo.
},
],
- "fileAses": [ # The person's file-ases.
- { # The name that should be used to sort the person in a list.
- "metadata": { # Metadata about a field. # Metadata about the file-as.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The file-as value
- },
- ],
- "clientData": [ # The person's client data.
- { # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
- "metadata": { # Metadata about a field. # Metadata about the client data.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "key": "A String", # The client specified key of the client data.
- "value": "A String", # The client specified value of the client data.
- },
- ],
- "events": [ # The person's events.
- { # An event related to the person.
- "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`. # The date of the event.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`
- "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the event.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "userDefined": [ # The person's user defined data.
- { # Arbitrary user data that is populated by the end users.
- "metadata": { # Metadata about a field. # Metadata about the user defined data.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "key": "A String", # The end user specified key of the user defined data.
- "value": "A String", # The end user specified value of the user defined data.
- },
- ],
- "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
- "organizations": [ # The person's past or current organizations.
- { # A person's past or current organization. Overlapping date ranges are permitted.
- "endDate": { # 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`. # The end date when the person left the organization.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "name": "A String", # The name of the organization.
- "metadata": { # Metadata about a field. # Metadata about the organization.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "location": "A String", # The location of the organization office the person works at.
- "title": "A String", # The person's job title at the organization.
- "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
- "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
- "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
- "phoneticName": "A String", # The phonetic name of the organization.
- "formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "department": "A String", # The person's department at the organization.
- "startDate": { # 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`. # The start date when the person joined the organization.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "day": 42, # 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.
- },
- "jobDescription": "A String", # The person's job description at the organization.
- "type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
- },
- ],
- "occupations": [ # The person's occupations.
- { # A person's occupation.
- "metadata": { # Metadata about a field. # Metadata about the occupation.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The occupation; for example, `carpenter`.
- },
- ],
- "calendarUrls": [ # The person's calendar URLs.
- { # A person's calendar URL.
- "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
- "url": "A String", # The calendar URL.
- "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the calendar URL.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "locales": [ # The person's locale preferences.
- { # A person's locale preference.
- "metadata": { # Metadata about a field. # Metadata about the locale.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
- },
- ],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
},
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
- "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
+ "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
},
],
- "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
- { # **DEPRECATED**: No data will be returned A person's relationship status.
- "metadata": { # Metadata about a field. # Metadata about the relationship status.
- "source": { # The source of a field. # The source of the field.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- },
- "verified": True or False, # 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.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
- "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- },
- ],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"metadata": { # Metadata about a field. # Metadata about the photo.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"type": "A String", # The source type.
- "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # Output only. The profile object type.
},
},
+ },
+ "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
+ "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
+ },
+ ],
+ "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
+ { # **DEPRECATED**: No data will be returned A person's relationship status.
+ "value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
+ "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "metadata": { # Metadata about a field. # Metadata about the relationship status.
"verified": True or False, # 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.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
},
- "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
- "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
+ },
+ ],
+ "names": [ # The person's names. This field is a singleton for contact sources.
+ { # A person's name. If the name is a mononym, the family name is empty.
+ "familyName": "A String", # The family name.
+ "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
+ "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
+ "phoneticFamilyName": "A String", # The family name spelled as it sounds.
+ "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
+ "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
+ "phoneticFullName": "A String", # The full name spelled as it sounds.
+ "phoneticGivenName": "A String", # The given name spelled as it sounds.
+ "unstructuredName": "A String", # The free form name value.
+ "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
+ "givenName": "A String", # The given name.
+ "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
+ "metadata": { # Metadata about a field. # Metadata about the name.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "middleName": "A String", # The middle name(s).
+ "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
+ },
+ ],
+ "metadata": { # The metadata about a person. # Output only. Metadata about the person.
+ "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. 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.
+ "A String",
+ ],
+ "sources": [ # The sources of data for the person.
+ { # The source of a field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ ],
+ "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
+ "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
+ },
+ "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
+ "nicknames": [ # The person's nicknames.
+ { # A person's nickname.
+ "value": "A String", # The nickname.
+ "metadata": { # Metadata about a field. # Metadata about the nickname.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "type": "A String", # The type of the nickname.
+ },
+ ],
+ "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
+ { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
+ "metadata": { # Metadata about a field. # Metadata about the residence.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The address of the residence.
+ "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
+ },
+ ],
+ "emailAddresses": [ # The person's email addresses.
+ { # A person's email address.
+ "metadata": { # Metadata about a field. # Metadata about the email address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "displayName": "A String", # The display name of the email.
+ "value": "A String", # The email address.
+ "formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ },
+ ],
+ "locales": [ # The person's locale preferences.
+ { # A person's locale preference.
+ "metadata": { # Metadata about a field. # Metadata about the locale.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
+ },
+ ],
+ "phoneNumbers": [ # The person's phone numbers.
+ { # A person's phone number.
+ "metadata": { # Metadata about a field. # Metadata about the phone number.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
+ "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
+ "value": "A String", # The phone number.
+ },
+ ],
+ "birthdays": [ # The person's birthdays. This field is a singleton for contact sources.
+ { # 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.
+ "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "text": "A String", # 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`. # The date of the birthday.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ },
+ ],
+ "events": [ # The person's events.
+ { # An event related to the person.
+ "type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`
+ "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`. # The date of the event.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "metadata": { # Metadata about a field. # Metadata about the event.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ },
+ ],
+ "imClients": [ # The person's instant messaging clients.
+ { # A person's instant messaging client.
+ "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
+ "metadata": { # Metadata about a field. # Metadata about the IM client.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ "username": "A String", # The user name used in the IM client.
+ "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ },
+ ],
+ "organizations": [ # The person's past or current organizations.
+ { # A person's past or current organization. Overlapping date ranges are permitted.
+ "phoneticName": "A String", # The phonetic name of the organization.
+ "title": "A String", # The person's job title at the organization.
+ "type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
+ "endDate": { # 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`. # The end date when the person left the organization.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "jobDescription": "A String", # The person's job description at the organization.
+ "name": "A String", # The name of the organization.
+ "metadata": { # Metadata about a field. # Metadata about the organization.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
+ "startDate": { # 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`. # The start date when the person joined the organization.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ "day": 42, # 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.
+ },
+ "location": "A String", # The location of the organization office the person works at.
+ "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
+ "department": "A String", # The person's department at the organization.
+ "formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
+ },
+ ],
+ "externalIds": [ # The person's external IDs.
+ { # An identifier from an external entity related to the person.
+ "value": "A String", # The value of the external ID.
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
+ "metadata": { # Metadata about a field. # Metadata about the external ID.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ },
+ ],
+ "addresses": [ # The person's street addresses.
+ { # A person's physical address. May be a P.O. box or street address. All fields are optional.
+ "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
+ "streetAddress": "A String", # The street address.
+ "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
+ "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "city": "A String", # The city of the address.
+ "metadata": { # Metadata about a field. # Metadata about the address.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "poBox": "A String", # The P.O. box of the address.
+ "region": "A String", # The region of the address; for example, the state or province.
+ "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
+ "postalCode": "A String", # The postal code of the address.
+ "country": "A String", # The country of the address.
+ "type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ },
+ ],
+ "taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
+ { # **DEPRECATED**: No data will be returned A brief one-line description of the person.
+ "metadata": { # Metadata about a field. # Metadata about the tagline.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "value": "A String", # The tagline.
+ },
+ ],
+ "genders": [ # The person's genders. This field is a singleton for contact sources.
+ { # A person's gender.
+ "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`
+ "metadata": { # Metadata about a field. # Metadata about the gender.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.
+ "value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
+ },
+ ],
+ "calendarUrls": [ # The person's calendar URLs.
+ { # A person's calendar URL.
+ "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
+ "metadata": { # Metadata about a field. # Metadata about the calendar URL.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
+ "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "url": "A String", # The calendar URL.
+ },
+ ],
+ "interests": [ # The person's interests.
+ { # One of the person's interests.
+ "value": "A String", # The interest; for example, `stargazing`.
+ "metadata": { # Metadata about a field. # Metadata about the interest.
+ "verified": True or False, # 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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "objectType": "A String", # Output only. The profile object type.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ },
+ },
+ },
},
],
},