chore: update docs/dyn (#1106)
diff --git a/docs/dyn/people_v1.otherContacts.html b/docs/dyn/people_v1.otherContacts.html
index 6502fde..ecb3699 100644
--- a/docs/dyn/people_v1.otherContacts.html
+++ b/docs/dyn/people_v1.otherContacts.html
@@ -81,7 +81,7 @@
<code><a href="#copyOtherContactToMyContactsGroup">copyOtherContactToMyContactsGroup(resourceName, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Copies an "Other contact" to a new contact in the user's "myContacts" group</p>
<p class="toc_element">
- <code><a href="#list">list(requestSyncToken=None, readMask=None, pageSize=None, pageToken=None, syncToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(readMask=None, pageSize=None, syncToken=None, pageToken=None, requestSyncToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List all "Other contacts", that is contacts that are not in a contact group. "Other contacts" are typically auto created contacts from interactions.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -102,11 +102,11 @@
The object takes the form of:
{ # A request to copy an "Other contact" to my contacts group.
- "copyMask": "A String", # Required. A field mask to restrict which fields are copied into the new contact. Valid values are: * emailAddresses * names * phoneNumbers
"readMask": "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 the copy mask with metadata and membership fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
"sources": [ # Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
"A String",
],
+ "copyMask": "A String", # Required. A field mask to restrict which fields are copied into the new contact. Valid values are: * emailAddresses * names * phoneNumbers
}
x__xgafv: string, V1 error format.
@@ -118,575 +118,253 @@
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.
- "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
- "metadata": { # Metadata about a field. # Metadata about the SIP address.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
- "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- },
- ],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
"type": "A String", # The type of the URL. The type can be custom or one of these predefined values: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Currents application. * `other`
"value": "A String", # The URL.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the URL.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "skills": [ # The person's skills.
- { # A skill that the person has.
- "metadata": { # Metadata about a field. # Metadata about the skill.
- "source": { # The source of a field. # The source of the field.
"etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
"id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "value": "A String", # The skill; for example, `underwater basket weaving`.
},
],
- "genders": [ # The person's genders. This field is a singleton for contact sources.
- { # A person's gender.
- "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.
- "metadata": { # Metadata about a field. # Metadata about the gender.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be 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, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the event.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
- "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`
- },
- ],
- "nicknames": [ # The person's nicknames.
- { # A person's 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.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "type": "A String", # The type of the nickname.
- },
- ],
- "externalIds": [ # The person's external IDs.
- { # An identifier from an external entity related to the person.
- "value": "A String", # The value of the external ID.
"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
- "metadata": { # Metadata about a field. # Metadata about the external ID.
+ "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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be 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 .
- "metadata": { # Metadata about a field. # Metadata about the relationship interest.
- "source": { # The source of a field. # The source of the field.
"etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
"id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
- "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.
- },
- ],
- "phoneNumbers": [ # The person's phone numbers.
- { # A person's 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.
- "value": "A String", # 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`
- "metadata": { # Metadata about a field. # Metadata about the phone number.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "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.
- },
- ],
- "userDefined": [ # The person's user defined data.
- { # Arbitrary user data that is populated by the end users.
- "metadata": { # Metadata about a field. # Metadata about the user defined data.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The end user specified value of the user defined data.
- "key": "A String", # The end user specified key of the user defined data.
- },
- ],
- "braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.
- { # **DEPRECATED**: No data will be returned A person's bragging rights.
- "metadata": { # Metadata about a field. # Metadata about the bragging rights.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The bragging rights; for example, `climbed mount everest`.
- },
- ],
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
- "imClients": [ # The person's instant messaging clients.
- { # A person's instant messaging client.
- "metadata": { # Metadata about a field. # Metadata about the IM client.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
- "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "username": "A String", # The user name used in the IM client.
- },
- ],
- "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.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be 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.
- "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.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be 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`
- },
- ],
- "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
- { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current 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.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
},
],
"fileAses": [ # The person's file-ases.
{ # The name that should be used to sort the person in a list.
"value": "A String", # The file-as value
"metadata": { # Metadata about a field. # Metadata about the file-as.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be 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": [ # Output only. The person's age ranges.
- { # A person's age range.
- "metadata": { # Metadata about a field. # Metadata about the age range.
+ "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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "ageRange": "A String", # The age range.
- },
- ],
- "coverPhotos": [ # Output only. The person's cover photos.
- { # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
- "url": "A String", # The URL of the cover photo.
- "default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
- "metadata": { # Metadata about a field. # Metadata about the cover photo.
- "source": { # The source of a field. # The source of the field.
"etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
"id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be 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.
"locations": [ # The person's locations.
{ # A person's location.
- "deskCode": "A String", # The individual desk location.
- "value": "A String", # The free-form value of the location.
- "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
- "buildingId": "A String", # The building identifier.
- "floorSection": "A String", # The floor section in `floor_name`.
"floor": "A String", # The floor name or number.
- "current": True or False, # Whether the location is the current location.
+ "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
"metadata": { # Metadata about a field. # Metadata about the location.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be 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.
- "metadata": { # Metadata about a field. # Metadata about the occupation.
- "source": { # The source of a field. # The source of the field.
"etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
"id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "value": "A String", # The occupation; for example, `carpenter`.
- },
- ],
- "names": [ # The person's names. This field is a singleton for contact sources.
- { # A person's name. If the name is a mononym, the family name is empty.
- "givenName": "A String", # The given name.
- "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
- "metadata": { # Metadata about a field. # Metadata about the name.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "middleName": "A String", # The middle name(s).
- "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
- "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
- "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
- "familyName": "A String", # The family name.
- "phoneticFullName": "A String", # The full name spelled as it sounds.
- "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
- "phoneticGivenName": "A String", # The given name spelled as it sounds.
- "phoneticFamilyName": "A String", # The family name spelled as it sounds.
- "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
- "unstructuredName": "A String", # The free form name value.
- "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
- },
- ],
- "emailAddresses": [ # The person's email addresses.
- { # A person's email address.
- "displayName": "A String", # The display name of the email.
- "type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "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.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The email address.
- },
- ],
- "organizations": [ # The person's past or current organizations.
- { # A person's past or current organization. Overlapping date ranges are permitted.
- "name": "A String", # The name of the organization.
- "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
- "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.
- "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`
- "metadata": { # Metadata about a field. # Metadata about the organization.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The start date when the person joined the organization.
- "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- },
- "department": "A String", # The person's department at the organization.
- "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
- "location": "A String", # The location of the organization office the person works at.
- "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The end date when the person left the organization.
- "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- },
- "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.
- "phoneticName": "A String", # The phonetic name of the organization.
- },
- ],
- "calendarUrls": [ # The person's calendar URLs.
- { # A person's calendar URL.
- "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "url": "A String", # The calendar URL.
- "metadata": { # Metadata about a field. # Metadata about the calendar URL.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
+ "value": "A String", # The free-form value of the location.
+ "floorSection": "A String", # The floor section in `floor_name`.
+ "buildingId": "A String", # The building identifier.
+ "deskCode": "A String", # The individual desk location.
+ "current": True or False, # Whether the location is the current location.
},
],
"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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ },
+ ],
+ "genders": [ # The person's genders. This field is a singleton for contact sources.
+ { # A person's gender.
+ "metadata": { # Metadata about a field. # Metadata about the gender.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "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`
+ },
+ ],
+ "userDefined": [ # The person's user defined data.
+ { # Arbitrary user data that is populated by the end users.
+ "value": "A String", # The end user specified value of the user defined data.
+ "key": "A String", # The end user specified key of the user defined data.
+ "metadata": { # Metadata about a field. # Metadata about the user defined data.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ },
+ ],
+ "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.
+ "type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
+ "metadata": { # Metadata about a field. # Metadata about the relation.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the 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.
+ },
+ ],
+ "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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ },
+ ],
+ "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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
@@ -695,282 +373,604 @@
"contentType": "A String", # The content type of the biography.
"value": "A String", # The short biography.
"metadata": { # Metadata about a field. # Metadata about the biography.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be 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}`.
- "miscKeywords": [ # The person's miscellaneous keywords.
- { # A person's miscellaneous keyword.
- "formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "type": "A String", # The miscellaneous keyword type.
- "metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
+ "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`
+ "displayName": "A String", # The display name of the email.
+ "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.
+ "value": "A String", # The email address.
+ "metadata": { # Metadata about a field. # Metadata about the email address.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The value of the miscellaneous keyword.
- },
- ],
- "events": [ # The person's events.
- { # An event related to the person.
- "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the event.
- "source": { # The source of a field. # The source of the field.
"etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
"id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the event.
- "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- },
- "type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`
- },
- ],
- "memberships": [ # The person's group memberships.
- { # A person's membership in a group. Only contact group memberships can be modified.
- "domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.
- "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
- },
- "metadata": { # Metadata about a field. # Metadata about the membership.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
- "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
- "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
- },
- },
- ],
- "addresses": [ # The person's street addresses.
- { # A person's physical address. May be a P.O. box or street address. All fields are optional.
- "type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
- "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "city": "A String", # The city of the address.
- "country": "A String", # The country of the address.
- "metadata": { # Metadata about a field. # Metadata about the address.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "postalCode": "A String", # The postal code of the address.
- "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
- "poBox": "A String", # The P.O. box of the address.
- "streetAddress": "A String", # The street address.
- "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
- "region": "A String", # The region of the address; for example, the state or province.
},
],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
- "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
- "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
"metadata": { # Metadata about a field. # Metadata about the photo.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
+ "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
+ },
+ ],
+ "sipAddresses": [ # The person's SIP addresses.
+ { # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
+ "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
+ "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
+ "metadata": { # Metadata about a field. # Metadata about the SIP address.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"clientData": [ # The person's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"metadata": { # Metadata about a field. # Metadata about the client data.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
"key": "A String", # The client specified key of the client data.
"value": "A String", # The client specified value of the client data.
},
],
- "interests": [ # The person's interests.
- { # One of the person's interests.
- "metadata": { # Metadata about a field. # Metadata about the interest.
+ "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
+ { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
+ "metadata": { # Metadata about a field. # Metadata about the residence.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "value": "A String", # The interest; for example, `stargazing`.
+ "value": "A String", # The address of the residence.
+ "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
},
],
- "birthdays": [ # The person's birthdays. This field is a singleton for contact sources.
- { # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.
- "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the birthday.
- "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- },
- "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "names": [ # The person's names. This field is a singleton for contact sources.
+ { # A person's name. If the name is a mononym, the family name is empty.
+ "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
+ "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
+ "phoneticFamilyName": "A String", # The family name spelled as it sounds.
+ "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
+ "familyName": "A String", # The family name.
+ "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
+ "unstructuredName": "A String", # The free form name value.
+ "metadata": { # Metadata about a field. # Metadata about the name.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "text": "A String", # A free-form string representing the user's birthday.
+ "phoneticGivenName": "A String", # The given name spelled as it sounds.
+ "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
+ "phoneticFullName": "A String", # The full name spelled as it sounds.
+ "middleName": "A String", # The middle name(s).
+ "givenName": "A String", # The given name.
+ "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
+ "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
+ },
+ ],
+ "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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
},
],
"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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "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.
},
],
+ "imClients": [ # The person's instant messaging clients.
+ { # A person's instant messaging client.
+ "username": "A String", # The user name used in the IM client.
+ "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "metadata": { # Metadata about a field. # Metadata about the IM client.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "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.
+ "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
+ },
+ ],
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
+ "phoneNumbers": [ # The person's phone numbers.
+ { # A person's phone number.
+ "type": "A String", # The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
+ "value": "A String", # The phone number.
+ "canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
+ "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "metadata": { # Metadata about a field. # Metadata about the phone number.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ },
+ ],
+ "externalIds": [ # The person's external IDs.
+ { # An identifier from an external entity related to the person.
+ "value": "A String", # The value of the external ID.
+ "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "metadata": { # Metadata about a field. # Metadata about the external ID.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ },
+ ],
+ "calendarUrls": [ # The person's calendar URLs.
+ { # A person's calendar URL.
+ "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "metadata": { # Metadata about a field. # Metadata about the calendar URL.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "url": "A String", # The calendar URL.
+ "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
+ },
+ ],
+ "miscKeywords": [ # The person's miscellaneous keywords.
+ { # A person's miscellaneous keyword.
+ "value": "A String", # The value of the miscellaneous keyword.
+ "metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The miscellaneous keyword type.
+ },
+ ],
+ "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}`.
+ "interests": [ # The person's interests.
+ { # One of the person's interests.
+ "metadata": { # Metadata about a field. # Metadata about the interest.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "value": "A String", # The interest; for example, `stargazing`.
+ },
+ ],
+ "organizations": [ # The person's past or current organizations.
+ { # A person's past or current organization. Overlapping date ranges are permitted.
+ "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
+ "location": "A String", # The location of the organization office the person works at.
+ "phoneticName": "A String", # The phonetic name of the organization.
+ "metadata": { # Metadata about a field. # Metadata about the organization.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
+ "formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "department": "A String", # The person's department at the organization.
+ "jobDescription": "A String", # The person's job description at the organization.
+ "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The start date when the person joined the organization.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
+ "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
+ "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The end date when the person left the organization.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
+ "name": "A String", # The name of the organization.
+ "title": "A String", # The person's job title at the organization.
+ "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
+ },
+ ],
+ "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.
+ },
+ "metadata": { # Metadata about a field. # Metadata about the membership.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "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.
+ },
+ },
+ ],
+ "coverPhotos": [ # Output only. The person's cover photos.
+ { # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
+ "url": "A String", # The URL of the cover photo.
+ "metadata": { # Metadata about a field. # Metadata about the cover photo.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "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.
+ },
+ ],
+ "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
"metadata": { # The metadata about a person. # Output only. Metadata about the person.
- "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
- "A String",
- ],
- "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
- "A String",
- ],
"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
+ "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
"sources": [ # The sources of data for the person.
{ # The source of a field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
},
],
- "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
+ "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
+ "A String",
+ ],
+ "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",
+ ],
},
+ "addresses": [ # The person's street addresses.
+ { # A person's physical address. May be a P.O. box or street address. All fields are optional.
+ "region": "A String", # The region of the address; for example, the state or province.
+ "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
+ "metadata": { # Metadata about a field. # Metadata about the address.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "streetAddress": "A String", # The street address.
+ "city": "A String", # The city of the address.
+ "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
+ "postalCode": "A String", # The postal code of the address.
+ "poBox": "A String", # The P.O. box 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`
+ "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.
+ "country": "A String", # The country of the address.
+ },
+ ],
+ "birthdays": [ # The person's birthdays. This field is a singleton for contact sources.
+ { # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.
+ "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the birthday.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
+ "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "text": "A String", # A free-form string representing the user's birthday.
+ },
+ ],
+ "ageRanges": [ # Output only. The person's age ranges.
+ { # A person's age range.
+ "metadata": { # Metadata about a field. # Metadata about the age range.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "ageRange": "A String", # The age range.
+ },
+ ],
+ "occupations": [ # The person's occupations.
+ { # A person's occupation.
+ "metadata": { # Metadata about a field. # Metadata about the occupation.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "value": "A String", # The occupation; for example, `carpenter`.
+ },
+ ],
+ "nicknames": [ # The person's nicknames.
+ { # A person's nickname.
+ "metadata": { # Metadata about a field. # Metadata about the nickname.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "value": "A String", # The nickname.
+ "type": "A String", # The type of the nickname.
+ },
+ ],
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(requestSyncToken=None, readMask=None, pageSize=None, pageToken=None, syncToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(readMask=None, pageSize=None, syncToken=None, pageToken=None, requestSyncToken=None, x__xgafv=None)</code>
<pre>List all "Other contacts", that is contacts that are not in a contact group. "Other contacts" are typically auto created contacts from interactions.
Args:
- requestSyncToken: boolean, Optional. Whether the response should include `next_sync_token`, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead. Initial sync requests that specify `request_sync_token` have an additional rate limit.
readMask: string, Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * emailAddresses * names * phoneNumbers
pageSize: integer, Optional. The number of "Other contacts" to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.
- pageToken: string, Optional. A page token, received from a previous `ListOtherContacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListOtherContacts` must match the call that provided the page token.
syncToken: string, Optional. A sync token, received from a previous `ListOtherContacts` call. Provide this to retrieve only the resources changed since the last request. Sync requests that specify `sync_token` have an additional rate limit. When syncing, all other parameters provided to `ListOtherContacts` must match the call that provided the sync token.
+ pageToken: string, Optional. A page token, received from a previous `ListOtherContacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListOtherContacts` must match the call that provided the page token.
+ requestSyncToken: boolean, Optional. Whether the response should include `next_sync_token`, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead. Initial sync requests that specify `request_sync_token` have an additional rate limit.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -980,579 +980,256 @@
An object of the form:
{ # The response to a request for the authenticated user's "Other contacts".
- "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"nextSyncToken": "A String", # A token, which can be sent as `sync_token` to retrieve changes since the last request. Request must set `request_sync_token` to return the sync token.
"otherContacts": [ # The list of "Other contacts" returned as Person resources. "Other contacts" support a limited subset of fields. See ListOtherContactsRequest.request_mask for more detailed information.
{ # 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.
- "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
- "metadata": { # Metadata about a field. # Metadata about the SIP address.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
- "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- },
- ],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
"type": "A String", # The type of the URL. The type can be custom or one of these predefined values: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Currents application. * `other`
"value": "A String", # The URL.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the URL.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- },
- ],
- "skills": [ # The person's skills.
- { # A skill that the person has.
- "metadata": { # Metadata about a field. # Metadata about the skill.
- "source": { # The source of a field. # The source of the field.
"etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
"id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "value": "A String", # The skill; for example, `underwater basket weaving`.
},
],
- "genders": [ # The person's genders. This field is a singleton for contact sources.
- { # A person's gender.
- "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.
- "metadata": { # Metadata about a field. # Metadata about the gender.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be 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, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the event.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
- "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`
- },
- ],
- "nicknames": [ # The person's nicknames.
- { # A person's 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.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "type": "A String", # The type of the nickname.
- },
- ],
- "externalIds": [ # The person's external IDs.
- { # An identifier from an external entity related to the person.
- "value": "A String", # The value of the external ID.
"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
- "metadata": { # Metadata about a field. # Metadata about the external ID.
+ "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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be 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 .
- "metadata": { # Metadata about a field. # Metadata about the relationship interest.
- "source": { # The source of a field. # The source of the field.
"etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
"id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
- "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.
- },
- ],
- "phoneNumbers": [ # The person's phone numbers.
- { # A person's 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.
- "value": "A String", # 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`
- "metadata": { # Metadata about a field. # Metadata about the phone number.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "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.
- },
- ],
- "userDefined": [ # The person's user defined data.
- { # Arbitrary user data that is populated by the end users.
- "metadata": { # Metadata about a field. # Metadata about the user defined data.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The end user specified value of the user defined data.
- "key": "A String", # The end user specified key of the user defined data.
- },
- ],
- "braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.
- { # **DEPRECATED**: No data will be returned A person's bragging rights.
- "metadata": { # Metadata about a field. # Metadata about the bragging rights.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The bragging rights; for example, `climbed mount everest`.
- },
- ],
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
- "imClients": [ # The person's instant messaging clients.
- { # A person's instant messaging client.
- "metadata": { # Metadata about a field. # Metadata about the IM client.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
- "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "username": "A String", # The user name used in the IM client.
- },
- ],
- "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.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be 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.
- "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.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be 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`
- },
- ],
- "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
- { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current 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.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
},
],
"fileAses": [ # The person's file-ases.
{ # The name that should be used to sort the person in a list.
"value": "A String", # The file-as value
"metadata": { # Metadata about a field. # Metadata about the file-as.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be 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": [ # Output only. The person's age ranges.
- { # A person's age range.
- "metadata": { # Metadata about a field. # Metadata about the age range.
+ "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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "ageRange": "A String", # The age range.
- },
- ],
- "coverPhotos": [ # Output only. The person's cover photos.
- { # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
- "url": "A String", # The URL of the cover photo.
- "default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
- "metadata": { # Metadata about a field. # Metadata about the cover photo.
- "source": { # The source of a field. # The source of the field.
"etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
"id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be 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.
"locations": [ # The person's locations.
{ # A person's location.
- "deskCode": "A String", # The individual desk location.
- "value": "A String", # The free-form value of the location.
- "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
- "buildingId": "A String", # The building identifier.
- "floorSection": "A String", # The floor section in `floor_name`.
"floor": "A String", # The floor name or number.
- "current": True or False, # Whether the location is the current location.
+ "type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
"metadata": { # Metadata about a field. # Metadata about the location.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be 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.
- "metadata": { # Metadata about a field. # Metadata about the occupation.
- "source": { # The source of a field. # The source of the field.
"etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
"id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "value": "A String", # The occupation; for example, `carpenter`.
- },
- ],
- "names": [ # The person's names. This field is a singleton for contact sources.
- { # A person's name. If the name is a mononym, the family name is empty.
- "givenName": "A String", # The given name.
- "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
- "metadata": { # Metadata about a field. # Metadata about the name.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "middleName": "A String", # The middle name(s).
- "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
- "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
- "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
- "familyName": "A String", # The family name.
- "phoneticFullName": "A String", # The full name spelled as it sounds.
- "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
- "phoneticGivenName": "A String", # The given name spelled as it sounds.
- "phoneticFamilyName": "A String", # The family name spelled as it sounds.
- "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
- "unstructuredName": "A String", # The free form name value.
- "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
- },
- ],
- "emailAddresses": [ # The person's email addresses.
- { # A person's email address.
- "displayName": "A String", # The display name of the email.
- "type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "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.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The email address.
- },
- ],
- "organizations": [ # The person's past or current organizations.
- { # A person's past or current organization. Overlapping date ranges are permitted.
- "name": "A String", # The name of the organization.
- "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
- "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.
- "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`
- "metadata": { # Metadata about a field. # Metadata about the organization.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The start date when the person joined the organization.
- "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- },
- "department": "A String", # The person's department at the organization.
- "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
- "location": "A String", # The location of the organization office the person works at.
- "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The end date when the person left the organization.
- "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- },
- "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.
- "phoneticName": "A String", # The phonetic name of the organization.
- },
- ],
- "calendarUrls": [ # The person's calendar URLs.
- { # A person's calendar URL.
- "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "url": "A String", # The calendar URL.
- "metadata": { # Metadata about a field. # Metadata about the calendar URL.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
+ "value": "A String", # The free-form value of the location.
+ "floorSection": "A String", # The floor section in `floor_name`.
+ "buildingId": "A String", # The building identifier.
+ "deskCode": "A String", # The individual desk location.
+ "current": True or False, # Whether the location is the current location.
},
],
"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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ },
+ ],
+ "genders": [ # The person's genders. This field is a singleton for contact sources.
+ { # A person's gender.
+ "metadata": { # Metadata about a field. # Metadata about the gender.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "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`
+ },
+ ],
+ "userDefined": [ # The person's user defined data.
+ { # Arbitrary user data that is populated by the end users.
+ "value": "A String", # The end user specified value of the user defined data.
+ "key": "A String", # The end user specified key of the user defined data.
+ "metadata": { # Metadata about a field. # Metadata about the user defined data.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ },
+ ],
+ "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.
+ "type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
+ "metadata": { # Metadata about a field. # Metadata about the relation.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the 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.
+ },
+ ],
+ "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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ },
+ ],
+ "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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
@@ -1561,271 +1238,594 @@
"contentType": "A String", # The content type of the biography.
"value": "A String", # The short biography.
"metadata": { # Metadata about a field. # Metadata about the biography.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be 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}`.
- "miscKeywords": [ # The person's miscellaneous keywords.
- { # A person's miscellaneous keyword.
- "formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "type": "A String", # The miscellaneous keyword type.
- "metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
+ "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`
+ "displayName": "A String", # The display name of the email.
+ "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.
+ "value": "A String", # The email address.
+ "metadata": { # Metadata about a field. # Metadata about the email address.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "value": "A String", # The value of the miscellaneous keyword.
- },
- ],
- "events": [ # The person's events.
- { # An event related to the person.
- "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "metadata": { # Metadata about a field. # Metadata about the event.
- "source": { # The source of a field. # The source of the field.
"etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
"id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the event.
- "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- },
- "type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`
- },
- ],
- "memberships": [ # The person's group memberships.
- { # A person's membership in a group. Only contact group memberships can be modified.
- "domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.
- "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
- },
- "metadata": { # Metadata about a field. # Metadata about the membership.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
- "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
- "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
- },
- },
- ],
- "addresses": [ # The person's street addresses.
- { # A person's physical address. May be a P.O. box or street address. All fields are optional.
- "type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
- "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
- "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
- "city": "A String", # The city of the address.
- "country": "A String", # The country of the address.
- "metadata": { # Metadata about a field. # Metadata about the address.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
- "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
- "userTypes": [ # Output only. The user types.
- "A String",
- ],
- "objectType": "A String", # Output only. The profile object type.
- },
- "id": "A String", # The unique identifier within the source type generated by the server.
- "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
- },
- "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
- },
- "postalCode": "A String", # The postal code of the address.
- "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
- "poBox": "A String", # The P.O. box of the address.
- "streetAddress": "A String", # The street address.
- "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
- "region": "A String", # The region of the address; for example, the state or province.
},
],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
- "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
- "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
"metadata": { # Metadata about a field. # Metadata about the photo.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
+ "default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
+ },
+ ],
+ "sipAddresses": [ # The person's SIP addresses.
+ { # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
+ "type": "A String", # The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
+ "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
+ "metadata": { # Metadata about a field. # Metadata about the SIP address.
"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"clientData": [ # The person's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"metadata": { # Metadata about a field. # Metadata about the client data.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
"key": "A String", # The client specified key of the client data.
"value": "A String", # The client specified value of the client data.
},
],
- "interests": [ # The person's interests.
- { # One of the person's interests.
- "metadata": { # Metadata about a field. # Metadata about the interest.
+ "residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
+ { # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
+ "metadata": { # Metadata about a field. # Metadata about the residence.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "value": "A String", # The interest; for example, `stargazing`.
+ "value": "A String", # The address of the residence.
+ "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
},
],
- "birthdays": [ # The person's birthdays. This field is a singleton for contact sources.
- { # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.
- "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the birthday.
- "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- },
- "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "names": [ # The person's names. This field is a singleton for contact sources.
+ { # A person's name. If the name is a mononym, the family name is empty.
+ "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
+ "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
+ "phoneticFamilyName": "A String", # The family name spelled as it sounds.
+ "displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
+ "familyName": "A String", # The family name.
+ "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
+ "unstructuredName": "A String", # The free form name value.
+ "metadata": { # Metadata about a field. # Metadata about the name.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "text": "A String", # A free-form string representing the user's birthday.
+ "phoneticGivenName": "A String", # The given name spelled as it sounds.
+ "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
+ "phoneticFullName": "A String", # The full name spelled as it sounds.
+ "middleName": "A String", # The middle name(s).
+ "givenName": "A String", # The given name.
+ "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
+ "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
+ },
+ ],
+ "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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
},
],
"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.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
"source": { # The source of a field. # The source of the field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
},
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
},
- "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.
},
],
+ "imClients": [ # The person's instant messaging clients.
+ { # A person's instant messaging client.
+ "username": "A String", # The user name used in the IM client.
+ "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "metadata": { # Metadata about a field. # Metadata about the IM client.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "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.
+ "type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
+ "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
+ },
+ ],
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
+ "phoneNumbers": [ # The person's phone numbers.
+ { # A person's phone number.
+ "type": "A String", # The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
+ "value": "A String", # The phone number.
+ "canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
+ "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "metadata": { # Metadata about a field. # Metadata about the phone number.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ },
+ ],
+ "externalIds": [ # The person's external IDs.
+ { # An identifier from an external entity related to the person.
+ "value": "A String", # The value of the external ID.
+ "type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
+ "formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "metadata": { # Metadata about a field. # Metadata about the external ID.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ },
+ ],
+ "calendarUrls": [ # The person's calendar URLs.
+ { # A person's calendar URL.
+ "formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "metadata": { # Metadata about a field. # Metadata about the calendar URL.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "url": "A String", # The calendar URL.
+ "type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
+ },
+ ],
+ "miscKeywords": [ # The person's miscellaneous keywords.
+ { # A person's miscellaneous keyword.
+ "value": "A String", # The value of the miscellaneous keyword.
+ "metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The miscellaneous keyword type.
+ },
+ ],
+ "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}`.
+ "interests": [ # The person's interests.
+ { # One of the person's interests.
+ "metadata": { # Metadata about a field. # Metadata about the interest.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "value": "A String", # The interest; for example, `stargazing`.
+ },
+ ],
+ "organizations": [ # The person's past or current organizations.
+ { # A person's past or current organization. Overlapping date ranges are permitted.
+ "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
+ "location": "A String", # The location of the organization office the person works at.
+ "phoneticName": "A String", # The phonetic name of the organization.
+ "metadata": { # Metadata about a field. # Metadata about the organization.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
+ "formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+ "department": "A String", # The person's department at the organization.
+ "jobDescription": "A String", # The person's job description at the organization.
+ "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The start date when the person joined the organization.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
+ "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
+ "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The end date when the person left the organization.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
+ "name": "A String", # The name of the organization.
+ "title": "A String", # The person's job title at the organization.
+ "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
+ },
+ ],
+ "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.
+ },
+ "metadata": { # Metadata about a field. # Metadata about the membership.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "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.
+ },
+ },
+ ],
+ "coverPhotos": [ # Output only. The person's cover photos.
+ { # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
+ "url": "A String", # The URL of the cover photo.
+ "metadata": { # Metadata about a field. # Metadata about the cover photo.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "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.
+ },
+ ],
+ "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
"metadata": { # The metadata about a person. # Output only. Metadata about the person.
- "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
- "A String",
- ],
- "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
- "A String",
- ],
"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
+ "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
"sources": [ # The sources of data for the person.
{ # The source of a field.
- "etag": "A String", # **Only 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.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"userTypes": [ # Output only. The user types.
"A String",
],
"objectType": "A String", # Output only. The profile object type.
},
- "id": "A String", # The unique identifier within the source type generated by the server.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
},
],
- "objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
+ "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
+ "A String",
+ ],
+ "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",
+ ],
},
+ "addresses": [ # The person's street addresses.
+ { # A person's physical address. May be a P.O. box or street address. All fields are optional.
+ "region": "A String", # The region of the address; for example, the state or province.
+ "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
+ "metadata": { # Metadata about a field. # Metadata about the address.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "streetAddress": "A String", # The street address.
+ "city": "A String", # The city of the address.
+ "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
+ "postalCode": "A String", # The postal code of the address.
+ "poBox": "A String", # The P.O. box 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`
+ "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.
+ "country": "A String", # The country of the address.
+ },
+ ],
+ "birthdays": [ # The person's birthdays. This field is a singleton for contact sources.
+ { # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.
+ "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the birthday.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
+ "metadata": { # Metadata about a field. # Metadata about the birthday.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "text": "A String", # A free-form string representing the user's birthday.
+ },
+ ],
+ "ageRanges": [ # Output only. The person's age ranges.
+ { # A person's age range.
+ "metadata": { # Metadata about a field. # Metadata about the age range.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "ageRange": "A String", # The age range.
+ },
+ ],
+ "occupations": [ # The person's occupations.
+ { # A person's occupation.
+ "metadata": { # Metadata about a field. # Metadata about the occupation.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "value": "A String", # The occupation; for example, `carpenter`.
+ },
+ ],
+ "nicknames": [ # The person's nicknames.
+ { # A person's nickname.
+ "metadata": { # Metadata about a field. # Metadata about the nickname.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+ "source": { # The source of a field. # The source of the field.
+ "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
+ "userTypes": [ # Output only. The user types.
+ "A String",
+ ],
+ "objectType": "A String", # Output only. The profile object type.
+ },
+ "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
+ "etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "type": "A String", # The source type.
+ },
+ "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+ },
+ "value": "A String", # The nickname.
+ "type": "A String", # The type of the nickname.
+ },
+ ],
},
],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>