chore: regens API reference docs (#889)
diff --git a/docs/dyn/people_v1.people.html b/docs/dyn/people_v1.people.html
index fd86443..b0dadbc 100644
--- a/docs/dyn/people_v1.people.html
+++ b/docs/dyn/people_v1.people.html
@@ -80,39 +80,1279 @@
<p class="firstline">Returns the connections Resource.</p>
<p class="toc_element">
- <code><a href="#createContact">createContact(body, parent=None, x__xgafv=None)</a></code></p>
+ <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, x__xgafv=None, personFields=None)</a></code></p>
+<p class="firstline">Delete a contact's photo.</p>
+<p class="toc_element">
<code><a href="#get">get(resourceName, x__xgafv=None, requestMask_includeField=None, personFields=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(resourceNames=None, x__xgafv=None, requestMask_includeField=None, personFields=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, updatePersonFields=None, x__xgafv=None)</a></code></p>
+ <code><a href="#updateContact">updateContact(resourceName, body=None, x__xgafv=None, updatePersonFields=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, parent=None, x__xgafv=None)</code>
+ <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. (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.
+ # 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.
+ "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.
+ "type": "A String", # The type of the SIP address. The type can be custom or or one of these
+ # predefined values:
+ #
+ # * `home`
+ # * `work`
+ # * `mobile`
+ # * `other`
+ "value": "A String", # The SIP address in the
+ # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI
+ # format.
+ "metadata": { # Metadata about a field. # Metadata about the SIP address.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "braggingRights": [ # **DEPRECATED**: No data will be returned
+ # The person's bragging rights.
+ { # **DEPRECATED**: No data will be returned
+ # A person's bragging rights.
+ "value": "A String", # The bragging rights; for example, `climbed mount everest`.
+ "metadata": { # Metadata about a field. # Metadata about the bragging rights.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "addresses": [ # The person's street addresses.
+ { # A person's physical address. May be a P.O. box or street address. All fields
+ # are optional.
+ "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.
+ "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.
+ "region": "A String", # The region of the address; for example, the state or province.
+ "poBox": "A String", # The P.O. box of the address.
+ "streetAddress": "A String", # The street address.
+ "country": "A String", # The country of the address.
+ "postalCode": "A String", # The postal code of the address.
+ "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
+ "type": "A String", # The type of the address. The type can be custom or one of these predefined
+ # values:
+ #
+ # * `home`
+ # * `work`
+ # * `other`
+ "metadata": { # Metadata about a field. # Metadata about the address.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "nicknames": [ # The person's nicknames.
+ { # A person's nickname.
+ "type": "A String", # The type of the nickname.
+ "value": "A String", # The nickname.
+ "metadata": { # Metadata about a field. # Metadata about the nickname.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "occupations": [ # The person's occupations.
+ { # A person's occupation.
+ "value": "A String", # The occupation; for example, `carpenter`.
+ "metadata": { # Metadata about a field. # Metadata about the occupation.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "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.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "names": [ # The person's names.
+ { # A person's name. If the name is a mononym, the family name is empty.
+ "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
+ "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.
+ "displayName": "A String", # Output only. The display name formatted according to the locale specified by
+ # the viewer's account or the `Accept-Language` HTTP header.
+ "phoneticFamilyName": "A String", # The family name spelled as it sounds.
+ "middleName": "A String", # The middle name(s).
+ "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
+ "familyName": "A String", # The family name.
+ "phoneticFullName": "A String", # The full name spelled as it sounds.
+ "phoneticGivenName": "A String", # The given name spelled as it sounds.
+ "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
+ "givenName": "A String", # The given name.
+ "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
+ "metadata": { # Metadata about a field. # Metadata about the name.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
+ # with a max length of 27 characters, in the form of
+ # `people/{person_id}`.
+ "ageRanges": [ # Output only. The person's age ranges.
+ { # A person's age range.
+ "ageRange": "A String", # The age range.
+ "metadata": { # Metadata about a field. # Metadata about the age range.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "birthdays": [ # The person's birthdays.
+ { # A person's birthday. At least one of the `date` and `text` fields are
+ # specified. The `date` and `text` fields typically represent the same
+ # date, but are not guaranteed to.
+ "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the birthday.
+ # and time zone are either specified elsewhere or are not significant. The date
+ # is relative to the Proleptic Gregorian Calendar. This can represent:
+ #
+ # * 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`.
+ "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+ # month and day.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year by itself or a year and month where the day is not
+ # significant.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
+ "text": "A String", # A free-form string representing the user's birthday.
+ "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "relations": [ # The person's relations.
+ { # A person's relation to another person.
+ "formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's
+ # account locale or the locale specified in the Accept-Language HTTP header.
+ "metadata": { # Metadata about a field. # Metadata about the relation.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ "type": "A String", # The person's relation to the other person. The type can be custom or one of
+ # these predefined values:
+ #
+ # * `spouse`
+ # * `child`
+ # * `mother`
+ # * `father`
+ # * `parent`
+ # * `brother`
+ # * `sister`
+ # * `friend`
+ # * `relative`
+ # * `domesticPartner`
+ # * `manager`
+ # * `assistant`
+ # * `referredBy`
+ # * `partner`
+ "person": "A String", # The name of the other person this relation refers to.
+ },
+ ],
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # resource. Used for web cache validation.
+ "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned
+ # The person's relationship statuses.
+ { # **DEPRECATED**: No data will be returned
+ # A person's relationship status.
+ "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in
+ # the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "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": { # Metadata about a field. # Metadata about the relationship status.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "skills": [ # The person's skills.
+ { # A skill that the person has.
+ "value": "A String", # The skill; for example, `underwater basket weaving`.
+ "metadata": { # Metadata about a field. # Metadata about the skill.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "imClients": [ # The person's instant messaging clients.
+ { # A person's instant messaging client.
+ "username": "A String", # The user name used in the IM client.
+ "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the
+ # viewer's account locale or the `Accept-Language` HTTP header locale.
+ "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
+ # predefined values:
+ #
+ # * `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.
+ "type": "A String", # The type of the IM client. The type can be custom or one of these
+ # predefined values:
+ #
+ # * `home`
+ # * `work`
+ # * `other`
+ "metadata": { # Metadata about a field. # Metadata about the IM client.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "events": [ # The person's events.
+ { # An event related to the person.
+ "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the event.
+ # and time zone are either specified elsewhere or are not significant. The date
+ # is relative to the Proleptic Gregorian Calendar. This can represent:
+ #
+ # * A full date, with non-zero year, month and day values
+ # * A month and day value, with a zero year, e.g. an anniversary
+ # * A year on its own, with zero month and day values
+ # * A year and month value, with a zero day, e.g. a credit card expiration date
+ #
+ # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
+ "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+ # month and day.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year by itself or a year and month where the day is not
+ # significant.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the
+ # viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the event. The type can be custom or one of these predefined
+ # values:
+ #
+ # * `anniversary`
+ # * `other`
+ "metadata": { # Metadata about a field. # Metadata about the event.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "metadata": { # The metadata about a person. # Output only. Metadata about the person.
+ "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.
+ "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",
+ ],
+ "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
+ "A String",
+ ],
+ "sources": [ # The sources of data for the person.
+ { # The source of a field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ ],
+ "objectType": "A String", # Output only. **DEPRECATED** (Please use
+ # `person.metadata.sources.profileMetadata.objectType` instead)
+ #
+ # The type of the person object.
+ },
+ "interests": [ # The person's interests.
+ { # One of the person's interests.
+ "value": "A String", # The interest; for example, `stargazing`.
+ "metadata": { # Metadata about a field. # Metadata about the interest.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "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.
+ "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
+ "metadata": { # Metadata about a field. # Metadata about the photo.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "residences": [ # The person's residences.
+ { # A person's past or current residence.
+ "current": True or False, # True if the residence is the person's current residence;
+ # false if the residence is a past residence.
+ "value": "A String", # The address of the residence.
+ "metadata": { # Metadata about a field. # Metadata about the residence.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned
+ # The person's relationship interests.
+ { # **DEPRECATED**: No data will be returned
+ # A person's relationship interest .
+ "formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted
+ # in the viewer's account locale or the locale specified in the
+ # Accept-Language HTTP header.
+ "value": "A String", # The kind of relationship the person is looking for. The value can be custom
+ # or one of these predefined values:
+ #
+ # * `friend`
+ # * `date`
+ # * `relationship`
+ # * `networking`
+ "metadata": { # Metadata about a field. # Metadata about the relationship interest.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "coverPhotos": [ # Output only. The person's cover photos.
+ { # A person's cover photo. A large image shown on the person's
+ # profile page that represents who they are or what they care about.
+ "default": True or False, # True if the cover photo is the default cover photo;
+ # false if the cover photo is a user-provided cover photo.
+ "url": "A String", # The URL of the cover photo.
+ "metadata": { # Metadata about a field. # Metadata about the cover photo.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "locales": [ # The person's locale preferences.
+ { # A person's locale preference.
+ "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.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "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.
+ "domain": "A String", # The domain name associated with the organization; for example,
+ # `google.com`.
+ "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`.
+ "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+ # month and day.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year by itself or a year and month where the day is not
+ # significant.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
+ "name": "A String", # The name of the organization.
+ "title": "A String", # The person's job title at the organization.
+ "type": "A String", # The type of the organization. The type can be custom or one of these
+ # predefined values:
+ #
+ # * `work`
+ # * `school`
+ "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
+ # symbol, abbreviation, or acronym.
+ "current": True or False, # True if the organization is the person's current organization;
+ # false if the organization is a past organization.
+ "jobDescription": "A String", # The person's job description at the organization.
+ "location": "A String", # The location of the organization office the person works at.
+ "department": "A String", # The person's department 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`.
+ "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+ # month and day.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year by itself or a year and month where the day is not
+ # significant.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
+ "phoneticName": "A String", # The phonetic name of the organization.
+ "metadata": { # Metadata about a field. # Metadata about the organization.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "userDefined": [ # The person's user defined data.
+ { # Arbitrary user data that is populated by the end users.
+ "key": "A String", # The end user specified key of the user defined data.
+ "value": "A String", # The end user specified value of the user defined data.
+ "metadata": { # Metadata about a field. # Metadata about the user defined data.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "biographies": [ # The person's biographies.
+ { # A person's short biography.
+ "contentType": "A String", # The content type of the biography.
+ "value": "A String", # The short biography.
+ "metadata": { # Metadata about a field. # Metadata about the biography.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "memberships": [ # The person's group memberships.
+ { # A person's membership in a group. Only contact group memberships can be
+ # modified.
+ "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
+ "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
+ "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
+ # string, in the form of `contactGroups/{contact_group_id}`.
+ # Only contact_group_resource_name can be used for modifying memberships.
+ # Any contact group membership can be removed, but only user group or
+ # "myContacts" or "starred" system groups memberships can be added. A
+ # contact must always have at least one contact group membership.
+ },
+ "domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.
+ "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
+ },
+ "metadata": { # Metadata about a field. # Metadata about the membership.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "taglines": [ # Output only. **DEPRECATED**: No data will be returned
+ # The person's taglines.
+ { # **DEPRECATED**: No data will be returned
+ # A brief one-line description of the person.
+ "value": "A String", # The tagline.
+ "metadata": { # Metadata about a field. # Metadata about the tagline.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "urls": [ # The person's associated URLs.
+ { # A person's associated URLs.
+ "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's
+ # account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the URL. The type can be custom or one of these predefined
+ # values:
+ #
+ # * `home`
+ # * `work`
+ # * `blog`
+ # * `profile`
+ # * `homePage`
+ # * `ftp`
+ # * `reservations`
+ # * `appInstallPage`: website for a Google+ application.
+ # * `other`
+ "value": "A String", # The URL.
+ "metadata": { # Metadata about a field. # Metadata about the URL.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead)
#
+ # The person's age range.
+ "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`
+ "value": "A String", # The gender for the person. The gender can be custom or one of these
+ # predefined values:
+ #
+ # * `male`
+ # * `female`
+ # * `unspecified`
+ "metadata": { # Metadata about a field. # Metadata about the gender.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "emailAddresses": [ # The person's email addresses.
+ { # A person's email address.
+ "formattedType": "A String", # Output only. The type of the email address translated and formatted in the
+ # viewer's account locale or the `Accept-Language` HTTP header locale.
+ "metadata": { # Metadata about a field. # Metadata about the email address.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ "displayName": "A String", # The display name of the email.
+ "value": "A String", # The 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`
+ },
+ ],
+}
+
+ 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.
"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", # The read-only type of the SIP address translated and formatted in the
+ "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the
# viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the SIP address. The type can be custom or or one of these
# predefined values:
@@ -126,7 +1366,7 @@
# format.
"metadata": { # Metadata about a field. # Metadata about the SIP address.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -135,16 +1375,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -152,32 +1392,14 @@
},
},
],
- "phoneNumbers": [ # The person's phone numbers.
- { # A person's phone number.
- "formattedType": "A String", # The read-only type of the phone number translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
- "canonicalForm": "A String", # The read-only 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.
- "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.
+ "braggingRights": [ # **DEPRECATED**: No data will be returned
+ # The person's bragging rights.
+ { # **DEPRECATED**: No data will be returned
+ # A person's bragging rights.
+ "value": "A String", # The bragging rights; for example, `climbed mount everest`.
+ "metadata": { # Metadata about a field. # Metadata about the bragging rights.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -186,16 +1408,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -206,7 +1428,7 @@
"addresses": [ # The person's street addresses.
{ # A person's physical address. May be a P.O. box or street address. All fields
# are optional.
- "formattedType": "A String", # The read-only type of the address translated and formatted in the viewer's
+ "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.
@@ -227,7 +1449,7 @@
# * `other`
"metadata": { # Metadata about a field. # Metadata about the address.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -236,16 +1458,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -259,7 +1481,7 @@
"value": "A String", # The nickname.
"metadata": { # Metadata about a field. # Metadata about the nickname.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -268,16 +1490,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -290,7 +1512,7 @@
"value": "A String", # The occupation; for example, `carpenter`.
"metadata": { # Metadata about a field. # Metadata about the occupation.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -299,16 +1521,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -316,12 +1538,32 @@
},
},
],
- "braggingRights": [ # The person's bragging rights.
- { # 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.
+ "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.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -330,16 +1572,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -351,12 +1593,12 @@
{ # A person's name. If the name is a mononym, the family name is empty.
"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
- "phoneticFamilyName": "A String", # The family name spelled as it sounds.
- "displayName": "A String", # The read-only display name formatted according to the locale specified by
- # the viewer's account or the `Accept-Language` HTTP header.
- "displayNameLastFirst": "A String", # The read-only display name with the last name first formatted according to
+ "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.
+ "displayName": "A String", # Output only. The display name formatted according to the locale specified by
+ # the viewer's account or the `Accept-Language` HTTP header.
+ "phoneticFamilyName": "A String", # The family name spelled as it sounds.
"middleName": "A String", # The middle name(s).
"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
"familyName": "A String", # The family name.
@@ -367,7 +1609,7 @@
"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
"metadata": { # Metadata about a field. # Metadata about the name.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -376,16 +1618,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -395,44 +1637,13 @@
],
"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/`<var>person_id</var>.
- "taglines": [ # The person's read-only taglines.
- { # A read-only brief one-line description of the person.
- "value": "A String", # The tagline.
- "metadata": { # Metadata about a field. # Metadata about the tagline.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "ageRanges": [ # The person's read-only age ranges.
+ # `people/{person_id}`.
+ "ageRanges": [ # Output only. The person's age ranges.
{ # A person's age range.
"ageRange": "A String", # The age range.
"metadata": { # Metadata about a field. # Metadata about the age range.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -441,16 +1652,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -462,13 +1673,16 @@
{ # A person's birthday. At least one of the `date` and `text` fields are
# specified. The `date` and `text` fields typically represent the same
# date, but are not guaranteed to.
- "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the birthday.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
+ "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`.
"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
@@ -480,7 +1694,7 @@
"text": "A String", # A free-form string representing the user's birthday.
"metadata": { # Metadata about a field. # Metadata about the birthday.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -489,16 +1703,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -508,10 +1722,11 @@
],
"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.
"metadata": { # Metadata about a field. # Metadata about the relation.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -520,16 +1735,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -552,15 +1767,16 @@
# * `assistant`
# * `referredBy`
# * `partner`
- "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account
- # locale or the locale specified in the Accept-Language HTTP header.
+ "person": "A String", # The name of the other person this relation refers to.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
# resource. Used for web cache validation.
- "relationshipStatuses": [ # The person's read-only relationship statuses.
- { # A person's read-only relationship status.
- "formattedValue": "A String", # The read-only value of the relationship status translated and formatted in
+ "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned
+ # The person's relationship statuses.
+ { # **DEPRECATED**: No data will be returned
+ # A person's relationship status.
+ "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in
# the viewer's account locale or the `Accept-Language` HTTP header locale.
"value": "A String", # The relationship status. The value can be custom or one of these
# predefined values:
@@ -576,7 +1792,7 @@
# * `inCivilUnion`
"metadata": { # Metadata about a field. # Metadata about the relationship status.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -585,16 +1801,47 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "skills": [ # The person's skills.
+ { # A skill that the person has.
+ "value": "A String", # The skill; for example, `underwater basket weaving`.
+ "metadata": { # Metadata about a field. # Metadata about the skill.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -605,7 +1852,7 @@
"imClients": [ # The person's instant messaging clients.
{ # A person's instant messaging client.
"username": "A String", # The user name used in the IM client.
- "formattedType": "A String", # The read-only type of the IM client translated and formatted in the
+ "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the
# viewer's account locale or the `Accept-Language` HTTP header locale.
"protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
# predefined values:
@@ -619,7 +1866,7 @@
# * `icq`
# * `jabber`
# * `netMeeting`
- "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account
+ "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.
"type": "A String", # The type of the IM client. The type can be custom or one of these
# predefined values:
@@ -629,7 +1876,7 @@
# * `other`
"metadata": { # Metadata about a field. # Metadata about the IM client.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -638,16 +1885,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -657,13 +1904,16 @@
],
"events": [ # The person's events.
{ # An event related to the person.
- "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the event.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
+ "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`.
"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
@@ -672,7 +1922,7 @@
"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
# a year.
},
- "formattedType": "A String", # The read-only type of the event translated and formatted in the
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the
# viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the event. The type can be custom or one of these predefined
# values:
@@ -681,7 +1931,7 @@
# * `other`
"metadata": { # Metadata about a field. # Metadata about the event.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -690,16 +1940,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -707,8 +1957,11 @@
},
},
],
- "metadata": { # The read-only metadata about a person. # Read-only metadata about the person.
- "previousResourceNames": [ # Any former resource names this person has had. Populated only for
+ "metadata": { # The metadata about a person. # Output only. Metadata about the person.
+ "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.
+ "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.
#
@@ -717,9 +1970,12 @@
# profile URL.
"A String",
],
+ "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
+ "A String",
+ ],
"sources": [ # The sources of data for the person.
{ # The source of a field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -728,23 +1984,17 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
],
- "linkedPeopleResourceNames": [ # Resource names of people linked to this resource.
- "A String",
- ],
- "deleted": True or False, # 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.
- "objectType": "A String", # **DEPRECATED** (Please use
+ "objectType": "A String", # Output only. **DEPRECATED** (Please use
# `person.metadata.sources.profileMetadata.objectType` instead)
#
# The type of the person object.
@@ -754,7 +2004,7 @@
"value": "A String", # The interest; for example, `stargazing`.
"metadata": { # Metadata about a field. # Metadata about the interest.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -763,16 +2013,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -780,17 +2030,18 @@
},
},
],
- "photos": [ # The person's read-only photos.
- { # A person's read-only photo. A picture shown next to the person's name to
+ "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.
"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=`<var>size</var> at the end of the url. Example:
- # `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`
+ # 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
"metadata": { # Metadata about a field. # Metadata about the photo.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -799,16 +2050,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -823,7 +2074,7 @@
"value": "A String", # The address of the residence.
"metadata": { # Metadata about a field. # Metadata about the residence.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -832,16 +2083,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -849,11 +2100,13 @@
},
},
],
- "relationshipInterests": [ # The person's read-only relationship interests.
- { # A person's read-only relationship interest .
- "formattedValue": "A String", # 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.
+ "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned
+ # The person's relationship interests.
+ { # **DEPRECATED**: No data will be returned
+ # A person's relationship interest .
+ "formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted
+ # in the viewer's account locale or the locale specified in the
+ # Accept-Language HTTP header.
"value": "A String", # The kind of relationship the person is looking for. The value can be custom
# or one of these predefined values:
#
@@ -863,7 +2116,7 @@
# * `networking`
"metadata": { # Metadata about a field. # Metadata about the relationship interest.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -872,16 +2125,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -889,15 +2142,15 @@
},
},
],
- "coverPhotos": [ # The person's read-only cover photos.
- { # A person's read-only cover photo. A large image shown on the person's
+ "coverPhotos": [ # Output only. The person's cover photos.
+ { # A person's cover photo. A large image shown on the person's
# profile page that represents who they are or what they care about.
"default": True or False, # True if the cover photo is the default cover photo;
# false if the cover photo is a user-provided cover photo.
"url": "A String", # The URL of the cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -906,16 +2159,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -929,7 +2182,7 @@
# language tag representing the locale.
"metadata": { # Metadata about a field. # Metadata about the locale.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -938,16 +2191,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -958,17 +2211,20 @@
"organizations": [ # The person's past or current organizations.
{ # A person's past or current organization. Overlapping date ranges are
# permitted.
- "formattedType": "A String", # The read-only type of the organization translated and formatted in the
+ "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.
"domain": "A String", # The domain name associated with the organization; for example,
# `google.com`.
- "endDate": { # Represents a whole calendar date, for example a date of birth. The time # The end date when the person left the organization.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
+ "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`.
"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
@@ -991,13 +2247,16 @@
"jobDescription": "A String", # The person's job description at the organization.
"location": "A String", # The location of the organization office the person works at.
"department": "A String", # The person's department at the organization.
- "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
+ "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`.
"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
@@ -1009,7 +2268,7 @@
"phoneticName": "A String", # The phonetic name of the organization.
"metadata": { # Metadata about a field. # Metadata about the organization.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -1018,16 +2277,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -1041,7 +2300,7 @@
"value": "A String", # The end user specified value of the user defined data.
"metadata": { # Metadata about a field. # Metadata about the user defined data.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -1050,16 +2309,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -1073,7 +2332,7 @@
"value": "A String", # The short biography.
"metadata": { # Metadata about a field. # Metadata about the biography.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -1082,16 +2341,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -1103,20 +2362,20 @@
{ # A person's membership in a group. Only contact group memberships can be
# modified.
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
- "contactGroupId": "A String", # The read-only contact group ID for the contact group membership.
+ "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
- # string, in the form of `contactGroups/`<var>contact_group_id</var>.
+ # string, in the form of `contactGroups/{contact_group_id}`.
# Only contact_group_resource_name can be used for modifying memberships.
# Any contact group membership can be removed, but only user group or
# "myContacts" or "starred" system groups memberships can be added. A
# contact must always have at least one contact group membership.
},
- "domainMembership": { # A read-only G Suite Domain membership. # The read-only domain 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.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -1125,16 +2384,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -1142,12 +2401,14 @@
},
},
],
- "skills": [ # The person's skills.
- { # A skill that the person has.
- "value": "A String", # The skill; for example, `underwater basket weaving`.
- "metadata": { # Metadata about a field. # Metadata about the skill.
+ "taglines": [ # Output only. **DEPRECATED**: No data will be returned
+ # The person's taglines.
+ { # **DEPRECATED**: No data will be returned
+ # A brief one-line description of the person.
+ "value": "A String", # The tagline.
+ "metadata": { # Metadata about a field. # Metadata about the tagline.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -1156,16 +2417,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -1175,7 +2436,7 @@
],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
- "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's
+ "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's
# account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the URL. The type can be custom or one of these predefined
# values:
@@ -1192,7 +2453,7 @@
"value": "A String", # The URL.
"metadata": { # Metadata about a field. # Metadata about the URL.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -1201,16 +2462,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -1218,23 +2479,29 @@
},
},
],
- "ageRange": "A String", # **DEPRECATED** (Please use `person.ageRanges` instead)**
- #
- # The person's read-only age range.
+ "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead)
+ #
+ # The person's age range.
"genders": [ # The person's genders.
{ # A person's gender.
- "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's
- # account locale or the `Accept-Language` HTTP header locale.
+ "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`
"value": "A String", # The gender for the person. The gender can be custom or one of these
# predefined values:
#
# * `male`
# * `female`
- # * `other`
- # * `unknown`
+ # * `unspecified`
"metadata": { # Metadata about a field. # Metadata about the gender.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -1243,16 +2510,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -1262,1253 +2529,45 @@
],
"emailAddresses": [ # The person's email addresses.
{ # A person's email address.
+ "formattedType": "A String", # Output only. The type of the email address translated and formatted in the
+ # viewer's account locale or the `Accept-Language` HTTP header locale.
+ "metadata": { # Metadata about a field. # Metadata about the email address.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ "displayName": "A String", # The display name of the email.
+ "value": "A String", # The 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`
- "formattedType": "A String", # The read-only type of the email address translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
- "displayName": "A String", # The display name of the email.
- "value": "A String", # The email address.
- "metadata": { # Metadata about a field. # Metadata about the email address.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
},
],
- }
-
- parent: string, The resource name of the owning person resource.
- 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.
- "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", # The read-only type of the SIP address translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
- "type": "A String", # The type of the SIP address. The type can be custom or or one of these
- # predefined values:
- #
- # * `home`
- # * `work`
- # * `mobile`
- # * `other`
- "value": "A String", # The SIP address in the
- # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI
- # format.
- "metadata": { # Metadata about a field. # Metadata about the SIP address.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "phoneNumbers": [ # The person's phone numbers.
- { # A person's phone number.
- "formattedType": "A String", # The read-only type of the phone number translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
- "canonicalForm": "A String", # The read-only 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.
- "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.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "addresses": [ # The person's street addresses.
- { # A person's physical address. May be a P.O. box or street address. All fields
- # are optional.
- "formattedType": "A String", # The read-only 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.
- "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.
- "region": "A String", # The region of the address; for example, the state or province.
- "poBox": "A String", # The P.O. box of the address.
- "streetAddress": "A String", # The street address.
- "country": "A String", # The country of the address.
- "postalCode": "A String", # The postal code of the address.
- "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
- "type": "A String", # The type of the address. The type can be custom or one of these predefined
- # values:
- #
- # * `home`
- # * `work`
- # * `other`
- "metadata": { # Metadata about a field. # Metadata about the address.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "nicknames": [ # The person's nicknames.
- { # A person's nickname.
- "type": "A String", # The type of the nickname.
- "value": "A String", # The nickname.
- "metadata": { # Metadata about a field. # Metadata about the nickname.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "occupations": [ # The person's occupations.
- { # A person's occupation.
- "value": "A String", # The occupation; for example, `carpenter`.
- "metadata": { # Metadata about a field. # Metadata about the occupation.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "braggingRights": [ # The person's bragging rights.
- { # A person's bragging rights.
- "value": "A String", # The bragging rights; for example, `climbed mount everest`.
- "metadata": { # Metadata about a field. # Metadata about the bragging rights.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "names": [ # The person's names.
- { # A person's name. If the name is a mononym, the family name is empty.
- "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
- "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
- "phoneticFamilyName": "A String", # The family name spelled as it sounds.
- "displayName": "A String", # The read-only display name formatted according to the locale specified by
- # the viewer's account or the `Accept-Language` HTTP header.
- "displayNameLastFirst": "A String", # The read-only display name with the last name first formatted according to
- # the locale specified by the viewer's account or the
- # `Accept-Language` HTTP header.
- "middleName": "A String", # The middle name(s).
- "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
- "familyName": "A String", # The family name.
- "phoneticFullName": "A String", # The full name spelled as it sounds.
- "phoneticGivenName": "A String", # The given name spelled as it sounds.
- "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
- "givenName": "A String", # The given name.
- "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
- "metadata": { # Metadata about a field. # Metadata about the name.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
- # with a max length of 27 characters, in the form of
- # `people/`<var>person_id</var>.
- "taglines": [ # The person's read-only taglines.
- { # A read-only brief one-line description of the person.
- "value": "A String", # The tagline.
- "metadata": { # Metadata about a field. # Metadata about the tagline.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "ageRanges": [ # The person's read-only age ranges.
- { # A person's age range.
- "ageRange": "A String", # The age range.
- "metadata": { # Metadata about a field. # Metadata about the age range.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "birthdays": [ # The person's birthdays.
- { # A person's birthday. At least one of the `date` and `text` fields are
- # specified. The `date` and `text` fields typically represent the same
- # date, but are not guaranteed to.
- "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the birthday.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
- "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
- # month and day.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- # if specifying a year by itself or a year and month where the day is not
- # significant.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
- },
- "text": "A String", # A free-form string representing the user's birthday.
- "metadata": { # Metadata about a field. # Metadata about the birthday.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "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.
- "metadata": { # Metadata about a field. # Metadata about the relation.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- "type": "A String", # The 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`
- "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account
- # locale or the locale specified in the Accept-Language HTTP header.
- },
- ],
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # resource. Used for web cache validation.
- "relationshipStatuses": [ # The person's read-only relationship statuses.
- { # A person's read-only relationship status.
- "formattedValue": "A String", # The read-only 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": { # Metadata about a field. # Metadata about the relationship status.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "imClients": [ # The person's instant messaging clients.
- { # A person's instant messaging client.
- "username": "A String", # The user name used in the IM client.
- "formattedType": "A String", # The read-only type of the IM client translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
- "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
- # predefined values:
- #
- # * `aim`
- # * `msn`
- # * `yahoo`
- # * `skype`
- # * `qq`
- # * `googleTalk`
- # * `icq`
- # * `jabber`
- # * `netMeeting`
- "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account
- # locale or the `Accept-Language` HTTP header locale.
- "type": "A String", # The type of the IM client. The type can be custom or one of these
- # predefined values:
- #
- # * `home`
- # * `work`
- # * `other`
- "metadata": { # Metadata about a field. # Metadata about the IM client.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "events": [ # The person's events.
- { # An event related to the person.
- "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the event.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
- "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
- # month and day.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- # if specifying a year by itself or a year and month where the day is not
- # significant.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
- },
- "formattedType": "A String", # The read-only type of the event translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
- "type": "A String", # The type of the event. The type can be custom or one of these predefined
- # values:
- #
- # * `anniversary`
- # * `other`
- "metadata": { # Metadata about a field. # Metadata about the event.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "metadata": { # The read-only metadata about a person. # Read-only metadata about the person.
- "previousResourceNames": [ # Any former resource names this person has had. Populated only for
- # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
- # that include a sync token.
- #
- # The resource name may change when adding or removing fields that link a
- # contact and profile such as a verified email, verified phone number, or
- # profile URL.
- "A String",
- ],
- "sources": [ # The sources of data for the person.
- { # The source of a field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- ],
- "linkedPeopleResourceNames": [ # Resource names of people linked to this resource.
- "A String",
- ],
- "deleted": True or False, # 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.
- "objectType": "A String", # **DEPRECATED** (Please use
- # `person.metadata.sources.profileMetadata.objectType` instead)
- #
- # The type of the person object.
- },
- "interests": [ # The person's interests.
- { # One of the person's interests.
- "value": "A String", # The interest; for example, `stargazing`.
- "metadata": { # Metadata about a field. # Metadata about the interest.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "photos": [ # The person's read-only photos.
- { # A person's read-only photo. A picture shown next to the person's name to
- # help others recognize the person.
- "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=`<var>size</var> at the end of the url. Example:
- # `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`
- "metadata": { # Metadata about a field. # Metadata about the photo.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "residences": [ # The person's residences.
- { # A person's past or current residence.
- "current": True or False, # True if the residence is the person's current residence;
- # false if the residence is a past residence.
- "value": "A String", # The address of the residence.
- "metadata": { # Metadata about a field. # Metadata about the residence.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "relationshipInterests": [ # The person's read-only relationship interests.
- { # A person's read-only relationship interest .
- "formattedValue": "A String", # The value of the relationship interest translated and formatted in the
- # viewer's account locale or the locale specified in the Accept-Language
- # HTTP header.
- "value": "A String", # The kind of relationship the person is looking for. The value can be custom
- # or one of these predefined values:
- #
- # * `friend`
- # * `date`
- # * `relationship`
- # * `networking`
- "metadata": { # Metadata about a field. # Metadata about the relationship interest.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "coverPhotos": [ # The person's read-only cover photos.
- { # A person's read-only cover photo. A large image shown on the person's
- # profile page that represents who they are or what they care about.
- "default": True or False, # True if the cover photo is the default cover photo;
- # false if the cover photo is a user-provided cover photo.
- "url": "A String", # The URL of the cover photo.
- "metadata": { # Metadata about a field. # Metadata about the cover photo.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "locales": [ # The person's locale preferences.
- { # A person's locale preference.
- "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.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "organizations": [ # The person's past or current organizations.
- { # A person's past or current organization. Overlapping date ranges are
- # permitted.
- "formattedType": "A String", # The read-only type of the organization translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
- "domain": "A String", # The domain name associated with the organization; for example,
- # `google.com`.
- "endDate": { # Represents a whole calendar date, for example a date of birth. The time # The end date when the person left the organization.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
- "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
- # month and day.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- # if specifying a year by itself or a year and month where the day is not
- # significant.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
- },
- "name": "A String", # The name of the organization.
- "title": "A String", # The person's job title at the organization.
- "type": "A String", # The type of the organization. The type can be custom or one of these
- # predefined values:
- #
- # * `work`
- # * `school`
- "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
- # symbol, abbreviation, or acronym.
- "current": True or False, # True if the organization is the person's current organization;
- # false if the organization is a past organization.
- "jobDescription": "A String", # The person's job description at the organization.
- "location": "A String", # The location of the organization office the person works at.
- "department": "A String", # The person's department at the organization.
- "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
- "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
- # month and day.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- # if specifying a year by itself or a year and month where the day is not
- # significant.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
- },
- "phoneticName": "A String", # The phonetic name of the organization.
- "metadata": { # Metadata about a field. # Metadata about the organization.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "userDefined": [ # The person's user defined data.
- { # Arbitrary user data that is populated by the end users.
- "key": "A String", # The end user specified key of the user defined data.
- "value": "A String", # The end user specified value of the user defined data.
- "metadata": { # Metadata about a field. # Metadata about the user defined data.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "biographies": [ # The person's biographies.
- { # A person's short biography.
- "contentType": "A String", # The content type of the biography.
- "value": "A String", # The short biography.
- "metadata": { # Metadata about a field. # Metadata about the biography.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "memberships": [ # The person's group memberships.
- { # A person's membership in a group. Only contact group memberships can be
- # modified.
- "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
- "contactGroupId": "A String", # The read-only contact group ID for the contact group membership.
- "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
- # string, in the form of `contactGroups/`<var>contact_group_id</var>.
- # Only contact_group_resource_name can be used for modifying memberships.
- # Any contact group membership can be removed, but only user group or
- # "myContacts" or "starred" system groups memberships can be added. A
- # contact must always have at least one contact group membership.
- },
- "domainMembership": { # A read-only G Suite Domain membership. # The read-only domain membership.
- "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
- },
- "metadata": { # Metadata about a field. # Metadata about the membership.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "skills": [ # The person's skills.
- { # A skill that the person has.
- "value": "A String", # The skill; for example, `underwater basket weaving`.
- "metadata": { # Metadata about a field. # Metadata about the skill.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "urls": [ # The person's associated URLs.
- { # A person's associated URLs.
- "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's
- # account locale or the `Accept-Language` HTTP header locale.
- "type": "A String", # The type of the URL. The type can be custom or one of these predefined
- # values:
- #
- # * `home`
- # * `work`
- # * `blog`
- # * `profile`
- # * `homePage`
- # * `ftp`
- # * `reservations`
- # * `appInstallPage`: website for a Google+ application.
- # * `other`
- "value": "A String", # The URL.
- "metadata": { # Metadata about a field. # Metadata about the URL.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "ageRange": "A String", # **DEPRECATED** (Please use `person.ageRanges` instead)**
- #
- # The person's read-only age range.
- "genders": [ # The person's genders.
- { # A person's gender.
- "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's
- # account locale or the `Accept-Language` HTTP header locale.
- "value": "A String", # The gender for the person. The gender can be custom or one of these
- # predefined values:
- #
- # * `male`
- # * `female`
- # * `other`
- # * `unknown`
- "metadata": { # Metadata about a field. # Metadata about the gender.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "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`
- "formattedType": "A String", # The read-only type of the email address translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
- "displayName": "A String", # The display name of the email.
- "value": "A String", # The email address.
- "metadata": { # Metadata about a field. # Metadata about the email address.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- }</pre>
+ }</pre>
</div>
<div class="method">
@@ -2516,7 +2575,7 @@
<pre>Delete a contact person. Any non-contact data will not be deleted.
Args:
- resourceName: string, The resource name of the contact to delete. (required)
+ resourceName: string, Required. The resource name of the contact to delete. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -2538,37 +2597,23 @@
</div>
<div class="method">
- <code class="details" id="get">get(resourceName, x__xgafv=None, requestMask_includeField=None, personFields=None)</code>
- <pre>Provides information about a person by specifying a resource name. Use
-`people/me` to indicate the authenticated user.
-<br>
-The request throws a 400 error if 'personFields' is not specified.
+ <code class="details" id="deleteContactPhoto">deleteContactPhoto(resourceName, x__xgafv=None, personFields=None)</code>
+ <pre>Delete a contact's photo.
Args:
- resourceName: string, 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/`<var>account_id</var>.
-- 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)
+ resourceName: string, Required. The resource name of the contact whose photo will be deleted. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- 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:
+ 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
-* braggingRights
* coverPhotos
* emailAddresses
* events
@@ -2585,19 +2630,18 @@
* phoneNumbers
* photos
* relations
-* relationshipInterests
-* relationshipStatuses
* residences
* sipAddresses
* skills
-* taglines
* urls
* userDefined
Returns:
An object of the form:
- { # Information about a person merged from various data sources such as the
+ { # 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
@@ -2606,7 +2650,7 @@
"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", # The read-only type of the SIP address translated and formatted in the
+ "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the
# viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the SIP address. The type can be custom or or one of these
# predefined values:
@@ -2620,7 +2664,7 @@
# format.
"metadata": { # Metadata about a field. # Metadata about the SIP address.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -2629,16 +2673,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -2646,32 +2690,14 @@
},
},
],
- "phoneNumbers": [ # The person's phone numbers.
- { # A person's phone number.
- "formattedType": "A String", # The read-only type of the phone number translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
- "canonicalForm": "A String", # The read-only 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.
- "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.
+ "braggingRights": [ # **DEPRECATED**: No data will be returned
+ # The person's bragging rights.
+ { # **DEPRECATED**: No data will be returned
+ # A person's bragging rights.
+ "value": "A String", # The bragging rights; for example, `climbed mount everest`.
+ "metadata": { # Metadata about a field. # Metadata about the bragging rights.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -2680,16 +2706,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -2700,7 +2726,7 @@
"addresses": [ # The person's street addresses.
{ # A person's physical address. May be a P.O. box or street address. All fields
# are optional.
- "formattedType": "A String", # The read-only type of the address translated and formatted in the viewer's
+ "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.
@@ -2721,7 +2747,7 @@
# * `other`
"metadata": { # Metadata about a field. # Metadata about the address.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -2730,16 +2756,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -2753,7 +2779,7 @@
"value": "A String", # The nickname.
"metadata": { # Metadata about a field. # Metadata about the nickname.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -2762,16 +2788,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -2784,7 +2810,7 @@
"value": "A String", # The occupation; for example, `carpenter`.
"metadata": { # Metadata about a field. # Metadata about the occupation.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -2793,16 +2819,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -2810,12 +2836,32 @@
},
},
],
- "braggingRights": [ # The person's bragging rights.
- { # 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.
+ "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.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -2824,16 +2870,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -2845,12 +2891,12 @@
{ # A person's name. If the name is a mononym, the family name is empty.
"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
- "phoneticFamilyName": "A String", # The family name spelled as it sounds.
- "displayName": "A String", # The read-only display name formatted according to the locale specified by
- # the viewer's account or the `Accept-Language` HTTP header.
- "displayNameLastFirst": "A String", # The read-only display name with the last name first formatted according to
+ "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.
+ "displayName": "A String", # Output only. The display name formatted according to the locale specified by
+ # the viewer's account or the `Accept-Language` HTTP header.
+ "phoneticFamilyName": "A String", # The family name spelled as it sounds.
"middleName": "A String", # The middle name(s).
"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
"familyName": "A String", # The family name.
@@ -2861,7 +2907,7 @@
"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
"metadata": { # Metadata about a field. # Metadata about the name.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -2870,16 +2916,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -2889,44 +2935,13 @@
],
"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/`<var>person_id</var>.
- "taglines": [ # The person's read-only taglines.
- { # A read-only brief one-line description of the person.
- "value": "A String", # The tagline.
- "metadata": { # Metadata about a field. # Metadata about the tagline.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "ageRanges": [ # The person's read-only age ranges.
+ # `people/{person_id}`.
+ "ageRanges": [ # Output only. The person's age ranges.
{ # A person's age range.
"ageRange": "A String", # The age range.
"metadata": { # Metadata about a field. # Metadata about the age range.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -2935,16 +2950,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -2956,13 +2971,16 @@
{ # A person's birthday. At least one of the `date` and `text` fields are
# specified. The `date` and `text` fields typically represent the same
# date, but are not guaranteed to.
- "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the birthday.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
+ "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`.
"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
@@ -2974,7 +2992,7 @@
"text": "A String", # A free-form string representing the user's birthday.
"metadata": { # Metadata about a field. # Metadata about the birthday.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -2983,16 +3001,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -3002,10 +3020,11 @@
],
"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.
"metadata": { # Metadata about a field. # Metadata about the relation.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -3014,16 +3033,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -3046,15 +3065,16 @@
# * `assistant`
# * `referredBy`
# * `partner`
- "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account
- # locale or the locale specified in the Accept-Language HTTP header.
+ "person": "A String", # The name of the other person this relation refers to.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
# resource. Used for web cache validation.
- "relationshipStatuses": [ # The person's read-only relationship statuses.
- { # A person's read-only relationship status.
- "formattedValue": "A String", # The read-only value of the relationship status translated and formatted in
+ "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned
+ # The person's relationship statuses.
+ { # **DEPRECATED**: No data will be returned
+ # A person's relationship status.
+ "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in
# the viewer's account locale or the `Accept-Language` HTTP header locale.
"value": "A String", # The relationship status. The value can be custom or one of these
# predefined values:
@@ -3070,7 +3090,7 @@
# * `inCivilUnion`
"metadata": { # Metadata about a field. # Metadata about the relationship status.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -3079,16 +3099,47 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "skills": [ # The person's skills.
+ { # A skill that the person has.
+ "value": "A String", # The skill; for example, `underwater basket weaving`.
+ "metadata": { # Metadata about a field. # Metadata about the skill.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -3099,7 +3150,7 @@
"imClients": [ # The person's instant messaging clients.
{ # A person's instant messaging client.
"username": "A String", # The user name used in the IM client.
- "formattedType": "A String", # The read-only type of the IM client translated and formatted in the
+ "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the
# viewer's account locale or the `Accept-Language` HTTP header locale.
"protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
# predefined values:
@@ -3113,7 +3164,7 @@
# * `icq`
# * `jabber`
# * `netMeeting`
- "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account
+ "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.
"type": "A String", # The type of the IM client. The type can be custom or one of these
# predefined values:
@@ -3123,7 +3174,7 @@
# * `other`
"metadata": { # Metadata about a field. # Metadata about the IM client.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -3132,16 +3183,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -3151,13 +3202,16 @@
],
"events": [ # The person's events.
{ # An event related to the person.
- "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the event.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
+ "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`.
"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
@@ -3166,7 +3220,7 @@
"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
# a year.
},
- "formattedType": "A String", # The read-only type of the event translated and formatted in the
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the
# viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the event. The type can be custom or one of these predefined
# values:
@@ -3175,7 +3229,7 @@
# * `other`
"metadata": { # Metadata about a field. # Metadata about the event.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -3184,16 +3238,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -3201,8 +3255,11 @@
},
},
],
- "metadata": { # The read-only metadata about a person. # Read-only metadata about the person.
- "previousResourceNames": [ # Any former resource names this person has had. Populated only for
+ "metadata": { # The metadata about a person. # Output only. Metadata about the person.
+ "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.
+ "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.
#
@@ -3211,9 +3268,12 @@
# profile URL.
"A String",
],
+ "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
+ "A String",
+ ],
"sources": [ # The sources of data for the person.
{ # The source of a field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -3222,23 +3282,17 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
],
- "linkedPeopleResourceNames": [ # Resource names of people linked to this resource.
- "A String",
- ],
- "deleted": True or False, # 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.
- "objectType": "A String", # **DEPRECATED** (Please use
+ "objectType": "A String", # Output only. **DEPRECATED** (Please use
# `person.metadata.sources.profileMetadata.objectType` instead)
#
# The type of the person object.
@@ -3248,7 +3302,7 @@
"value": "A String", # The interest; for example, `stargazing`.
"metadata": { # Metadata about a field. # Metadata about the interest.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -3257,16 +3311,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -3274,17 +3328,18 @@
},
},
],
- "photos": [ # The person's read-only photos.
- { # A person's read-only photo. A picture shown next to the person's name to
+ "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.
"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=`<var>size</var> at the end of the url. Example:
- # `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`
+ # 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
"metadata": { # Metadata about a field. # Metadata about the photo.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -3293,16 +3348,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -3317,7 +3372,7 @@
"value": "A String", # The address of the residence.
"metadata": { # Metadata about a field. # Metadata about the residence.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -3326,16 +3381,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -3343,11 +3398,13 @@
},
},
],
- "relationshipInterests": [ # The person's read-only relationship interests.
- { # A person's read-only relationship interest .
- "formattedValue": "A String", # 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.
+ "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned
+ # The person's relationship interests.
+ { # **DEPRECATED**: No data will be returned
+ # A person's relationship interest .
+ "formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted
+ # in the viewer's account locale or the locale specified in the
+ # Accept-Language HTTP header.
"value": "A String", # The kind of relationship the person is looking for. The value can be custom
# or one of these predefined values:
#
@@ -3357,7 +3414,7 @@
# * `networking`
"metadata": { # Metadata about a field. # Metadata about the relationship interest.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -3366,16 +3423,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -3383,15 +3440,15 @@
},
},
],
- "coverPhotos": [ # The person's read-only cover photos.
- { # A person's read-only cover photo. A large image shown on the person's
+ "coverPhotos": [ # Output only. The person's cover photos.
+ { # A person's cover photo. A large image shown on the person's
# profile page that represents who they are or what they care about.
"default": True or False, # True if the cover photo is the default cover photo;
# false if the cover photo is a user-provided cover photo.
"url": "A String", # The URL of the cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -3400,16 +3457,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -3423,7 +3480,7 @@
# language tag representing the locale.
"metadata": { # Metadata about a field. # Metadata about the locale.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -3432,16 +3489,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -3452,17 +3509,20 @@
"organizations": [ # The person's past or current organizations.
{ # A person's past or current organization. Overlapping date ranges are
# permitted.
- "formattedType": "A String", # The read-only type of the organization translated and formatted in the
+ "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.
"domain": "A String", # The domain name associated with the organization; for example,
# `google.com`.
- "endDate": { # Represents a whole calendar date, for example a date of birth. The time # The end date when the person left the organization.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
+ "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`.
"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
@@ -3485,13 +3545,16 @@
"jobDescription": "A String", # The person's job description at the organization.
"location": "A String", # The location of the organization office the person works at.
"department": "A String", # The person's department at the organization.
- "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
+ "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`.
"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
@@ -3503,7 +3566,7 @@
"phoneticName": "A String", # The phonetic name of the organization.
"metadata": { # Metadata about a field. # Metadata about the organization.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -3512,16 +3575,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -3535,7 +3598,7 @@
"value": "A String", # The end user specified value of the user defined data.
"metadata": { # Metadata about a field. # Metadata about the user defined data.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -3544,16 +3607,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -3567,7 +3630,7 @@
"value": "A String", # The short biography.
"metadata": { # Metadata about a field. # Metadata about the biography.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -3576,16 +3639,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -3597,20 +3660,20 @@
{ # A person's membership in a group. Only contact group memberships can be
# modified.
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
- "contactGroupId": "A String", # The read-only contact group ID for the contact group membership.
+ "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
- # string, in the form of `contactGroups/`<var>contact_group_id</var>.
+ # string, in the form of `contactGroups/{contact_group_id}`.
# Only contact_group_resource_name can be used for modifying memberships.
# Any contact group membership can be removed, but only user group or
# "myContacts" or "starred" system groups memberships can be added. A
# contact must always have at least one contact group membership.
},
- "domainMembership": { # A read-only G Suite Domain membership. # The read-only domain 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.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -3619,16 +3682,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -3636,12 +3699,14 @@
},
},
],
- "skills": [ # The person's skills.
- { # A skill that the person has.
- "value": "A String", # The skill; for example, `underwater basket weaving`.
- "metadata": { # Metadata about a field. # Metadata about the skill.
+ "taglines": [ # Output only. **DEPRECATED**: No data will be returned
+ # The person's taglines.
+ { # **DEPRECATED**: No data will be returned
+ # A brief one-line description of the person.
+ "value": "A String", # The tagline.
+ "metadata": { # Metadata about a field. # Metadata about the tagline.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -3650,16 +3715,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -3669,7 +3734,7 @@
],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
- "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's
+ "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's
# account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the URL. The type can be custom or one of these predefined
# values:
@@ -3686,7 +3751,7 @@
"value": "A String", # The URL.
"metadata": { # Metadata about a field. # Metadata about the URL.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -3695,16 +3760,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -3712,23 +3777,29 @@
},
},
],
- "ageRange": "A String", # **DEPRECATED** (Please use `person.ageRanges` instead)**
+ "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead)
#
- # The person's read-only age range.
+ # The person's age range.
"genders": [ # The person's genders.
{ # A person's gender.
- "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's
- # account locale or the `Accept-Language` HTTP header locale.
+ "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`
"value": "A String", # The gender for the person. The gender can be custom or one of these
# predefined values:
#
# * `male`
# * `female`
- # * `other`
- # * `unknown`
+ # * `unspecified`
"metadata": { # Metadata about a field. # Metadata about the gender.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -3737,16 +3808,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -3756,19 +3827,11 @@
],
"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`
- "formattedType": "A String", # The read-only type of the email address translated and formatted in the
+ "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.
- "displayName": "A String", # The display name of the email.
- "value": "A String", # The email address.
"metadata": { # Metadata about a field. # Metadata about the email address.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -3777,61 +3840,65 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
# field.
},
+ "displayName": "A String", # The display name of the email.
+ "value": "A String", # The 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`
},
],
- }</pre>
+ },
+ }</pre>
</div>
<div class="method">
- <code class="details" id="getBatchGet">getBatchGet(resourceNames=None, x__xgafv=None, requestMask_includeField=None, personFields=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.
-<br>
+ <code class="details" id="get">get(resourceName, x__xgafv=None, requestMask_includeField=None, personFields=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:
- resourceNames: string, The resource names of the people to provide information about.
+ 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/`<var>account_id</var>.
+ `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)
+[`people.connections.list`](/people/api/rest/v1/people.connections/list). (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- requestMask_includeField: string, **Required.** Comma-separated list of person fields to be included in the
-response. Each path should start with `person.`: for example,
-`person.names` or `person.photos`.
- personFields: string, **Required.** A field mask to restrict which fields on each person are
-returned. Multiple fields can be specified by separating them with commas.
-Valid values are:
+ 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
-* braggingRights
* coverPhotos
* emailAddresses
* events
@@ -3848,1284 +3915,25 @@
* phoneNumbers
* photos
* relations
-* relationshipInterests
-* relationshipStatuses
* residences
* sipAddresses
* skills
-* taglines
* urls
* userDefined
Returns:
An object of the form:
- {
- "responses": [ # The response for each requested resource name.
- { # The response for a single person
- "status": { # The `Status` type defines a logical error model that is suitable for # 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).
- "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.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "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.
- },
- ],
- },
- "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.
- "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", # The read-only type of the SIP address translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
- "type": "A String", # The type of the SIP address. The type can be custom or or one of these
- # predefined values:
- #
- # * `home`
- # * `work`
- # * `mobile`
- # * `other`
- "value": "A String", # The SIP address in the
- # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI
- # format.
- "metadata": { # Metadata about a field. # Metadata about the SIP address.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "phoneNumbers": [ # The person's phone numbers.
- { # A person's phone number.
- "formattedType": "A String", # The read-only type of the phone number translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
- "canonicalForm": "A String", # The read-only 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.
- "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.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "addresses": [ # The person's street addresses.
- { # A person's physical address. May be a P.O. box or street address. All fields
- # are optional.
- "formattedType": "A String", # The read-only 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.
- "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.
- "region": "A String", # The region of the address; for example, the state or province.
- "poBox": "A String", # The P.O. box of the address.
- "streetAddress": "A String", # The street address.
- "country": "A String", # The country of the address.
- "postalCode": "A String", # The postal code of the address.
- "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
- "type": "A String", # The type of the address. The type can be custom or one of these predefined
- # values:
- #
- # * `home`
- # * `work`
- # * `other`
- "metadata": { # Metadata about a field. # Metadata about the address.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "nicknames": [ # The person's nicknames.
- { # A person's nickname.
- "type": "A String", # The type of the nickname.
- "value": "A String", # The nickname.
- "metadata": { # Metadata about a field. # Metadata about the nickname.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "occupations": [ # The person's occupations.
- { # A person's occupation.
- "value": "A String", # The occupation; for example, `carpenter`.
- "metadata": { # Metadata about a field. # Metadata about the occupation.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "braggingRights": [ # The person's bragging rights.
- { # A person's bragging rights.
- "value": "A String", # The bragging rights; for example, `climbed mount everest`.
- "metadata": { # Metadata about a field. # Metadata about the bragging rights.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "names": [ # The person's names.
- { # A person's name. If the name is a mononym, the family name is empty.
- "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
- "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
- "phoneticFamilyName": "A String", # The family name spelled as it sounds.
- "displayName": "A String", # The read-only display name formatted according to the locale specified by
- # the viewer's account or the `Accept-Language` HTTP header.
- "displayNameLastFirst": "A String", # The read-only display name with the last name first formatted according to
- # the locale specified by the viewer's account or the
- # `Accept-Language` HTTP header.
- "middleName": "A String", # The middle name(s).
- "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
- "familyName": "A String", # The family name.
- "phoneticFullName": "A String", # The full name spelled as it sounds.
- "phoneticGivenName": "A String", # The given name spelled as it sounds.
- "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
- "givenName": "A String", # The given name.
- "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
- "metadata": { # Metadata about a field. # Metadata about the name.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
- # with a max length of 27 characters, in the form of
- # `people/`<var>person_id</var>.
- "taglines": [ # The person's read-only taglines.
- { # A read-only brief one-line description of the person.
- "value": "A String", # The tagline.
- "metadata": { # Metadata about a field. # Metadata about the tagline.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "ageRanges": [ # The person's read-only age ranges.
- { # A person's age range.
- "ageRange": "A String", # The age range.
- "metadata": { # Metadata about a field. # Metadata about the age range.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "birthdays": [ # The person's birthdays.
- { # A person's birthday. At least one of the `date` and `text` fields are
- # specified. The `date` and `text` fields typically represent the same
- # date, but are not guaranteed to.
- "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the birthday.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
- "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
- # month and day.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- # if specifying a year by itself or a year and month where the day is not
- # significant.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
- },
- "text": "A String", # A free-form string representing the user's birthday.
- "metadata": { # Metadata about a field. # Metadata about the birthday.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "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.
- "metadata": { # Metadata about a field. # Metadata about the relation.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- "type": "A String", # The 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`
- "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account
- # locale or the locale specified in the Accept-Language HTTP header.
- },
- ],
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # resource. Used for web cache validation.
- "relationshipStatuses": [ # The person's read-only relationship statuses.
- { # A person's read-only relationship status.
- "formattedValue": "A String", # The read-only 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": { # Metadata about a field. # Metadata about the relationship status.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "imClients": [ # The person's instant messaging clients.
- { # A person's instant messaging client.
- "username": "A String", # The user name used in the IM client.
- "formattedType": "A String", # The read-only type of the IM client translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
- "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
- # predefined values:
- #
- # * `aim`
- # * `msn`
- # * `yahoo`
- # * `skype`
- # * `qq`
- # * `googleTalk`
- # * `icq`
- # * `jabber`
- # * `netMeeting`
- "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account
- # locale or the `Accept-Language` HTTP header locale.
- "type": "A String", # The type of the IM client. The type can be custom or one of these
- # predefined values:
- #
- # * `home`
- # * `work`
- # * `other`
- "metadata": { # Metadata about a field. # Metadata about the IM client.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "events": [ # The person's events.
- { # An event related to the person.
- "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the event.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
- "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
- # month and day.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- # if specifying a year by itself or a year and month where the day is not
- # significant.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
- },
- "formattedType": "A String", # The read-only type of the event translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
- "type": "A String", # The type of the event. The type can be custom or one of these predefined
- # values:
- #
- # * `anniversary`
- # * `other`
- "metadata": { # Metadata about a field. # Metadata about the event.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "metadata": { # The read-only metadata about a person. # Read-only metadata about the person.
- "previousResourceNames": [ # Any former resource names this person has had. Populated only for
- # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
- # that include a sync token.
- #
- # The resource name may change when adding or removing fields that link a
- # contact and profile such as a verified email, verified phone number, or
- # profile URL.
- "A String",
- ],
- "sources": [ # The sources of data for the person.
- { # The source of a field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- ],
- "linkedPeopleResourceNames": [ # Resource names of people linked to this resource.
- "A String",
- ],
- "deleted": True or False, # 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.
- "objectType": "A String", # **DEPRECATED** (Please use
- # `person.metadata.sources.profileMetadata.objectType` instead)
- #
- # The type of the person object.
- },
- "interests": [ # The person's interests.
- { # One of the person's interests.
- "value": "A String", # The interest; for example, `stargazing`.
- "metadata": { # Metadata about a field. # Metadata about the interest.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "photos": [ # The person's read-only photos.
- { # A person's read-only photo. A picture shown next to the person's name to
- # help others recognize the person.
- "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=`<var>size</var> at the end of the url. Example:
- # `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`
- "metadata": { # Metadata about a field. # Metadata about the photo.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "residences": [ # The person's residences.
- { # A person's past or current residence.
- "current": True or False, # True if the residence is the person's current residence;
- # false if the residence is a past residence.
- "value": "A String", # The address of the residence.
- "metadata": { # Metadata about a field. # Metadata about the residence.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "relationshipInterests": [ # The person's read-only relationship interests.
- { # A person's read-only relationship interest .
- "formattedValue": "A String", # The value of the relationship interest translated and formatted in the
- # viewer's account locale or the locale specified in the Accept-Language
- # HTTP header.
- "value": "A String", # The kind of relationship the person is looking for. The value can be custom
- # or one of these predefined values:
- #
- # * `friend`
- # * `date`
- # * `relationship`
- # * `networking`
- "metadata": { # Metadata about a field. # Metadata about the relationship interest.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "coverPhotos": [ # The person's read-only cover photos.
- { # A person's read-only cover photo. A large image shown on the person's
- # profile page that represents who they are or what they care about.
- "default": True or False, # True if the cover photo is the default cover photo;
- # false if the cover photo is a user-provided cover photo.
- "url": "A String", # The URL of the cover photo.
- "metadata": { # Metadata about a field. # Metadata about the cover photo.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "locales": [ # The person's locale preferences.
- { # A person's locale preference.
- "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.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "organizations": [ # The person's past or current organizations.
- { # A person's past or current organization. Overlapping date ranges are
- # permitted.
- "formattedType": "A String", # The read-only type of the organization translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
- "domain": "A String", # The domain name associated with the organization; for example,
- # `google.com`.
- "endDate": { # Represents a whole calendar date, for example a date of birth. The time # The end date when the person left the organization.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
- "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
- # month and day.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- # if specifying a year by itself or a year and month where the day is not
- # significant.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
- },
- "name": "A String", # The name of the organization.
- "title": "A String", # The person's job title at the organization.
- "type": "A String", # The type of the organization. The type can be custom or one of these
- # predefined values:
- #
- # * `work`
- # * `school`
- "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
- # symbol, abbreviation, or acronym.
- "current": True or False, # True if the organization is the person's current organization;
- # false if the organization is a past organization.
- "jobDescription": "A String", # The person's job description at the organization.
- "location": "A String", # The location of the organization office the person works at.
- "department": "A String", # The person's department at the organization.
- "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
- "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
- # month and day.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- # if specifying a year by itself or a year and month where the day is not
- # significant.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
- },
- "phoneticName": "A String", # The phonetic name of the organization.
- "metadata": { # Metadata about a field. # Metadata about the organization.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "userDefined": [ # The person's user defined data.
- { # Arbitrary user data that is populated by the end users.
- "key": "A String", # The end user specified key of the user defined data.
- "value": "A String", # The end user specified value of the user defined data.
- "metadata": { # Metadata about a field. # Metadata about the user defined data.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "biographies": [ # The person's biographies.
- { # A person's short biography.
- "contentType": "A String", # The content type of the biography.
- "value": "A String", # The short biography.
- "metadata": { # Metadata about a field. # Metadata about the biography.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "memberships": [ # The person's group memberships.
- { # A person's membership in a group. Only contact group memberships can be
- # modified.
- "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
- "contactGroupId": "A String", # The read-only contact group ID for the contact group membership.
- "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
- # string, in the form of `contactGroups/`<var>contact_group_id</var>.
- # Only contact_group_resource_name can be used for modifying memberships.
- # Any contact group membership can be removed, but only user group or
- # "myContacts" or "starred" system groups memberships can be added. A
- # contact must always have at least one contact group membership.
- },
- "domainMembership": { # A read-only G Suite Domain membership. # The read-only domain membership.
- "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
- },
- "metadata": { # Metadata about a field. # Metadata about the membership.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "skills": [ # The person's skills.
- { # A skill that the person has.
- "value": "A String", # The skill; for example, `underwater basket weaving`.
- "metadata": { # Metadata about a field. # Metadata about the skill.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "urls": [ # The person's associated URLs.
- { # A person's associated URLs.
- "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's
- # account locale or the `Accept-Language` HTTP header locale.
- "type": "A String", # The type of the URL. The type can be custom or one of these predefined
- # values:
- #
- # * `home`
- # * `work`
- # * `blog`
- # * `profile`
- # * `homePage`
- # * `ftp`
- # * `reservations`
- # * `appInstallPage`: website for a Google+ application.
- # * `other`
- "value": "A String", # The URL.
- "metadata": { # Metadata about a field. # Metadata about the URL.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "ageRange": "A String", # **DEPRECATED** (Please use `person.ageRanges` instead)**
- #
- # The person's read-only age range.
- "genders": [ # The person's genders.
- { # A person's gender.
- "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's
- # account locale or the `Accept-Language` HTTP header locale.
- "value": "A String", # The gender for the person. The gender can be custom or one of these
- # predefined values:
- #
- # * `male`
- # * `female`
- # * `other`
- # * `unknown`
- "metadata": { # Metadata about a field. # Metadata about the gender.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "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`
- "formattedType": "A String", # The read-only type of the email address translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
- "displayName": "A String", # The display name of the email.
- "value": "A String", # The email address.
- "metadata": { # Metadata about a field. # Metadata about the email address.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- },
- "httpStatusCode": 42, # **DEPRECATED** (Please use status instead)
- #
- # [HTTP 1.1 status code]
- # (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).
- "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, 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.
-<br>
-The request throws a 400 error if `person.metadata.sources` is not
-specified for the contact to be updated.
-<br>
-The request throws a 412 error 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/`<var>person_id</var>. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Information about a person merged from various data sources such as the
+ { # 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.
"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", # The read-only type of the SIP address translated and formatted in the
+ "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the
# viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the SIP address. The type can be custom or or one of these
# predefined values:
@@ -5139,7 +3947,7 @@
# format.
"metadata": { # Metadata about a field. # Metadata about the SIP address.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -5148,16 +3956,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -5165,32 +3973,14 @@
},
},
],
- "phoneNumbers": [ # The person's phone numbers.
- { # A person's phone number.
- "formattedType": "A String", # The read-only type of the phone number translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
- "canonicalForm": "A String", # The read-only 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.
- "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.
+ "braggingRights": [ # **DEPRECATED**: No data will be returned
+ # The person's bragging rights.
+ { # **DEPRECATED**: No data will be returned
+ # A person's bragging rights.
+ "value": "A String", # The bragging rights; for example, `climbed mount everest`.
+ "metadata": { # Metadata about a field. # Metadata about the bragging rights.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -5199,16 +3989,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -5219,7 +4009,7 @@
"addresses": [ # The person's street addresses.
{ # A person's physical address. May be a P.O. box or street address. All fields
# are optional.
- "formattedType": "A String", # The read-only type of the address translated and formatted in the viewer's
+ "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.
@@ -5240,7 +4030,7 @@
# * `other`
"metadata": { # Metadata about a field. # Metadata about the address.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -5249,16 +4039,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -5272,7 +4062,7 @@
"value": "A String", # The nickname.
"metadata": { # Metadata about a field. # Metadata about the nickname.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -5281,16 +4071,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -5303,7 +4093,7 @@
"value": "A String", # The occupation; for example, `carpenter`.
"metadata": { # Metadata about a field. # Metadata about the occupation.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -5312,16 +4102,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -5329,12 +4119,32 @@
},
},
],
- "braggingRights": [ # The person's bragging rights.
- { # 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.
+ "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.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -5343,16 +4153,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -5364,12 +4174,12 @@
{ # A person's name. If the name is a mononym, the family name is empty.
"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
- "phoneticFamilyName": "A String", # The family name spelled as it sounds.
- "displayName": "A String", # The read-only display name formatted according to the locale specified by
- # the viewer's account or the `Accept-Language` HTTP header.
- "displayNameLastFirst": "A String", # The read-only display name with the last name first formatted according to
+ "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.
+ "displayName": "A String", # Output only. The display name formatted according to the locale specified by
+ # the viewer's account or the `Accept-Language` HTTP header.
+ "phoneticFamilyName": "A String", # The family name spelled as it sounds.
"middleName": "A String", # The middle name(s).
"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
"familyName": "A String", # The family name.
@@ -5380,7 +4190,7 @@
"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
"metadata": { # Metadata about a field. # Metadata about the name.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -5389,16 +4199,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -5408,44 +4218,13 @@
],
"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/`<var>person_id</var>.
- "taglines": [ # The person's read-only taglines.
- { # A read-only brief one-line description of the person.
- "value": "A String", # The tagline.
- "metadata": { # Metadata about a field. # Metadata about the tagline.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "ageRanges": [ # The person's read-only age ranges.
+ # `people/{person_id}`.
+ "ageRanges": [ # Output only. The person's age ranges.
{ # A person's age range.
"ageRange": "A String", # The age range.
"metadata": { # Metadata about a field. # Metadata about the age range.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -5454,16 +4233,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -5475,13 +4254,16 @@
{ # A person's birthday. At least one of the `date` and `text` fields are
# specified. The `date` and `text` fields typically represent the same
# date, but are not guaranteed to.
- "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the birthday.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
+ "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`.
"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
@@ -5493,7 +4275,7 @@
"text": "A String", # A free-form string representing the user's birthday.
"metadata": { # Metadata about a field. # Metadata about the birthday.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -5502,16 +4284,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -5521,10 +4303,11 @@
],
"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.
"metadata": { # Metadata about a field. # Metadata about the relation.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -5533,16 +4316,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -5565,15 +4348,16 @@
# * `assistant`
# * `referredBy`
# * `partner`
- "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account
- # locale or the locale specified in the Accept-Language HTTP header.
+ "person": "A String", # The name of the other person this relation refers to.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
# resource. Used for web cache validation.
- "relationshipStatuses": [ # The person's read-only relationship statuses.
- { # A person's read-only relationship status.
- "formattedValue": "A String", # The read-only value of the relationship status translated and formatted in
+ "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned
+ # The person's relationship statuses.
+ { # **DEPRECATED**: No data will be returned
+ # A person's relationship status.
+ "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in
# the viewer's account locale or the `Accept-Language` HTTP header locale.
"value": "A String", # The relationship status. The value can be custom or one of these
# predefined values:
@@ -5589,7 +4373,7 @@
# * `inCivilUnion`
"metadata": { # Metadata about a field. # Metadata about the relationship status.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -5598,16 +4382,47 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "skills": [ # The person's skills.
+ { # A skill that the person has.
+ "value": "A String", # The skill; for example, `underwater basket weaving`.
+ "metadata": { # Metadata about a field. # Metadata about the skill.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -5618,7 +4433,7 @@
"imClients": [ # The person's instant messaging clients.
{ # A person's instant messaging client.
"username": "A String", # The user name used in the IM client.
- "formattedType": "A String", # The read-only type of the IM client translated and formatted in the
+ "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the
# viewer's account locale or the `Accept-Language` HTTP header locale.
"protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
# predefined values:
@@ -5632,7 +4447,7 @@
# * `icq`
# * `jabber`
# * `netMeeting`
- "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account
+ "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.
"type": "A String", # The type of the IM client. The type can be custom or one of these
# predefined values:
@@ -5642,7 +4457,7 @@
# * `other`
"metadata": { # Metadata about a field. # Metadata about the IM client.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -5651,16 +4466,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -5670,13 +4485,16 @@
],
"events": [ # The person's events.
{ # An event related to the person.
- "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the event.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
+ "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`.
"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
@@ -5685,7 +4503,7 @@
"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
# a year.
},
- "formattedType": "A String", # The read-only type of the event translated and formatted in the
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the
# viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the event. The type can be custom or one of these predefined
# values:
@@ -5694,7 +4512,7 @@
# * `other`
"metadata": { # Metadata about a field. # Metadata about the event.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -5703,16 +4521,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -5720,8 +4538,11 @@
},
},
],
- "metadata": { # The read-only metadata about a person. # Read-only metadata about the person.
- "previousResourceNames": [ # Any former resource names this person has had. Populated only for
+ "metadata": { # The metadata about a person. # Output only. Metadata about the person.
+ "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.
+ "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.
#
@@ -5730,9 +4551,12 @@
# profile URL.
"A String",
],
+ "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
+ "A String",
+ ],
"sources": [ # The sources of data for the person.
{ # The source of a field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -5741,23 +4565,17 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
],
- "linkedPeopleResourceNames": [ # Resource names of people linked to this resource.
- "A String",
- ],
- "deleted": True or False, # 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.
- "objectType": "A String", # **DEPRECATED** (Please use
+ "objectType": "A String", # Output only. **DEPRECATED** (Please use
# `person.metadata.sources.profileMetadata.objectType` instead)
#
# The type of the person object.
@@ -5767,7 +4585,7 @@
"value": "A String", # The interest; for example, `stargazing`.
"metadata": { # Metadata about a field. # Metadata about the interest.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -5776,16 +4594,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -5793,17 +4611,18 @@
},
},
],
- "photos": [ # The person's read-only photos.
- { # A person's read-only photo. A picture shown next to the person's name to
+ "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.
"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=`<var>size</var> at the end of the url. Example:
- # `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`
+ # 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
"metadata": { # Metadata about a field. # Metadata about the photo.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -5812,16 +4631,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -5836,7 +4655,7 @@
"value": "A String", # The address of the residence.
"metadata": { # Metadata about a field. # Metadata about the residence.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -5845,16 +4664,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -5862,11 +4681,13 @@
},
},
],
- "relationshipInterests": [ # The person's read-only relationship interests.
- { # A person's read-only relationship interest .
- "formattedValue": "A String", # 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.
+ "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned
+ # The person's relationship interests.
+ { # **DEPRECATED**: No data will be returned
+ # A person's relationship interest .
+ "formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted
+ # in the viewer's account locale or the locale specified in the
+ # Accept-Language HTTP header.
"value": "A String", # The kind of relationship the person is looking for. The value can be custom
# or one of these predefined values:
#
@@ -5876,7 +4697,7 @@
# * `networking`
"metadata": { # Metadata about a field. # Metadata about the relationship interest.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -5885,16 +4706,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -5902,15 +4723,15 @@
},
},
],
- "coverPhotos": [ # The person's read-only cover photos.
- { # A person's read-only cover photo. A large image shown on the person's
+ "coverPhotos": [ # Output only. The person's cover photos.
+ { # A person's cover photo. A large image shown on the person's
# profile page that represents who they are or what they care about.
"default": True or False, # True if the cover photo is the default cover photo;
# false if the cover photo is a user-provided cover photo.
"url": "A String", # The URL of the cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -5919,16 +4740,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -5942,7 +4763,7 @@
# language tag representing the locale.
"metadata": { # Metadata about a field. # Metadata about the locale.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -5951,16 +4772,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -5971,17 +4792,20 @@
"organizations": [ # The person's past or current organizations.
{ # A person's past or current organization. Overlapping date ranges are
# permitted.
- "formattedType": "A String", # The read-only type of the organization translated and formatted in the
+ "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.
"domain": "A String", # The domain name associated with the organization; for example,
# `google.com`.
- "endDate": { # Represents a whole calendar date, for example a date of birth. The time # The end date when the person left the organization.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
+ "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`.
"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
@@ -6004,13 +4828,16 @@
"jobDescription": "A String", # The person's job description at the organization.
"location": "A String", # The location of the organization office the person works at.
"department": "A String", # The person's department at the organization.
- "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
+ "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`.
"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
@@ -6022,7 +4849,7 @@
"phoneticName": "A String", # The phonetic name of the organization.
"metadata": { # Metadata about a field. # Metadata about the organization.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -6031,16 +4858,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -6054,7 +4881,7 @@
"value": "A String", # The end user specified value of the user defined data.
"metadata": { # Metadata about a field. # Metadata about the user defined data.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -6063,16 +4890,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -6086,7 +4913,7 @@
"value": "A String", # The short biography.
"metadata": { # Metadata about a field. # Metadata about the biography.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -6095,16 +4922,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -6116,20 +4943,20 @@
{ # A person's membership in a group. Only contact group memberships can be
# modified.
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
- "contactGroupId": "A String", # The read-only contact group ID for the contact group membership.
+ "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
- # string, in the form of `contactGroups/`<var>contact_group_id</var>.
+ # string, in the form of `contactGroups/{contact_group_id}`.
# Only contact_group_resource_name can be used for modifying memberships.
# Any contact group membership can be removed, but only user group or
# "myContacts" or "starred" system groups memberships can be added. A
# contact must always have at least one contact group membership.
},
- "domainMembership": { # A read-only G Suite Domain membership. # The read-only domain 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.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -6138,16 +4965,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -6155,12 +4982,14 @@
},
},
],
- "skills": [ # The person's skills.
- { # A skill that the person has.
- "value": "A String", # The skill; for example, `underwater basket weaving`.
- "metadata": { # Metadata about a field. # Metadata about the skill.
+ "taglines": [ # Output only. **DEPRECATED**: No data will be returned
+ # The person's taglines.
+ { # **DEPRECATED**: No data will be returned
+ # A brief one-line description of the person.
+ "value": "A String", # The tagline.
+ "metadata": { # Metadata about a field. # Metadata about the tagline.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -6169,16 +4998,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -6188,7 +5017,7 @@
],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
- "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's
+ "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's
# account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the URL. The type can be custom or one of these predefined
# values:
@@ -6205,7 +5034,7 @@
"value": "A String", # The URL.
"metadata": { # Metadata about a field. # Metadata about the URL.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -6214,16 +5043,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -6231,23 +5060,29 @@
},
},
],
- "ageRange": "A String", # **DEPRECATED** (Please use `person.ageRanges` instead)**
- #
- # The person's read-only age range.
+ "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead)
+ #
+ # The person's age range.
"genders": [ # The person's genders.
{ # A person's gender.
- "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's
- # account locale or the `Accept-Language` HTTP header locale.
+ "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`
"value": "A String", # The gender for the person. The gender can be custom or one of these
# predefined values:
#
# * `male`
# * `female`
- # * `other`
- # * `unknown`
+ # * `unspecified`
"metadata": { # Metadata about a field. # Metadata about the gender.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -6256,16 +5091,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -6275,19 +5110,11 @@
],
"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`
- "formattedType": "A String", # The read-only type of the email address translated and formatted in the
+ "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.
- "displayName": "A String", # The display name of the email.
- "value": "A String", # The email address.
"metadata": { # Metadata about a field. # Metadata about the email address.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -6296,27 +5123,2608 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
# field.
},
+ "displayName": "A String", # The display name of the email.
+ "value": "A String", # The 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`
},
],
- }
+ }</pre>
+</div>
- 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.
+<div class="method">
+ <code class="details" id="getBatchGet">getBatchGet(resourceNames=None, x__xgafv=None, requestMask_includeField=None, personFields=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:
+ 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
+ requestMask_includeField: string, Required. Comma-separated list of person fields to be included in the response. Each
+path should start with `person.`: for example, `person.names` or
+`person.photos`.
+ personFields: string, Required. A field mask to restrict which fields on each person are returned. Multiple
+fields can be specified by separating them with commas. Valid values are:
+
+* addresses
+* ageRanges
+* biographies
+* birthdays
+* coverPhotos
+* emailAddresses
+* events
+* genders
+* imClients
+* interests
+* locales
+* memberships
+* metadata
+* names
+* nicknames
+* occupations
+* organizations
+* phoneNumbers
+* photos
+* relations
+* residences
+* sipAddresses
+* skills
+* urls
+* userDefined
+
+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
+ "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).
+ "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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "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.
+ },
+ ],
+ },
+ "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.
+ "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.
+ "type": "A String", # The type of the SIP address. The type can be custom or or one of these
+ # predefined values:
+ #
+ # * `home`
+ # * `work`
+ # * `mobile`
+ # * `other`
+ "value": "A String", # The SIP address in the
+ # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI
+ # format.
+ "metadata": { # Metadata about a field. # Metadata about the SIP address.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "braggingRights": [ # **DEPRECATED**: No data will be returned
+ # The person's bragging rights.
+ { # **DEPRECATED**: No data will be returned
+ # A person's bragging rights.
+ "value": "A String", # The bragging rights; for example, `climbed mount everest`.
+ "metadata": { # Metadata about a field. # Metadata about the bragging rights.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "addresses": [ # The person's street addresses.
+ { # A person's physical address. May be a P.O. box or street address. All fields
+ # are optional.
+ "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.
+ "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.
+ "region": "A String", # The region of the address; for example, the state or province.
+ "poBox": "A String", # The P.O. box of the address.
+ "streetAddress": "A String", # The street address.
+ "country": "A String", # The country of the address.
+ "postalCode": "A String", # The postal code of the address.
+ "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
+ "type": "A String", # The type of the address. The type can be custom or one of these predefined
+ # values:
+ #
+ # * `home`
+ # * `work`
+ # * `other`
+ "metadata": { # Metadata about a field. # Metadata about the address.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "nicknames": [ # The person's nicknames.
+ { # A person's nickname.
+ "type": "A String", # The type of the nickname.
+ "value": "A String", # The nickname.
+ "metadata": { # Metadata about a field. # Metadata about the nickname.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "occupations": [ # The person's occupations.
+ { # A person's occupation.
+ "value": "A String", # The occupation; for example, `carpenter`.
+ "metadata": { # Metadata about a field. # Metadata about the occupation.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "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.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "names": [ # The person's names.
+ { # A person's name. If the name is a mononym, the family name is empty.
+ "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
+ "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.
+ "displayName": "A String", # Output only. The display name formatted according to the locale specified by
+ # the viewer's account or the `Accept-Language` HTTP header.
+ "phoneticFamilyName": "A String", # The family name spelled as it sounds.
+ "middleName": "A String", # The middle name(s).
+ "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
+ "familyName": "A String", # The family name.
+ "phoneticFullName": "A String", # The full name spelled as it sounds.
+ "phoneticGivenName": "A String", # The given name spelled as it sounds.
+ "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
+ "givenName": "A String", # The given name.
+ "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
+ "metadata": { # Metadata about a field. # Metadata about the name.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
+ # with a max length of 27 characters, in the form of
+ # `people/{person_id}`.
+ "ageRanges": [ # Output only. The person's age ranges.
+ { # A person's age range.
+ "ageRange": "A String", # The age range.
+ "metadata": { # Metadata about a field. # Metadata about the age range.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "birthdays": [ # The person's birthdays.
+ { # A person's birthday. At least one of the `date` and `text` fields are
+ # specified. The `date` and `text` fields typically represent the same
+ # date, but are not guaranteed to.
+ "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the birthday.
+ # and time zone are either specified elsewhere or are not significant. The date
+ # is relative to the Proleptic Gregorian Calendar. This can represent:
+ #
+ # * 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`.
+ "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+ # month and day.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year by itself or a year and month where the day is not
+ # significant.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
+ "text": "A String", # A free-form string representing the user's birthday.
+ "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "relations": [ # The person's relations.
+ { # A person's relation to another person.
+ "formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's
+ # account locale or the locale specified in the Accept-Language HTTP header.
+ "metadata": { # Metadata about a field. # Metadata about the relation.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ "type": "A String", # The person's relation to the other person. The type can be custom or one of
+ # these predefined values:
+ #
+ # * `spouse`
+ # * `child`
+ # * `mother`
+ # * `father`
+ # * `parent`
+ # * `brother`
+ # * `sister`
+ # * `friend`
+ # * `relative`
+ # * `domesticPartner`
+ # * `manager`
+ # * `assistant`
+ # * `referredBy`
+ # * `partner`
+ "person": "A String", # The name of the other person this relation refers to.
+ },
+ ],
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # resource. Used for web cache validation.
+ "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned
+ # The person's relationship statuses.
+ { # **DEPRECATED**: No data will be returned
+ # A person's relationship status.
+ "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in
+ # the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "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": { # Metadata about a field. # Metadata about the relationship status.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "skills": [ # The person's skills.
+ { # A skill that the person has.
+ "value": "A String", # The skill; for example, `underwater basket weaving`.
+ "metadata": { # Metadata about a field. # Metadata about the skill.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "imClients": [ # The person's instant messaging clients.
+ { # A person's instant messaging client.
+ "username": "A String", # The user name used in the IM client.
+ "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the
+ # viewer's account locale or the `Accept-Language` HTTP header locale.
+ "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
+ # predefined values:
+ #
+ # * `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.
+ "type": "A String", # The type of the IM client. The type can be custom or one of these
+ # predefined values:
+ #
+ # * `home`
+ # * `work`
+ # * `other`
+ "metadata": { # Metadata about a field. # Metadata about the IM client.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "events": [ # The person's events.
+ { # An event related to the person.
+ "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the event.
+ # and time zone are either specified elsewhere or are not significant. The date
+ # is relative to the Proleptic Gregorian Calendar. This can represent:
+ #
+ # * A full date, with non-zero year, month and day values
+ # * A month and day value, with a zero year, e.g. an anniversary
+ # * A year on its own, with zero month and day values
+ # * A year and month value, with a zero day, e.g. a credit card expiration date
+ #
+ # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
+ "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+ # month and day.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year by itself or a year and month where the day is not
+ # significant.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the
+ # viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the event. The type can be custom or one of these predefined
+ # values:
+ #
+ # * `anniversary`
+ # * `other`
+ "metadata": { # Metadata about a field. # Metadata about the event.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "metadata": { # The metadata about a person. # Output only. Metadata about the person.
+ "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.
+ "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",
+ ],
+ "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
+ "A String",
+ ],
+ "sources": [ # The sources of data for the person.
+ { # The source of a field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ ],
+ "objectType": "A String", # Output only. **DEPRECATED** (Please use
+ # `person.metadata.sources.profileMetadata.objectType` instead)
+ #
+ # The type of the person object.
+ },
+ "interests": [ # The person's interests.
+ { # One of the person's interests.
+ "value": "A String", # The interest; for example, `stargazing`.
+ "metadata": { # Metadata about a field. # Metadata about the interest.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "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.
+ "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
+ "metadata": { # Metadata about a field. # Metadata about the photo.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "residences": [ # The person's residences.
+ { # A person's past or current residence.
+ "current": True or False, # True if the residence is the person's current residence;
+ # false if the residence is a past residence.
+ "value": "A String", # The address of the residence.
+ "metadata": { # Metadata about a field. # Metadata about the residence.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned
+ # The person's relationship interests.
+ { # **DEPRECATED**: No data will be returned
+ # A person's relationship interest .
+ "formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted
+ # in the viewer's account locale or the locale specified in the
+ # Accept-Language HTTP header.
+ "value": "A String", # The kind of relationship the person is looking for. The value can be custom
+ # or one of these predefined values:
+ #
+ # * `friend`
+ # * `date`
+ # * `relationship`
+ # * `networking`
+ "metadata": { # Metadata about a field. # Metadata about the relationship interest.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "coverPhotos": [ # Output only. The person's cover photos.
+ { # A person's cover photo. A large image shown on the person's
+ # profile page that represents who they are or what they care about.
+ "default": True or False, # True if the cover photo is the default cover photo;
+ # false if the cover photo is a user-provided cover photo.
+ "url": "A String", # The URL of the cover photo.
+ "metadata": { # Metadata about a field. # Metadata about the cover photo.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "locales": [ # The person's locale preferences.
+ { # A person's locale preference.
+ "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.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "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.
+ "domain": "A String", # The domain name associated with the organization; for example,
+ # `google.com`.
+ "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`.
+ "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+ # month and day.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year by itself or a year and month where the day is not
+ # significant.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
+ "name": "A String", # The name of the organization.
+ "title": "A String", # The person's job title at the organization.
+ "type": "A String", # The type of the organization. The type can be custom or one of these
+ # predefined values:
+ #
+ # * `work`
+ # * `school`
+ "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
+ # symbol, abbreviation, or acronym.
+ "current": True or False, # True if the organization is the person's current organization;
+ # false if the organization is a past organization.
+ "jobDescription": "A String", # The person's job description at the organization.
+ "location": "A String", # The location of the organization office the person works at.
+ "department": "A String", # The person's department 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`.
+ "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+ # month and day.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year by itself or a year and month where the day is not
+ # significant.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
+ "phoneticName": "A String", # The phonetic name of the organization.
+ "metadata": { # Metadata about a field. # Metadata about the organization.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "userDefined": [ # The person's user defined data.
+ { # Arbitrary user data that is populated by the end users.
+ "key": "A String", # The end user specified key of the user defined data.
+ "value": "A String", # The end user specified value of the user defined data.
+ "metadata": { # Metadata about a field. # Metadata about the user defined data.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "biographies": [ # The person's biographies.
+ { # A person's short biography.
+ "contentType": "A String", # The content type of the biography.
+ "value": "A String", # The short biography.
+ "metadata": { # Metadata about a field. # Metadata about the biography.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "memberships": [ # The person's group memberships.
+ { # A person's membership in a group. Only contact group memberships can be
+ # modified.
+ "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
+ "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
+ "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
+ # string, in the form of `contactGroups/{contact_group_id}`.
+ # Only contact_group_resource_name can be used for modifying memberships.
+ # Any contact group membership can be removed, but only user group or
+ # "myContacts" or "starred" system groups memberships can be added. A
+ # contact must always have at least one contact group membership.
+ },
+ "domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.
+ "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
+ },
+ "metadata": { # Metadata about a field. # Metadata about the membership.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "taglines": [ # Output only. **DEPRECATED**: No data will be returned
+ # The person's taglines.
+ { # **DEPRECATED**: No data will be returned
+ # A brief one-line description of the person.
+ "value": "A String", # The tagline.
+ "metadata": { # Metadata about a field. # Metadata about the tagline.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "urls": [ # The person's associated URLs.
+ { # A person's associated URLs.
+ "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's
+ # account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the URL. The type can be custom or one of these predefined
+ # values:
+ #
+ # * `home`
+ # * `work`
+ # * `blog`
+ # * `profile`
+ # * `homePage`
+ # * `ftp`
+ # * `reservations`
+ # * `appInstallPage`: website for a Google+ application.
+ # * `other`
+ "value": "A String", # The URL.
+ "metadata": { # Metadata about a field. # Metadata about the URL.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead)
+ #
+ # The person's age range.
+ "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`
+ "value": "A String", # The gender for the person. The gender can be custom or one of these
+ # predefined values:
+ #
+ # * `male`
+ # * `female`
+ # * `unspecified`
+ "metadata": { # Metadata about a field. # Metadata about the gender.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "emailAddresses": [ # The person's email addresses.
+ { # A person's email address.
+ "formattedType": "A String", # Output only. The type of the email address translated and formatted in the
+ # viewer's account locale or the `Accept-Language` HTTP header locale.
+ "metadata": { # Metadata about a field. # Metadata about the email address.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ "displayName": "A String", # The display name of the email.
+ "value": "A String", # The 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`
+ },
+ ],
+ },
+ "httpStatusCode": 42, # **DEPRECATED** (Please use status instead)
+ #
+ # [HTTP 1.1 status code]
+ # (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).
+ "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, x__xgafv=None, updatePersonFields=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.
+ "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.
+ "type": "A String", # The type of the SIP address. The type can be custom or or one of these
+ # predefined values:
+ #
+ # * `home`
+ # * `work`
+ # * `mobile`
+ # * `other`
+ "value": "A String", # The SIP address in the
+ # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI
+ # format.
+ "metadata": { # Metadata about a field. # Metadata about the SIP address.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "braggingRights": [ # **DEPRECATED**: No data will be returned
+ # The person's bragging rights.
+ { # **DEPRECATED**: No data will be returned
+ # A person's bragging rights.
+ "value": "A String", # The bragging rights; for example, `climbed mount everest`.
+ "metadata": { # Metadata about a field. # Metadata about the bragging rights.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "addresses": [ # The person's street addresses.
+ { # A person's physical address. May be a P.O. box or street address. All fields
+ # are optional.
+ "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.
+ "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.
+ "region": "A String", # The region of the address; for example, the state or province.
+ "poBox": "A String", # The P.O. box of the address.
+ "streetAddress": "A String", # The street address.
+ "country": "A String", # The country of the address.
+ "postalCode": "A String", # The postal code of the address.
+ "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
+ "type": "A String", # The type of the address. The type can be custom or one of these predefined
+ # values:
+ #
+ # * `home`
+ # * `work`
+ # * `other`
+ "metadata": { # Metadata about a field. # Metadata about the address.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "nicknames": [ # The person's nicknames.
+ { # A person's nickname.
+ "type": "A String", # The type of the nickname.
+ "value": "A String", # The nickname.
+ "metadata": { # Metadata about a field. # Metadata about the nickname.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "occupations": [ # The person's occupations.
+ { # A person's occupation.
+ "value": "A String", # The occupation; for example, `carpenter`.
+ "metadata": { # Metadata about a field. # Metadata about the occupation.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "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.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "names": [ # The person's names.
+ { # A person's name. If the name is a mononym, the family name is empty.
+ "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
+ "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.
+ "displayName": "A String", # Output only. The display name formatted according to the locale specified by
+ # the viewer's account or the `Accept-Language` HTTP header.
+ "phoneticFamilyName": "A String", # The family name spelled as it sounds.
+ "middleName": "A String", # The middle name(s).
+ "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
+ "familyName": "A String", # The family name.
+ "phoneticFullName": "A String", # The full name spelled as it sounds.
+ "phoneticGivenName": "A String", # The given name spelled as it sounds.
+ "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
+ "givenName": "A String", # The given name.
+ "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
+ "metadata": { # Metadata about a field. # Metadata about the name.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
+ # with a max length of 27 characters, in the form of
+ # `people/{person_id}`.
+ "ageRanges": [ # Output only. The person's age ranges.
+ { # A person's age range.
+ "ageRange": "A String", # The age range.
+ "metadata": { # Metadata about a field. # Metadata about the age range.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "birthdays": [ # The person's birthdays.
+ { # A person's birthday. At least one of the `date` and `text` fields are
+ # specified. The `date` and `text` fields typically represent the same
+ # date, but are not guaranteed to.
+ "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the birthday.
+ # and time zone are either specified elsewhere or are not significant. The date
+ # is relative to the Proleptic Gregorian Calendar. This can represent:
+ #
+ # * 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`.
+ "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+ # month and day.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year by itself or a year and month where the day is not
+ # significant.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
+ "text": "A String", # A free-form string representing the user's birthday.
+ "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "relations": [ # The person's relations.
+ { # A person's relation to another person.
+ "formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's
+ # account locale or the locale specified in the Accept-Language HTTP header.
+ "metadata": { # Metadata about a field. # Metadata about the relation.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ "type": "A String", # The person's relation to the other person. The type can be custom or one of
+ # these predefined values:
+ #
+ # * `spouse`
+ # * `child`
+ # * `mother`
+ # * `father`
+ # * `parent`
+ # * `brother`
+ # * `sister`
+ # * `friend`
+ # * `relative`
+ # * `domesticPartner`
+ # * `manager`
+ # * `assistant`
+ # * `referredBy`
+ # * `partner`
+ "person": "A String", # The name of the other person this relation refers to.
+ },
+ ],
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # resource. Used for web cache validation.
+ "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned
+ # The person's relationship statuses.
+ { # **DEPRECATED**: No data will be returned
+ # A person's relationship status.
+ "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in
+ # the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "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": { # Metadata about a field. # Metadata about the relationship status.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "skills": [ # The person's skills.
+ { # A skill that the person has.
+ "value": "A String", # The skill; for example, `underwater basket weaving`.
+ "metadata": { # Metadata about a field. # Metadata about the skill.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "imClients": [ # The person's instant messaging clients.
+ { # A person's instant messaging client.
+ "username": "A String", # The user name used in the IM client.
+ "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the
+ # viewer's account locale or the `Accept-Language` HTTP header locale.
+ "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
+ # predefined values:
+ #
+ # * `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.
+ "type": "A String", # The type of the IM client. The type can be custom or one of these
+ # predefined values:
+ #
+ # * `home`
+ # * `work`
+ # * `other`
+ "metadata": { # Metadata about a field. # Metadata about the IM client.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "events": [ # The person's events.
+ { # An event related to the person.
+ "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the event.
+ # and time zone are either specified elsewhere or are not significant. The date
+ # is relative to the Proleptic Gregorian Calendar. This can represent:
+ #
+ # * A full date, with non-zero year, month and day values
+ # * A month and day value, with a zero year, e.g. an anniversary
+ # * A year on its own, with zero month and day values
+ # * A year and month value, with a zero day, e.g. a credit card expiration date
+ #
+ # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
+ "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+ # month and day.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year by itself or a year and month where the day is not
+ # significant.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the
+ # viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the event. The type can be custom or one of these predefined
+ # values:
+ #
+ # * `anniversary`
+ # * `other`
+ "metadata": { # Metadata about a field. # Metadata about the event.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "metadata": { # The metadata about a person. # Output only. Metadata about the person.
+ "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.
+ "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",
+ ],
+ "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
+ "A String",
+ ],
+ "sources": [ # The sources of data for the person.
+ { # The source of a field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ ],
+ "objectType": "A String", # Output only. **DEPRECATED** (Please use
+ # `person.metadata.sources.profileMetadata.objectType` instead)
+ #
+ # The type of the person object.
+ },
+ "interests": [ # The person's interests.
+ { # One of the person's interests.
+ "value": "A String", # The interest; for example, `stargazing`.
+ "metadata": { # Metadata about a field. # Metadata about the interest.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "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.
+ "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
+ "metadata": { # Metadata about a field. # Metadata about the photo.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "residences": [ # The person's residences.
+ { # A person's past or current residence.
+ "current": True or False, # True if the residence is the person's current residence;
+ # false if the residence is a past residence.
+ "value": "A String", # The address of the residence.
+ "metadata": { # Metadata about a field. # Metadata about the residence.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned
+ # The person's relationship interests.
+ { # **DEPRECATED**: No data will be returned
+ # A person's relationship interest .
+ "formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted
+ # in the viewer's account locale or the locale specified in the
+ # Accept-Language HTTP header.
+ "value": "A String", # The kind of relationship the person is looking for. The value can be custom
+ # or one of these predefined values:
+ #
+ # * `friend`
+ # * `date`
+ # * `relationship`
+ # * `networking`
+ "metadata": { # Metadata about a field. # Metadata about the relationship interest.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "coverPhotos": [ # Output only. The person's cover photos.
+ { # A person's cover photo. A large image shown on the person's
+ # profile page that represents who they are or what they care about.
+ "default": True or False, # True if the cover photo is the default cover photo;
+ # false if the cover photo is a user-provided cover photo.
+ "url": "A String", # The URL of the cover photo.
+ "metadata": { # Metadata about a field. # Metadata about the cover photo.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "locales": [ # The person's locale preferences.
+ { # A person's locale preference.
+ "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.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "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.
+ "domain": "A String", # The domain name associated with the organization; for example,
+ # `google.com`.
+ "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`.
+ "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+ # month and day.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year by itself or a year and month where the day is not
+ # significant.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
+ "name": "A String", # The name of the organization.
+ "title": "A String", # The person's job title at the organization.
+ "type": "A String", # The type of the organization. The type can be custom or one of these
+ # predefined values:
+ #
+ # * `work`
+ # * `school`
+ "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
+ # symbol, abbreviation, or acronym.
+ "current": True or False, # True if the organization is the person's current organization;
+ # false if the organization is a past organization.
+ "jobDescription": "A String", # The person's job description at the organization.
+ "location": "A String", # The location of the organization office the person works at.
+ "department": "A String", # The person's department 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`.
+ "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+ # month and day.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year by itself or a year and month where the day is not
+ # significant.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
+ "phoneticName": "A String", # The phonetic name of the organization.
+ "metadata": { # Metadata about a field. # Metadata about the organization.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "userDefined": [ # The person's user defined data.
+ { # Arbitrary user data that is populated by the end users.
+ "key": "A String", # The end user specified key of the user defined data.
+ "value": "A String", # The end user specified value of the user defined data.
+ "metadata": { # Metadata about a field. # Metadata about the user defined data.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "biographies": [ # The person's biographies.
+ { # A person's short biography.
+ "contentType": "A String", # The content type of the biography.
+ "value": "A String", # The short biography.
+ "metadata": { # Metadata about a field. # Metadata about the biography.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "memberships": [ # The person's group memberships.
+ { # A person's membership in a group. Only contact group memberships can be
+ # modified.
+ "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
+ "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
+ "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
+ # string, in the form of `contactGroups/{contact_group_id}`.
+ # Only contact_group_resource_name can be used for modifying memberships.
+ # Any contact group membership can be removed, but only user group or
+ # "myContacts" or "starred" system groups memberships can be added. A
+ # contact must always have at least one contact group membership.
+ },
+ "domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.
+ "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
+ },
+ "metadata": { # Metadata about a field. # Metadata about the membership.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "taglines": [ # Output only. **DEPRECATED**: No data will be returned
+ # The person's taglines.
+ { # **DEPRECATED**: No data will be returned
+ # A brief one-line description of the person.
+ "value": "A String", # The tagline.
+ "metadata": { # Metadata about a field. # Metadata about the tagline.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "urls": [ # The person's associated URLs.
+ { # A person's associated URLs.
+ "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's
+ # account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the URL. The type can be custom or one of these predefined
+ # values:
+ #
+ # * `home`
+ # * `work`
+ # * `blog`
+ # * `profile`
+ # * `homePage`
+ # * `ftp`
+ # * `reservations`
+ # * `appInstallPage`: website for a Google+ application.
+ # * `other`
+ "value": "A String", # The URL.
+ "metadata": { # Metadata about a field. # Metadata about the URL.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead)
+ #
+ # The person's age range.
+ "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`
+ "value": "A String", # The gender for the person. The gender can be custom or one of these
+ # predefined values:
+ #
+ # * `male`
+ # * `female`
+ # * `unspecified`
+ "metadata": { # Metadata about a field. # Metadata about the gender.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "emailAddresses": [ # The person's email addresses.
+ { # A person's email address.
+ "formattedType": "A String", # Output only. The type of the email address translated and formatted in the
+ # viewer's account locale or the `Accept-Language` HTTP header locale.
+ "metadata": { # Metadata about a field. # Metadata about the email address.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ "displayName": "A String", # The display name of the email.
+ "value": "A String", # The 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`
+ },
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+ 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
@@ -6339,6 +7747,1280 @@
* sipAddresses
* urls
* userDefined
+
+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.
+ "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.
+ "type": "A String", # The type of the SIP address. The type can be custom or or one of these
+ # predefined values:
+ #
+ # * `home`
+ # * `work`
+ # * `mobile`
+ # * `other`
+ "value": "A String", # The SIP address in the
+ # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI
+ # format.
+ "metadata": { # Metadata about a field. # Metadata about the SIP address.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "braggingRights": [ # **DEPRECATED**: No data will be returned
+ # The person's bragging rights.
+ { # **DEPRECATED**: No data will be returned
+ # A person's bragging rights.
+ "value": "A String", # The bragging rights; for example, `climbed mount everest`.
+ "metadata": { # Metadata about a field. # Metadata about the bragging rights.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "addresses": [ # The person's street addresses.
+ { # A person's physical address. May be a P.O. box or street address. All fields
+ # are optional.
+ "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.
+ "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.
+ "region": "A String", # The region of the address; for example, the state or province.
+ "poBox": "A String", # The P.O. box of the address.
+ "streetAddress": "A String", # The street address.
+ "country": "A String", # The country of the address.
+ "postalCode": "A String", # The postal code of the address.
+ "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
+ "type": "A String", # The type of the address. The type can be custom or one of these predefined
+ # values:
+ #
+ # * `home`
+ # * `work`
+ # * `other`
+ "metadata": { # Metadata about a field. # Metadata about the address.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "nicknames": [ # The person's nicknames.
+ { # A person's nickname.
+ "type": "A String", # The type of the nickname.
+ "value": "A String", # The nickname.
+ "metadata": { # Metadata about a field. # Metadata about the nickname.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "occupations": [ # The person's occupations.
+ { # A person's occupation.
+ "value": "A String", # The occupation; for example, `carpenter`.
+ "metadata": { # Metadata about a field. # Metadata about the occupation.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "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.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "names": [ # The person's names.
+ { # A person's name. If the name is a mononym, the family name is empty.
+ "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
+ "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.
+ "displayName": "A String", # Output only. The display name formatted according to the locale specified by
+ # the viewer's account or the `Accept-Language` HTTP header.
+ "phoneticFamilyName": "A String", # The family name spelled as it sounds.
+ "middleName": "A String", # The middle name(s).
+ "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
+ "familyName": "A String", # The family name.
+ "phoneticFullName": "A String", # The full name spelled as it sounds.
+ "phoneticGivenName": "A String", # The given name spelled as it sounds.
+ "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
+ "givenName": "A String", # The given name.
+ "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
+ "metadata": { # Metadata about a field. # Metadata about the name.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
+ # with a max length of 27 characters, in the form of
+ # `people/{person_id}`.
+ "ageRanges": [ # Output only. The person's age ranges.
+ { # A person's age range.
+ "ageRange": "A String", # The age range.
+ "metadata": { # Metadata about a field. # Metadata about the age range.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "birthdays": [ # The person's birthdays.
+ { # A person's birthday. At least one of the `date` and `text` fields are
+ # specified. The `date` and `text` fields typically represent the same
+ # date, but are not guaranteed to.
+ "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the birthday.
+ # and time zone are either specified elsewhere or are not significant. The date
+ # is relative to the Proleptic Gregorian Calendar. This can represent:
+ #
+ # * 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`.
+ "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+ # month and day.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year by itself or a year and month where the day is not
+ # significant.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
+ "text": "A String", # A free-form string representing the user's birthday.
+ "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "relations": [ # The person's relations.
+ { # A person's relation to another person.
+ "formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's
+ # account locale or the locale specified in the Accept-Language HTTP header.
+ "metadata": { # Metadata about a field. # Metadata about the relation.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ "type": "A String", # The person's relation to the other person. The type can be custom or one of
+ # these predefined values:
+ #
+ # * `spouse`
+ # * `child`
+ # * `mother`
+ # * `father`
+ # * `parent`
+ # * `brother`
+ # * `sister`
+ # * `friend`
+ # * `relative`
+ # * `domesticPartner`
+ # * `manager`
+ # * `assistant`
+ # * `referredBy`
+ # * `partner`
+ "person": "A String", # The name of the other person this relation refers to.
+ },
+ ],
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # resource. Used for web cache validation.
+ "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned
+ # The person's relationship statuses.
+ { # **DEPRECATED**: No data will be returned
+ # A person's relationship status.
+ "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in
+ # the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "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": { # Metadata about a field. # Metadata about the relationship status.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "skills": [ # The person's skills.
+ { # A skill that the person has.
+ "value": "A String", # The skill; for example, `underwater basket weaving`.
+ "metadata": { # Metadata about a field. # Metadata about the skill.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "imClients": [ # The person's instant messaging clients.
+ { # A person's instant messaging client.
+ "username": "A String", # The user name used in the IM client.
+ "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the
+ # viewer's account locale or the `Accept-Language` HTTP header locale.
+ "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
+ # predefined values:
+ #
+ # * `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.
+ "type": "A String", # The type of the IM client. The type can be custom or one of these
+ # predefined values:
+ #
+ # * `home`
+ # * `work`
+ # * `other`
+ "metadata": { # Metadata about a field. # Metadata about the IM client.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "events": [ # The person's events.
+ { # An event related to the person.
+ "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the event.
+ # and time zone are either specified elsewhere or are not significant. The date
+ # is relative to the Proleptic Gregorian Calendar. This can represent:
+ #
+ # * A full date, with non-zero year, month and day values
+ # * A month and day value, with a zero year, e.g. an anniversary
+ # * A year on its own, with zero month and day values
+ # * A year and month value, with a zero day, e.g. a credit card expiration date
+ #
+ # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
+ "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+ # month and day.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year by itself or a year and month where the day is not
+ # significant.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the
+ # viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the event. The type can be custom or one of these predefined
+ # values:
+ #
+ # * `anniversary`
+ # * `other`
+ "metadata": { # Metadata about a field. # Metadata about the event.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "metadata": { # The metadata about a person. # Output only. Metadata about the person.
+ "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.
+ "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",
+ ],
+ "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
+ "A String",
+ ],
+ "sources": [ # The sources of data for the person.
+ { # The source of a field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ ],
+ "objectType": "A String", # Output only. **DEPRECATED** (Please use
+ # `person.metadata.sources.profileMetadata.objectType` instead)
+ #
+ # The type of the person object.
+ },
+ "interests": [ # The person's interests.
+ { # One of the person's interests.
+ "value": "A String", # The interest; for example, `stargazing`.
+ "metadata": { # Metadata about a field. # Metadata about the interest.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "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.
+ "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
+ "metadata": { # Metadata about a field. # Metadata about the photo.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "residences": [ # The person's residences.
+ { # A person's past or current residence.
+ "current": True or False, # True if the residence is the person's current residence;
+ # false if the residence is a past residence.
+ "value": "A String", # The address of the residence.
+ "metadata": { # Metadata about a field. # Metadata about the residence.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned
+ # The person's relationship interests.
+ { # **DEPRECATED**: No data will be returned
+ # A person's relationship interest .
+ "formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted
+ # in the viewer's account locale or the locale specified in the
+ # Accept-Language HTTP header.
+ "value": "A String", # The kind of relationship the person is looking for. The value can be custom
+ # or one of these predefined values:
+ #
+ # * `friend`
+ # * `date`
+ # * `relationship`
+ # * `networking`
+ "metadata": { # Metadata about a field. # Metadata about the relationship interest.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "coverPhotos": [ # Output only. The person's cover photos.
+ { # A person's cover photo. A large image shown on the person's
+ # profile page that represents who they are or what they care about.
+ "default": True or False, # True if the cover photo is the default cover photo;
+ # false if the cover photo is a user-provided cover photo.
+ "url": "A String", # The URL of the cover photo.
+ "metadata": { # Metadata about a field. # Metadata about the cover photo.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "locales": [ # The person's locale preferences.
+ { # A person's locale preference.
+ "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.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "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.
+ "domain": "A String", # The domain name associated with the organization; for example,
+ # `google.com`.
+ "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`.
+ "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+ # month and day.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year by itself or a year and month where the day is not
+ # significant.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
+ "name": "A String", # The name of the organization.
+ "title": "A String", # The person's job title at the organization.
+ "type": "A String", # The type of the organization. The type can be custom or one of these
+ # predefined values:
+ #
+ # * `work`
+ # * `school`
+ "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
+ # symbol, abbreviation, or acronym.
+ "current": True or False, # True if the organization is the person's current organization;
+ # false if the organization is a past organization.
+ "jobDescription": "A String", # The person's job description at the organization.
+ "location": "A String", # The location of the organization office the person works at.
+ "department": "A String", # The person's department 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`.
+ "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+ # month and day.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year by itself or a year and month where the day is not
+ # significant.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
+ "phoneticName": "A String", # The phonetic name of the organization.
+ "metadata": { # Metadata about a field. # Metadata about the organization.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "userDefined": [ # The person's user defined data.
+ { # Arbitrary user data that is populated by the end users.
+ "key": "A String", # The end user specified key of the user defined data.
+ "value": "A String", # The end user specified value of the user defined data.
+ "metadata": { # Metadata about a field. # Metadata about the user defined data.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "biographies": [ # The person's biographies.
+ { # A person's short biography.
+ "contentType": "A String", # The content type of the biography.
+ "value": "A String", # The short biography.
+ "metadata": { # Metadata about a field. # Metadata about the biography.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "memberships": [ # The person's group memberships.
+ { # A person's membership in a group. Only contact group memberships can be
+ # modified.
+ "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
+ "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
+ "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
+ # string, in the form of `contactGroups/{contact_group_id}`.
+ # Only contact_group_resource_name can be used for modifying memberships.
+ # Any contact group membership can be removed, but only user group or
+ # "myContacts" or "starred" system groups memberships can be added. A
+ # contact must always have at least one contact group membership.
+ },
+ "domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.
+ "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
+ },
+ "metadata": { # Metadata about a field. # Metadata about the membership.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "taglines": [ # Output only. **DEPRECATED**: No data will be returned
+ # The person's taglines.
+ { # **DEPRECATED**: No data will be returned
+ # A brief one-line description of the person.
+ "value": "A String", # The tagline.
+ "metadata": { # Metadata about a field. # Metadata about the tagline.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "urls": [ # The person's associated URLs.
+ { # A person's associated URLs.
+ "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's
+ # account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the URL. The type can be custom or one of these predefined
+ # values:
+ #
+ # * `home`
+ # * `work`
+ # * `blog`
+ # * `profile`
+ # * `homePage`
+ # * `ftp`
+ # * `reservations`
+ # * `appInstallPage`: website for a Google+ application.
+ # * `other`
+ "value": "A String", # The URL.
+ "metadata": { # Metadata about a field. # Metadata about the URL.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead)
+ #
+ # The person's age range.
+ "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`
+ "value": "A String", # The gender for the person. The gender can be custom or one of these
+ # predefined values:
+ #
+ # * `male`
+ # * `female`
+ # * `unspecified`
+ "metadata": { # Metadata about a field. # Metadata about the gender.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "emailAddresses": [ # The person's email addresses.
+ { # A person's email address.
+ "formattedType": "A String", # Output only. The type of the email address translated and formatted in the
+ # viewer's account locale or the `Accept-Language` HTTP header locale.
+ "metadata": { # Metadata about a field. # Metadata about the email address.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ "displayName": "A String", # The display name of the email.
+ "value": "A String", # The 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`
+ },
+ ],
+ }</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.
+ "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
+ "photoBytes": "A String", # Required. Raw photo bytes
+ }
+
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -6347,7 +9029,9 @@
Returns:
An object of the form:
- { # Information about a person merged from various data sources such as the
+ { # 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
@@ -6356,7 +9040,7 @@
"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", # The read-only type of the SIP address translated and formatted in the
+ "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the
# viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the SIP address. The type can be custom or or one of these
# predefined values:
@@ -6370,7 +9054,7 @@
# format.
"metadata": { # Metadata about a field. # Metadata about the SIP address.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -6379,16 +9063,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -6396,32 +9080,14 @@
},
},
],
- "phoneNumbers": [ # The person's phone numbers.
- { # A person's phone number.
- "formattedType": "A String", # The read-only type of the phone number translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
- "canonicalForm": "A String", # The read-only 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.
- "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.
+ "braggingRights": [ # **DEPRECATED**: No data will be returned
+ # The person's bragging rights.
+ { # **DEPRECATED**: No data will be returned
+ # A person's bragging rights.
+ "value": "A String", # The bragging rights; for example, `climbed mount everest`.
+ "metadata": { # Metadata about a field. # Metadata about the bragging rights.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -6430,16 +9096,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -6450,7 +9116,7 @@
"addresses": [ # The person's street addresses.
{ # A person's physical address. May be a P.O. box or street address. All fields
# are optional.
- "formattedType": "A String", # The read-only type of the address translated and formatted in the viewer's
+ "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.
@@ -6471,7 +9137,7 @@
# * `other`
"metadata": { # Metadata about a field. # Metadata about the address.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -6480,16 +9146,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -6503,7 +9169,7 @@
"value": "A String", # The nickname.
"metadata": { # Metadata about a field. # Metadata about the nickname.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -6512,16 +9178,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -6534,7 +9200,7 @@
"value": "A String", # The occupation; for example, `carpenter`.
"metadata": { # Metadata about a field. # Metadata about the occupation.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -6543,16 +9209,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -6560,12 +9226,32 @@
},
},
],
- "braggingRights": [ # The person's bragging rights.
- { # 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.
+ "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.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -6574,16 +9260,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -6595,12 +9281,12 @@
{ # A person's name. If the name is a mononym, the family name is empty.
"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
- "phoneticFamilyName": "A String", # The family name spelled as it sounds.
- "displayName": "A String", # The read-only display name formatted according to the locale specified by
- # the viewer's account or the `Accept-Language` HTTP header.
- "displayNameLastFirst": "A String", # The read-only display name with the last name first formatted according to
+ "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.
+ "displayName": "A String", # Output only. The display name formatted according to the locale specified by
+ # the viewer's account or the `Accept-Language` HTTP header.
+ "phoneticFamilyName": "A String", # The family name spelled as it sounds.
"middleName": "A String", # The middle name(s).
"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
"familyName": "A String", # The family name.
@@ -6611,7 +9297,7 @@
"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
"metadata": { # Metadata about a field. # Metadata about the name.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -6620,16 +9306,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -6639,44 +9325,13 @@
],
"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/`<var>person_id</var>.
- "taglines": [ # The person's read-only taglines.
- { # A read-only brief one-line description of the person.
- "value": "A String", # The tagline.
- "metadata": { # Metadata about a field. # Metadata about the tagline.
- "source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # Last update timestamp of this source.
- "etag": "A String", # **Only populated in `person.metadata.sources`.**
- #
- # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
- #
- # Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
- "A String",
- ],
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
- },
- ],
- "ageRanges": [ # The person's read-only age ranges.
+ # `people/{person_id}`.
+ "ageRanges": [ # Output only. The person's age ranges.
{ # A person's age range.
"ageRange": "A String", # The age range.
"metadata": { # Metadata about a field. # Metadata about the age range.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -6685,16 +9340,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -6706,13 +9361,16 @@
{ # A person's birthday. At least one of the `date` and `text` fields are
# specified. The `date` and `text` fields typically represent the same
# date, but are not guaranteed to.
- "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the birthday.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
+ "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`.
"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
@@ -6724,7 +9382,7 @@
"text": "A String", # A free-form string representing the user's birthday.
"metadata": { # Metadata about a field. # Metadata about the birthday.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -6733,16 +9391,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -6752,10 +9410,11 @@
],
"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.
"metadata": { # Metadata about a field. # Metadata about the relation.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -6764,16 +9423,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -6796,15 +9455,16 @@
# * `assistant`
# * `referredBy`
# * `partner`
- "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account
- # locale or the locale specified in the Accept-Language HTTP header.
+ "person": "A String", # The name of the other person this relation refers to.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
# resource. Used for web cache validation.
- "relationshipStatuses": [ # The person's read-only relationship statuses.
- { # A person's read-only relationship status.
- "formattedValue": "A String", # The read-only value of the relationship status translated and formatted in
+ "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned
+ # The person's relationship statuses.
+ { # **DEPRECATED**: No data will be returned
+ # A person's relationship status.
+ "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in
# the viewer's account locale or the `Accept-Language` HTTP header locale.
"value": "A String", # The relationship status. The value can be custom or one of these
# predefined values:
@@ -6820,7 +9480,7 @@
# * `inCivilUnion`
"metadata": { # Metadata about a field. # Metadata about the relationship status.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -6829,16 +9489,47 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
+ },
+ ],
+ "skills": [ # The person's skills.
+ { # A skill that the person has.
+ "value": "A String", # The skill; for example, `underwater basket weaving`.
+ "metadata": { # Metadata about a field. # Metadata about the skill.
+ "source": { # The source of a field. # The source of the field.
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.**
+ #
+ # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
+ #
+ # Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -6849,7 +9540,7 @@
"imClients": [ # The person's instant messaging clients.
{ # A person's instant messaging client.
"username": "A String", # The user name used in the IM client.
- "formattedType": "A String", # The read-only type of the IM client translated and formatted in the
+ "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the
# viewer's account locale or the `Accept-Language` HTTP header locale.
"protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
# predefined values:
@@ -6863,7 +9554,7 @@
# * `icq`
# * `jabber`
# * `netMeeting`
- "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account
+ "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.
"type": "A String", # The type of the IM client. The type can be custom or one of these
# predefined values:
@@ -6873,7 +9564,7 @@
# * `other`
"metadata": { # Metadata about a field. # Metadata about the IM client.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -6882,16 +9573,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -6901,13 +9592,16 @@
],
"events": [ # The person's events.
{ # An event related to the person.
- "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the event.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
+ "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`.
"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
@@ -6916,7 +9610,7 @@
"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
# a year.
},
- "formattedType": "A String", # The read-only type of the event translated and formatted in the
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the
# viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the event. The type can be custom or one of these predefined
# values:
@@ -6925,7 +9619,7 @@
# * `other`
"metadata": { # Metadata about a field. # Metadata about the event.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -6934,16 +9628,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -6951,8 +9645,11 @@
},
},
],
- "metadata": { # The read-only metadata about a person. # Read-only metadata about the person.
- "previousResourceNames": [ # Any former resource names this person has had. Populated only for
+ "metadata": { # The metadata about a person. # Output only. Metadata about the person.
+ "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.
+ "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.
#
@@ -6961,9 +9658,12 @@
# profile URL.
"A String",
],
+ "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
+ "A String",
+ ],
"sources": [ # The sources of data for the person.
{ # The source of a field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -6972,23 +9672,17 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
],
- "linkedPeopleResourceNames": [ # Resource names of people linked to this resource.
- "A String",
- ],
- "deleted": True or False, # 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.
- "objectType": "A String", # **DEPRECATED** (Please use
+ "objectType": "A String", # Output only. **DEPRECATED** (Please use
# `person.metadata.sources.profileMetadata.objectType` instead)
#
# The type of the person object.
@@ -6998,7 +9692,7 @@
"value": "A String", # The interest; for example, `stargazing`.
"metadata": { # Metadata about a field. # Metadata about the interest.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -7007,16 +9701,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -7024,17 +9718,18 @@
},
},
],
- "photos": [ # The person's read-only photos.
- { # A person's read-only photo. A picture shown next to the person's name to
+ "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.
"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=`<var>size</var> at the end of the url. Example:
- # `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`
+ # 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
"metadata": { # Metadata about a field. # Metadata about the photo.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -7043,16 +9738,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -7067,7 +9762,7 @@
"value": "A String", # The address of the residence.
"metadata": { # Metadata about a field. # Metadata about the residence.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -7076,16 +9771,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -7093,11 +9788,13 @@
},
},
],
- "relationshipInterests": [ # The person's read-only relationship interests.
- { # A person's read-only relationship interest .
- "formattedValue": "A String", # 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.
+ "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned
+ # The person's relationship interests.
+ { # **DEPRECATED**: No data will be returned
+ # A person's relationship interest .
+ "formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted
+ # in the viewer's account locale or the locale specified in the
+ # Accept-Language HTTP header.
"value": "A String", # The kind of relationship the person is looking for. The value can be custom
# or one of these predefined values:
#
@@ -7107,7 +9804,7 @@
# * `networking`
"metadata": { # Metadata about a field. # Metadata about the relationship interest.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -7116,16 +9813,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -7133,15 +9830,15 @@
},
},
],
- "coverPhotos": [ # The person's read-only cover photos.
- { # A person's read-only cover photo. A large image shown on the person's
+ "coverPhotos": [ # Output only. The person's cover photos.
+ { # A person's cover photo. A large image shown on the person's
# profile page that represents who they are or what they care about.
"default": True or False, # True if the cover photo is the default cover photo;
# false if the cover photo is a user-provided cover photo.
"url": "A String", # The URL of the cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -7150,16 +9847,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -7173,7 +9870,7 @@
# language tag representing the locale.
"metadata": { # Metadata about a field. # Metadata about the locale.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -7182,16 +9879,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -7202,17 +9899,20 @@
"organizations": [ # The person's past or current organizations.
{ # A person's past or current organization. Overlapping date ranges are
# permitted.
- "formattedType": "A String", # The read-only type of the organization translated and formatted in the
+ "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.
"domain": "A String", # The domain name associated with the organization; for example,
# `google.com`.
- "endDate": { # Represents a whole calendar date, for example a date of birth. The time # The end date when the person left the organization.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
+ "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`.
"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
@@ -7235,13 +9935,16 @@
"jobDescription": "A String", # The person's job description at the organization.
"location": "A String", # The location of the organization office the person works at.
"department": "A String", # The person's department at the organization.
- "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
+ "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`.
"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
@@ -7253,7 +9956,7 @@
"phoneticName": "A String", # The phonetic name of the organization.
"metadata": { # Metadata about a field. # Metadata about the organization.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -7262,16 +9965,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -7285,7 +9988,7 @@
"value": "A String", # The end user specified value of the user defined data.
"metadata": { # Metadata about a field. # Metadata about the user defined data.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -7294,16 +9997,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -7317,7 +10020,7 @@
"value": "A String", # The short biography.
"metadata": { # Metadata about a field. # Metadata about the biography.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -7326,16 +10029,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -7347,20 +10050,20 @@
{ # A person's membership in a group. Only contact group memberships can be
# modified.
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
- "contactGroupId": "A String", # The read-only contact group ID for the contact group membership.
+ "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
- # string, in the form of `contactGroups/`<var>contact_group_id</var>.
+ # string, in the form of `contactGroups/{contact_group_id}`.
# Only contact_group_resource_name can be used for modifying memberships.
# Any contact group membership can be removed, but only user group or
# "myContacts" or "starred" system groups memberships can be added. A
# contact must always have at least one contact group membership.
},
- "domainMembership": { # A read-only G Suite Domain membership. # The read-only domain 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.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -7369,16 +10072,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -7386,12 +10089,14 @@
},
},
],
- "skills": [ # The person's skills.
- { # A skill that the person has.
- "value": "A String", # The skill; for example, `underwater basket weaving`.
- "metadata": { # Metadata about a field. # Metadata about the skill.
+ "taglines": [ # Output only. **DEPRECATED**: No data will be returned
+ # The person's taglines.
+ { # **DEPRECATED**: No data will be returned
+ # A brief one-line description of the person.
+ "value": "A String", # The tagline.
+ "metadata": { # Metadata about a field. # Metadata about the tagline.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -7400,16 +10105,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -7419,7 +10124,7 @@
],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
- "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's
+ "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's
# account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the URL. The type can be custom or one of these predefined
# values:
@@ -7436,7 +10141,7 @@
"value": "A String", # The URL.
"metadata": { # Metadata about a field. # Metadata about the URL.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -7445,16 +10150,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -7462,23 +10167,29 @@
},
},
],
- "ageRange": "A String", # **DEPRECATED** (Please use `person.ageRanges` instead)**
+ "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead)
#
- # The person's read-only age range.
+ # The person's age range.
"genders": [ # The person's genders.
{ # A person's gender.
- "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's
- # account locale or the `Accept-Language` HTTP header locale.
+ "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`
"value": "A String", # The gender for the person. The gender can be custom or one of these
# predefined values:
#
# * `male`
# * `female`
- # * `other`
- # * `unknown`
+ # * `unspecified`
"metadata": { # Metadata about a field. # Metadata about the gender.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -7487,16 +10198,16 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
@@ -7506,19 +10217,11 @@
],
"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`
- "formattedType": "A String", # The read-only type of the email address translated and formatted in the
+ "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.
- "displayName": "A String", # The display name of the email.
- "value": "A String", # The email address.
"metadata": { # Metadata about a field. # Metadata about the email address.
"source": { # The source of a field. # The source of the field.
- "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
#
# Last update timestamp of this source.
"etag": "A String", # **Only populated in `person.metadata.sources`.**
@@ -7527,24 +10230,33 @@
# source. Used for web cache validation.
"type": "A String", # The source type.
"id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
#
# Metadata about a source of type PROFILE.
- "userTypes": [ # The user types.
+ "userTypes": [ # Output only. The user types.
"A String",
],
- "objectType": "A String", # The profile object type.
+ "objectType": "A String", # Output only. The profile object type.
},
},
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
# verified field is typically a name, email address, phone number, or
# website that has been confirmed to be owned by the person.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
# field.
},
+ "displayName": "A String", # The display name of the email.
+ "value": "A String", # The 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`
},
],
- }</pre>
+ },
+ }</pre>
</div>
</body></html>
\ No newline at end of file