| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="people_v1.html">People API</a> . <a href="people_v1.people.html">people</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="people_v1.people.connections.html">connections()</a></code> |
| </p> |
| <p class="firstline">Returns the connections Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#createContact">createContact(body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Create a new contact and return the person resource for that contact.</p> |
| <p class="toc_element"> |
| <code><a href="#deleteContact">deleteContact(resourceName, x__xgafv=None)</a></code></p> |
| <p class="firstline">Delete a contact person. Any non-contact data will not be deleted.</p> |
| <p class="toc_element"> |
| <code><a href="#deleteContactPhoto">deleteContactPhoto(resourceName, personFields=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Delete a contact's photo.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(resourceName, requestMask_includeField=None, personFields=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Provides information about a person by specifying a resource name. Use</p> |
| <p class="toc_element"> |
| <code><a href="#getBatchGet">getBatchGet(personFields=None, requestMask_includeField=None, resourceNames=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Provides information about a list of specific people by specifying a list</p> |
| <p class="toc_element"> |
| <code><a href="#updateContact">updateContact(resourceName, body=None, updatePersonFields=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Update contact data for an existing contact person. Any non-contact data</p> |
| <p class="toc_element"> |
| <code><a href="#updateContactPhoto">updateContactPhoto(resourceName, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Update a contact's photo.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="createContact">createContact(body=None, x__xgafv=None)</code> |
| <pre>Create a new contact and return the person resource for that contact. |
| |
| Args: |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Information about a person merged from various data sources such as the |
| # authenticated user's contacts and profile data. |
| # |
| # Most fields can have multiple items. The items in a field have no guaranteed |
| # order, but each non-empty field is guaranteed to have exactly one field with |
| # `metadata.primary` set to true. |
| "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: |
| # |
| # * `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. |
| "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. |
| }, |
| }, |
| "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. |
| }, |
| ], |
| "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. |
| }, |
| "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", |
| ], |
| "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`.** |
| # |
| # 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. |
| }, |
| ], |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Information about a person merged from various data sources such as the |
| # authenticated user's contacts and profile data. |
| # |
| # Most fields can have multiple items. The items in a field have no guaranteed |
| # order, but each non-empty field is guaranteed to have exactly one field with |
| # `metadata.primary` set to true. |
| "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: |
| # |
| # * `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. |
| "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. |
| }, |
| }, |
| "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. |
| }, |
| ], |
| "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. |
| }, |
| "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", |
| ], |
| "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`.** |
| # |
| # 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. |
| }, |
| ], |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="deleteContact">deleteContact(resourceName, x__xgafv=None)</code> |
| <pre>Delete a contact person. Any non-contact data will not be deleted. |
| |
| Args: |
| resourceName: string, Required. The resource name of the contact to delete. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated |
| # empty messages in your APIs. A typical example is to use it as the request |
| # or the response type of an API method. For instance: |
| # |
| # service Foo { |
| # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| # } |
| # |
| # The JSON representation for `Empty` is empty JSON object `{}`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="deleteContactPhoto">deleteContactPhoto(resourceName, personFields=None, x__xgafv=None)</code> |
| <pre>Delete a contact's photo. |
| |
| Args: |
| resourceName: string, Required. The resource name of the contact whose photo will be deleted. (required) |
| personFields: string, Optional. A field mask to restrict which fields on the person are returned. Multiple |
| fields can be specified by separating them with commas. Defaults to empty |
| if not set, which will skip the post mutate get. Valid values are: |
| |
| * addresses |
| * ageRanges |
| * biographies |
| * birthdays |
| * coverPhotos |
| * emailAddresses |
| * events |
| * genders |
| * imClients |
| * interests |
| * locales |
| * memberships |
| * metadata |
| * names |
| * nicknames |
| * occupations |
| * organizations |
| * phoneNumbers |
| * photos |
| * relations |
| * residences |
| * sipAddresses |
| * skills |
| * urls |
| * userDefined |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The response for deleteing a contact's photo. |
| "person": { # Information about a person merged from various data sources such as the # The updated person, if person_fields is set in the |
| # DeleteContactPhotoRequest; otherwise this will be unset. |
| # 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: |
| # |
| # * `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. |
| "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. |
| }, |
| }, |
| "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. |
| }, |
| ], |
| "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. |
| }, |
| "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", |
| ], |
| "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`.** |
| # |
| # 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. |
| }, |
| ], |
| }, |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(resourceName, requestMask_includeField=None, personFields=None, x__xgafv=None)</code> |
| <pre>Provides information about a person by specifying a resource name. Use |
| `people/me` to indicate the authenticated user. |
| |
| The request throws a 400 error if 'personFields' is not specified. |
| |
| Args: |
| resourceName: string, Required. The resource name of the person to provide information about. |
| |
| - To get information about the authenticated user, specify `people/me`. |
| - To get information about a google account, specify |
| `people/{account_id}`. |
| - To get information about a contact, specify the resource name that |
| identifies the contact as returned by |
| [`people.connections.list`](/people/api/rest/v1/people.connections/list). (required) |
| requestMask_includeField: string, Required. Comma-separated list of person fields to be included in the response. Each |
| path should start with `person.`: for example, `person.names` or |
| `person.photos`. |
| personFields: string, Required. A field mask to restrict which fields on the person are returned. Multiple |
| fields can be specified by separating them with commas. Valid values are: |
| |
| * addresses |
| * ageRanges |
| * biographies |
| * birthdays |
| * coverPhotos |
| * emailAddresses |
| * events |
| * genders |
| * imClients |
| * interests |
| * locales |
| * memberships |
| * metadata |
| * names |
| * nicknames |
| * occupations |
| * organizations |
| * phoneNumbers |
| * photos |
| * relations |
| * residences |
| * sipAddresses |
| * skills |
| * urls |
| * userDefined |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Information about a person merged from various data sources such as the |
| # authenticated user's contacts and profile data. |
| # |
| # Most fields can have multiple items. The items in a field have no guaranteed |
| # order, but each non-empty field is guaranteed to have exactly one field with |
| # `metadata.primary` set to true. |
| "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: |
| # |
| # * `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. |
| "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. |
| }, |
| }, |
| "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. |
| }, |
| ], |
| "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. |
| }, |
| "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", |
| ], |
| "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`.** |
| # |
| # 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. |
| }, |
| ], |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getBatchGet">getBatchGet(personFields=None, requestMask_includeField=None, resourceNames=None, x__xgafv=None)</code> |
| <pre>Provides information about a list of specific people by specifying a list |
| of requested resource names. Use `people/me` to indicate the authenticated |
| user. |
| |
| The request throws a 400 error if 'personFields' is not specified. |
| |
| Args: |
| personFields: string, Required. A field mask to restrict which fields on each person are returned. Multiple |
| fields can be specified by separating them with commas. Valid values are: |
| |
| * addresses |
| * ageRanges |
| * biographies |
| * birthdays |
| * coverPhotos |
| * emailAddresses |
| * events |
| * genders |
| * imClients |
| * interests |
| * locales |
| * memberships |
| * metadata |
| * names |
| * nicknames |
| * occupations |
| * organizations |
| * phoneNumbers |
| * photos |
| * relations |
| * residences |
| * sipAddresses |
| * skills |
| * urls |
| * userDefined |
| requestMask_includeField: string, Required. Comma-separated list of person fields to be included in the response. Each |
| path should start with `person.`: for example, `person.names` or |
| `person.photos`. |
| resourceNames: string, Required. The resource names of the people to provide information about. |
| |
| - To get information about the authenticated user, specify `people/me`. |
| - To get information about a google account, specify |
| `people/{account_id}`. |
| - To get information about a contact, specify the resource name that |
| identifies the contact as returned by |
| [`people.connections.list`](/people/api/rest/v1/people.connections/list). |
| |
| You can include up to 50 resource names in one request. (repeated) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The response to a get request for a list of people by resource name. |
| "responses": [ # The response for each requested resource name. |
| { # The response for a single person |
| "httpStatusCode": 42, # **DEPRECATED** (Please use status instead) |
| # |
| # [HTTP 1.1 status code] |
| # (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html). |
| "person": { # Information about a person merged from various data sources such as the # The person. |
| # 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: |
| # |
| # * `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. |
| "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. |
| }, |
| }, |
| "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. |
| }, |
| ], |
| "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. |
| }, |
| "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", |
| ], |
| "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`.** |
| # |
| # 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. |
| }, |
| ], |
| }, |
| }, |
| "status": { # The `Status` type defines a logical error model that is suitable for # The status of the response. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "requestedResourceName": "A String", # The original requested resource name. May be different than the resource |
| # name on the returned person. |
| # |
| # The resource name can change when adding or removing fields that link a |
| # contact and profile such as a verified email, verified phone number, or a |
| # profile URL. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="updateContact">updateContact(resourceName, body=None, updatePersonFields=None, x__xgafv=None)</code> |
| <pre>Update contact data for an existing contact person. Any non-contact data |
| will not be modified. |
| |
| The request throws a 400 error if `updatePersonFields` is not specified. |
| |
| The request throws a 400 error if `person.metadata.sources` is not |
| specified for the contact to be updated. |
| |
| The request throws a 400 error with an error with reason |
| `"failedPrecondition"` if `person.metadata.sources.etag` is different than |
| the contact's etag, which indicates the contact has changed since its data |
| was read. Clients should get the latest person and re-apply their updates |
| to the latest person. |
| |
| Args: |
| resourceName: 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}`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Information about a person merged from various data sources such as the |
| # authenticated user's contacts and profile data. |
| # |
| # Most fields can have multiple items. The items in a field have no guaranteed |
| # order, but each non-empty field is guaranteed to have exactly one field with |
| # `metadata.primary` set to true. |
| "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: |
| # |
| # * `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. |
| "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. |
| }, |
| }, |
| "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. |
| }, |
| ], |
| "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. |
| }, |
| "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", |
| ], |
| "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`.** |
| # |
| # 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. |
| }, |
| ], |
| }, |
| } |
| |
| updatePersonFields: string, Required. A field mask to restrict which fields on the person are updated. Multiple |
| fields can be specified by separating them with commas. |
| All updated fields will be replaced. Valid values are: |
| |
| * addresses |
| * biographies |
| * birthdays |
| * emailAddresses |
| * events |
| * genders |
| * imClients |
| * interests |
| * locales |
| * memberships |
| * names |
| * nicknames |
| * occupations |
| * organizations |
| * phoneNumbers |
| * relations |
| * residences |
| * sipAddresses |
| * urls |
| * userDefined |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Information about a person merged from various data sources such as the |
| # authenticated user's contacts and profile data. |
| # |
| # Most fields can have multiple items. The items in a field have no guaranteed |
| # order, but each non-empty field is guaranteed to have exactly one field with |
| # `metadata.primary` set to true. |
| "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: |
| # |
| # * `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. |
| "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. |
| }, |
| }, |
| "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. |
| }, |
| ], |
| "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. |
| }, |
| "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", |
| ], |
| "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`.** |
| # |
| # 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. |
| }, |
| ], |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="updateContactPhoto">updateContactPhoto(resourceName, body=None, x__xgafv=None)</code> |
| <pre>Update a contact's photo. |
| |
| Args: |
| resourceName: string, Required. Person resource name (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A request to update an existing contact's photo. |
| # All requests must have a valid photo format: JPEG or PNG. |
| "photoBytes": "A String", # Required. Raw photo bytes |
| "personFields": "A String", # Optional. A field mask to restrict which fields on the person are returned. Multiple |
| # fields can be specified by separating them with commas. Defaults to empty |
| # if not set, which will skip the post mutate get. Valid values are: |
| # |
| # * addresses |
| # * ageRanges |
| # * biographies |
| # * birthdays |
| # * coverPhotos |
| # * emailAddresses |
| # * events |
| # * genders |
| # * imClients |
| # * interests |
| # * locales |
| # * memberships |
| # * metadata |
| # * names |
| # * nicknames |
| # * occupations |
| # * organizations |
| # * phoneNumbers |
| # * photos |
| # * relations |
| # * residences |
| # * sipAddresses |
| # * skills |
| # * urls |
| # * userDefined |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The response for updating a contact's photo. |
| "person": { # Information about a person merged from various data sources such as the # The updated person, if person_fields is set in the |
| # UpdateContactPhotoRequest; otherwise this will be unset. |
| # 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: |
| # |
| # * `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. |
| "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. |
| }, |
| }, |
| "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. |
| }, |
| ], |
| "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. |
| }, |
| "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", |
| ], |
| "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`.** |
| # |
| # 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. |
| }, |
| ], |
| }, |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |