docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/people_v1.people.connections.html b/docs/dyn/people_v1.people.connections.html
index 0c81eca..e1e6896 100644
--- a/docs/dyn/people_v1.people.connections.html
+++ b/docs/dyn/people_v1.people.connections.html
@@ -75,14 +75,14 @@
<h1><a href="people_v1.html">People API</a> . <a href="people_v1.people.html">people</a> . <a href="people_v1.people.connections.html">connections</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#list">list(resourceName, sortOrder=None, syncToken=None, pageToken=None, personFields=None, pageSize=None, requestMask_includeField=None, requestSyncToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(resourceName, pageToken=None, sortOrder=None, personFields=None, syncToken=None, pageSize=None, requestMask_includeField=None, requestSyncToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Provides a list of the authenticated user's contacts merged with any</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="list">list(resourceName, sortOrder=None, syncToken=None, pageToken=None, personFields=None, pageSize=None, requestMask_includeField=None, requestSyncToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(resourceName, pageToken=None, sortOrder=None, personFields=None, syncToken=None, pageSize=None, requestMask_includeField=None, requestSyncToken=None, x__xgafv=None)</code>
<pre>Provides a list of the authenticated user's contacts merged with any
connected profiles.
@@ -90,19 +90,13 @@
Args:
resourceName: string, Required. The resource name to return connections for. Only `people/me` is valid. (required)
- sortOrder: string, Optional. The order in which the connections should be sorted. Defaults to
-`LAST_MODIFIED_ASCENDING`.
- syncToken: string, Optional. A sync token, received from a previous `ListConnections` call.
-Provide this to retrieve only the resources changed since the last request.
-Sync requests that specify `sync_token` have an additional rate limit.
-
-When syncing, all other parameters provided to `ListConnections`
-must match the call that provided the sync token.
pageToken: string, Optional. A page token, received from a previous `ListConnections` call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to `ListConnections`
must match the call that provided the page token.
+ sortOrder: string, Optional. The order in which the connections should be sorted. Defaults to
+`LAST_MODIFIED_ASCENDING`.
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:
@@ -131,6 +125,12 @@
* skills
* urls
* userDefined
+ syncToken: string, Optional. A sync token, received from a previous `ListConnections` call.
+Provide this to retrieve only the resources changed since the last request.
+Sync requests that specify `sync_token` have an additional rate limit.
+
+When syncing, all other parameters provided to `ListConnections`
+must match the call that provided the sync token.
pageSize: integer, Optional. The number of connections to include in the response. Valid values are
between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.
requestMask_includeField: string, Required. Comma-separated list of person fields to be included in the response. Each
@@ -149,529 +149,42 @@
An object of the form:
{ # The response to a request for the authenticated user's connections.
- "totalItems": 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.
"totalPeople": 42, # **DEPRECATED** (Please use totalItems)
# The total number of people 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.
"connections": [ # The list of people that the requestor is connected to.
{ # 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.
- "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.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be 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.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be 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.
- },
- ],
- "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.
- "value": "A String", # The SIP address in the
- # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI
- # format.
- "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`
- "metadata": { # Metadata about a field. # Metadata about the SIP address.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be 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.
- },
- ],
- "phoneNumbers": [ # The person's phone numbers.
- { # A person's phone number.
- "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.
- "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.
- "metadata": { # Metadata about a field. # Metadata about the phone number.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "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.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead)
- #
- # The person's age range.
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # resource. Used for web cache validation.
- "biographies": [ # The person's biographies.
- { # A person's short biography.
- "metadata": { # Metadata about a field. # Metadata about the biography.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- "contentType": "A String", # The content type of the biography.
- "value": "A String", # The short biography.
- },
- ],
- "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.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be 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.
- },
- ],
- "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.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be 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 tagline.
- },
- ],
- "organizations": [ # The person's past or current organizations.
- { # A person's past or current organization. Overlapping date ranges are
- # permitted.
- "title": "A String", # The person's job title at the organization.
- "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
- # symbol, abbreviation, or acronym.
- "name": "A String", # The name of the organization.
- "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The start date when the person joined the organization.
- # and time zone are either specified elsewhere or are not significant. The date
- # is relative to the Proleptic Gregorian Calendar. This can represent:
- #
- # * A full date, with non-zero year, month and day values
- # * A month and day value, with a zero year, e.g. an anniversary
- # * A year on its own, with zero month and day values
- # * A year and month value, with a zero day, e.g. a credit card expiration date
- #
- # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
- "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
- # month and day.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- # if specifying a year by itself or a year and month where the day is not
- # significant.
- },
- "department": "A String", # The person's department 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.
- "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`.
- "metadata": { # Metadata about a field. # Metadata about the organization.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- "jobDescription": "A String", # The person's job description at the organization.
- "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The end date when the person left the organization.
- # and time zone are either specified elsewhere or are not significant. The date
- # is relative to the Proleptic Gregorian Calendar. This can represent:
- #
- # * A full date, with non-zero year, month and day values
- # * A month and day value, with a zero year, e.g. an anniversary
- # * A year on its own, with zero month and day values
- # * A year and month value, with a zero day, e.g. a credit card expiration date
- #
- # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
- "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
- # month and day.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- # if specifying a year by itself or a year and month where the day is not
- # significant.
- },
- "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.
- "type": "A String", # The type of the organization. The type can be custom or one of these
- # predefined values:
- #
- # * `work`
- # * `school`
- },
- ],
- "residences": [ # The person's residences.
- { # 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.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be 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.
- },
- ],
- "genders": [ # The person's genders.
- { # 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.
- "metadata": { # Metadata about a field. # Metadata about the gender.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- "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`
- "value": "A String", # The gender for the person. The gender can be custom or one of these
- # predefined values:
- #
- # * `male`
- # * `female`
- # * `unspecified`
- },
- ],
- "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.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be 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 kind of relationship the person is looking for. The value can be custom
- # or one of these predefined values:
- #
- # * `friend`
- # * `date`
- # * `relationship`
- # * `networking`
- },
- ],
- "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.
+ # 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.
+ "addresses": [ # The person's street addresses.
+ { # A person's physical address. May be a P.O. box or street address. All fields
+ # are optional.
+ "region": "A String", # The region of the address; for example, the state or province.
+ "country": "A String", # The country of the address.
+ "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
+ "poBox": "A String", # The P.O. box 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.
+ "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country
+ # code of the address.
+ "type": "A String", # The type of the address. The type can be custom or one of these predefined
+ # values:
#
- # 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.
+ # * `home`
+ # * `work`
+ # * `other`
+ "postalCode": "A String", # The postal code 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
@@ -681,709 +194,1196 @@
"objectType": "A String", # Output only. The profile object type.
},
"type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
#
# The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
# source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
},
- ],
- "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.
- "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.
+ },
+ "streetAddress": "A String", # The street address.
+ "city": "A String", # The city of the address.
+ "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.
},
- "memberships": [ # The person's group memberships.
- { # A person's membership in a group. Only contact group memberships can be
- # modified.
- "metadata": { # Metadata about a field. # Metadata about the membership.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
+ ],
+ "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead)
+ #
+ # The person's age range.
+ "relations": [ # The person's relations.
+ { # A person's relation to another person.
+ "person": "A String", # The name of the other person this relation refers to.
+ "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`
+ "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.
+ "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.
- },
- "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.
- },
- "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.
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
},
},
+ },
+ ],
+ "organizations": [ # The person's past or current organizations.
+ { # A person's past or current organization. Overlapping date ranges are
+ # permitted.
+ "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.
+ "current": True or False, # True if the organization is the person's current organization;
+ # false if the organization is a past organization.
+ "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.
+ "title": "A String", # The person's job title at 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.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ "type": "A String", # The type of the organization. The type can be custom or one of these
+ # predefined values:
+ #
+ # * `work`
+ # * `school`
+ "name": "A String", # The name of the organization.
+ "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The end date when the person left the organization.
+ # and time zone are either specified elsewhere or are not significant. The date
+ # is relative to the Proleptic Gregorian Calendar. This can represent:
+ #
+ # * A full date, with non-zero year, month and day values
+ # * A month and day value, with a zero year, e.g. an anniversary
+ # * A year on its own, with zero month and day values
+ # * A year and month value, with a zero day, e.g. a credit card expiration date
+ #
+ # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year by itself or a year and month where the day is not
+ # significant.
+ "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+ # month and day.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
+ "location": "A String", # The location of the organization office the person works at.
+ "department": "A String", # The person's department at the organization.
+ "domain": "A String", # The domain name associated with the organization; for example,
+ # `google.com`.
+ "jobDescription": "A String", # The person's job description at the organization.
+ "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The start date when the person joined the organization.
+ # and time zone are either specified elsewhere or are not significant. The date
+ # is relative to the Proleptic Gregorian Calendar. This can represent:
+ #
+ # * A full date, with non-zero year, month and day values
+ # * A month and day value, with a zero year, e.g. an anniversary
+ # * A year on its own, with zero month and day values
+ # * A year and month value, with a zero day, e.g. a credit card expiration date
+ #
+ # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year by itself or a year and month where the day is not
+ # significant.
+ "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+ # month and day.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
+ },
+ ],
+ "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.
+ "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.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ "url": "A String", # The URL of the cover photo.
+ "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.
+ },
+ ],
+ "residences": [ # The person's residences.
+ { # A person's past or current residence.
+ "value": "A String", # The address of the 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.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ "current": True or False, # True if the residence is the person's current residence;
+ # false if the residence is a past residence.
+ },
+ ],
+ "imClients": [ # The person's instant messaging clients.
+ { # A person's instant messaging client.
+ "username": "A String", # The user name used in the IM client.
+ "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.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ "type": "A String", # The type of the IM client. The type can be custom or one of these
+ # predefined values:
+ #
+ # * `home`
+ # * `work`
+ # * `other`
+ "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`
+ "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.
+ },
+ ],
+ "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.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ "value": "A String", # The end user specified value of the user defined data.
+ "key": "A String", # The end user specified key 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.
+ "braggingRights": [ # **DEPRECATED**: No data will be returned
+ # The person's bragging rights.
+ { # **DEPRECATED**: No data will be returned
+ # A person's bragging rights.
+ "value": "A String", # The bragging rights; for example, `climbed mount everest`.
+ "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.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ },
+ ],
+ "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 .
+ "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.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ "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`
+ },
+ ],
+ "ageRanges": [ # Output only. The person's age ranges.
+ { # A person's 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.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ "ageRange": "A String", # The age range.
+ },
+ ],
+ "memberships": [ # The person's group memberships.
+ { # A person's membership in a group. Only contact group memberships can be
+ # modified.
+ "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.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ "contactGroupMembership": { # A Google contact group membership. # 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.
+ },
+ "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.
+ },
+ },
+ ],
+ "occupations": [ # The person's occupations.
+ { # A person's occupation.
+ "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.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ "value": "A String", # The occupation; for example, `carpenter`.
+ },
+ ],
+ "urls": [ # The person's associated URLs.
+ { # A person's associated URLs.
+ "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.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ "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 Google+ application.
+ # * `other`
+ "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.
+ "value": "A String", # The URL.
+ },
+ ],
+ "skills": [ # The person's skills.
+ { # A skill that the person has.
+ "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.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ "value": "A String", # The skill; for example, `underwater basket weaving`.
+ },
+ ],
+ "emailAddresses": [ # The person's email addresses.
+ { # A person's email address.
+ "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 email address.
+ "displayName": "A String", # The display name of the email.
+ "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.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ "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.
+ },
+ ],
+ "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.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ "value": "A String", # The tagline.
+ },
+ ],
+ "names": [ # The person's names.
+ { # A person's name. If the name is a mononym, the family name is empty.
+ "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
+ "givenName": "A String", # The given name.
+ "familyName": "A String", # The family name.
+ "middleName": "A String", # The middle name(s).
+ "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
+ "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
+ "phoneticGivenName": "A String", # The given name spelled as it sounds.
+ "phoneticFamilyName": "A String", # The family name spelled as it sounds.
+ "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
+ "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.
+ "phoneticFullName": "A String", # The full name spelled as it sounds.
+ "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.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
+ },
+ ],
+ "biographies": [ # The person's biographies.
+ { # A person's short 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.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ "contentType": "A String", # The content type of the biography.
+ "value": "A String", # The short biography.
+ },
+ ],
+ "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}`.
+ "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.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ "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
+ },
+ ],
+ "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`
+ "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.
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ "source": { # The source of a field. # The source of the field.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the event.
+ # and time zone are either specified elsewhere or are not significant. The date
+ # is relative to the Proleptic Gregorian Calendar. This can represent:
+ #
+ # * A full date, with non-zero year, month and day values
+ # * A month and day value, with a zero year, e.g. an anniversary
+ # * A year on its own, with zero month and day values
+ # * A year and month value, with a zero day, e.g. a credit card expiration date
+ #
+ # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year by itself or a year and month where the day is not
+ # significant.
+ "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+ # month and day.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
+ },
+ ],
+ "locales": [ # The person's locale preferences.
+ { # A person's locale preference.
+ "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)
+ # language tag representing the locale.
+ "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.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ },
+ ],
+ "phoneNumbers": [ # The person's phone numbers.
+ { # A person's 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`
+ "value": "A String", # The 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.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ },
+ ],
+ "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.
+ "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.
+ "value": "A String", # The SIP address in the
+ # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI
+ # format.
+ "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`
+ "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.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ },
+ ],
+ "interests": [ # The person's interests.
+ { # One of the person's interests.
+ "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.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ "value": "A String", # The interest; for example, `stargazing`.
+ },
+ ],
+ "birthdays": [ # The person's birthdays.
+ { # 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.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ "text": "A String", # A free-form string representing the user's birthday.
+ "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the birthday.
+ # and time zone are either specified elsewhere or are not significant. The date
+ # is relative to the Proleptic Gregorian Calendar. This can represent:
+ #
+ # * A full date, with non-zero year, month and day values
+ # * A month and day value, with a zero year, e.g. an anniversary
+ # * A year on its own, with zero month and day values
+ # * A year and month value, with a zero day, e.g. a credit card expiration date
+ #
+ # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year by itself or a year and month where the day is not
+ # significant.
+ "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+ # month and day.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
+ },
+ ],
+ "genders": [ # The person's genders.
+ { # 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.
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ "source": { # The source of a field. # The source of the field.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ "value": "A String", # The gender for the person. The gender can be custom or one of these
+ # predefined values:
+ #
+ # * `male`
+ # * `female`
+ # * `unspecified`
+ },
+ ],
+ "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.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ "type": "A String", # The type of the nickname.
+ },
+ ],
+ "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.
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ "source": { # The source of a field. # The source of the field.
+ "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.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ },
+ },
+ "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.
+ "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`
+ },
+ ],
+ "metadata": { # The metadata about a person. # Output only. Metadata about the person.
+ "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
+ "A String",
],
- "birthdays": [ # The person's birthdays.
- { # 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.
- "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the birthday.
- # and time zone are either specified elsewhere or are not significant. The date
- # is relative to the Proleptic Gregorian Calendar. This can represent:
+ "objectType": "A String", # Output only. **DEPRECATED** (Please use
+ # `person.metadata.sources.profileMetadata.objectType` instead)
+ #
+ # The type of the person object.
+ "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.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
- # * A full date, with non-zero year, month and day values
- # * A month and day value, with a zero year, e.g. an anniversary
- # * A year on its own, with zero month and day values
- # * A year and month value, with a zero day, e.g. a credit card expiration date
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "type": "A String", # The source type.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
- # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
- "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
- # month and day.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- # if specifying a year by itself or a year and month where the day is not
- # significant.
- },
- "metadata": { # Metadata about a field. # Metadata about the birthday.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- "text": "A String", # A free-form string representing the user's birthday.
- },
- ],
- "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.
- "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
- # predefined values:
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
#
- # * `aim`
- # * `msn`
- # * `yahoo`
- # * `skype`
- # * `qq`
- # * `googleTalk`
- # * `icq`
- # * `jabber`
- # * `netMeeting`
- "username": "A String", # The user name used in the IM client.
- "type": "A String", # The type of the IM client. The type can be custom or one of these
- # predefined values:
- #
- # * `home`
- # * `work`
- # * `other`
- "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.
- "metadata": { # Metadata about a field. # Metadata about the IM client.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "skills": [ # The person's skills.
- { # A skill that the person has.
- "metadata": { # Metadata about a field. # Metadata about the skill.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be 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`.
- },
- ],
- "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.
- "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.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be 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`
- },
- ],
- "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.
- "url": "A String", # The URL of the cover photo.
- "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.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be 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.
- { # A person's name. If the name is a mononym, the family name is empty.
- "middleName": "A String", # The middle name(s).
- "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
- "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.
- "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
- "familyName": "A String", # The family name.
- "phoneticGivenName": "A String", # The given name spelled as it sounds.
- "metadata": { # Metadata about a field. # Metadata about the name.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- "phoneticHonorificPrefix": "A String", # The honorific prefixes 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.
- "phoneticFamilyName": "A String", # The family name spelled as it sounds.
- "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
- "givenName": "A String", # The given name.
- "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
- "phoneticFullName": "A String", # The full name spelled as it sounds.
- },
- ],
- "relations": [ # The person's relations.
- { # A person's relation to another person.
- "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.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- "person": "A String", # The name of the other person this relation refers to.
- "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.
- },
- ],
- "ageRanges": [ # Output only. The person's age ranges.
- { # A person's age range.
- "metadata": { # Metadata about a field. # Metadata about the age range.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- "ageRange": "A String", # The age range.
- },
- ],
- "braggingRights": [ # **DEPRECATED**: No data will be returned
- # The person's bragging rights.
- { # **DEPRECATED**: No data will be returned
- # A person's bragging rights.
- "value": "A String", # The bragging rights; for example, `climbed mount everest`.
- "metadata": { # Metadata about a field. # Metadata about the bragging rights.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "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}`.
- "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.
- "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.
- "metadata": { # Metadata about a field. # Metadata about the photo.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "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.
- "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.
- "country": "A String", # The country 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.
- "postalCode": "A String", # The postal code of the address.
- "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
- "type": "A String", # The type of the address. The type can be custom or one of these predefined
- # values:
- #
- # * `home`
- # * `work`
- # * `other`
- "region": "A String", # The region of the address; for example, the state or province.
- "poBox": "A String", # The P.O. box of the address.
- "metadata": { # Metadata about a field. # Metadata about the address.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country
- # code of the address.
- },
- ],
- "emailAddresses": [ # The person's email addresses.
- { # A person's 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.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be 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 email address.
- "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`
- },
- ],
- "nicknames": [ # The person's nicknames.
- { # A person's nickname.
- "metadata": { # Metadata about a field. # Metadata about the nickname.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be 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 type of the nickname.
- "value": "A String", # The nickname.
- },
- ],
- "events": [ # The person's events.
- { # An event related to the person.
- "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the event.
- # and time zone are either specified elsewhere or are not significant. The date
- # is relative to the Proleptic Gregorian Calendar. This can represent:
- #
- # * A full date, with non-zero year, month and day values
- # * A month and day value, with a zero year, e.g. an anniversary
- # * A year on its own, with zero month and day values
- # * A year and month value, with a zero day, e.g. a credit card expiration date
- #
- # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
- "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
- # month and day.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- # if specifying a year by itself or a year and month where the day is not
- # significant.
- },
- "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.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be 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 type of the event. The type can be custom or one of these predefined
- # values:
- #
- # * `anniversary`
- # * `other`
- },
- ],
- "urls": [ # The person's associated URLs.
- { # A person's associated URLs.
- "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 Google+ application.
- # * `other`
- "metadata": { # Metadata about a field. # Metadata about the URL.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp 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.
- },
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be 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 URL translated and formatted in the viewer's
- # account locale or the `Accept-Language` HTTP header locale.
- "value": "A String", # The URL.
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
},
],
},
+ },
],
"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.
+ "totalItems": 42, # The total number of items in the list without pagination.
}</pre>
</div>