Returns the connections Resource.
batchCreateContacts(body=None, x__xgafv=None)
Create a batch of new contacts and return the PersonResponses for the newly Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
batchDeleteContacts(body=None, x__xgafv=None)
Delete a batch of contacts. Any non-contact data will not be deleted. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
batchUpdateContacts(body=None, x__xgafv=None)
Update a batch of contacts and return a map of resource names to PersonResponses for the updated contacts. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
Close httplib2 connections.
createContact(body=None, personFields=None, sources=None, x__xgafv=None)
Create a new contact and return the person resource for that contact. The request returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
deleteContact(resourceName, x__xgafv=None)
Delete a contact person. Any non-contact data will not be deleted. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
deleteContactPhoto(resourceName, personFields=None, sources=None, x__xgafv=None)
Delete a contact's photo. Mutate requests for the same user should be done sequentially to avoid // lock contention.
get(resourceName, personFields=None, requestMask_includeField=None, sources=None, x__xgafv=None)
Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.
Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.
Provides a list of domain profiles and domain contacts in the authenticated user's domain directory. When the `sync_token` is specified, resources deleted since the last sync will be returned as a person with `PersonMetadata.deleted` set to true. When the `page_token` or `sync_token` is specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at [List the directory people that have changed](/people/v1/directory#list_the_directory_people_that_have_changed).
Retrieves the next page of results.
searchContacts(pageSize=None, query=None, readMask=None, sources=None, x__xgafv=None)
Provides a list of contacts in the authenticated user's grouped contacts that matches the search query. The query matches on a contact's `names`, `nickNames`, `emailAddresses`, `phoneNumbers`, and `organizations` fields that are from the CONTACT source. **IMPORTANT**: Before searching, clients should send a warmup request with an empty query to update the cache. See https://developers.google.com/people/v1/contacts#search_the_users_contacts
Provides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query.
Retrieves the next page of results.
Update contact data for an existing contact person. Any non-contact data will not be modified. Any non-contact data in the person to update will be ignored. All fields specified in the `update_mask` will be replaced. The server returns a 400 error if `person.metadata.sources` is not specified for the contact to be updated or if there is no contact source. The server returns a 400 error with reason `"failedPrecondition"` if `person.metadata.sources.etag` is different than the contact's etag, which indicates the contact has changed since its data was read. Clients should get the latest person and merge their updates into the latest person. The server returns a 400 error if `memberships` are being updated and there are no contact group memberships specified on the person. The server returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
updateContactPhoto(resourceName, body=None, x__xgafv=None)
Update a contact's photo. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
batchCreateContacts(body=None, x__xgafv=None)
Create a batch of new contacts and return the PersonResponses for the newly Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
Args:
body: object, The request body.
The object takes the form of:
{ # A request to create a batch of contacts.
"contacts": [ # Required. The contact to create. Allows up to 200 contacts in a single request.
{ # A wrapper that contains the person data to populate a newly created source.
"contactPerson": { # 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. # Required. The person data to populate a newly created source.
"addresses": [ # The person's street addresses.
{ # A person's physical address. May be a P.O. box or street address. All fields are optional.
"city": "A String", # The city of the address.
"country": "A String", # The country of the address.
"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
"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.
"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.
"metadata": { # Metadata about a field. # Metadata about the address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"poBox": "A String", # The P.O. box of the address.
"postalCode": "A String", # The postal code of the address.
"region": "A String", # The region of the address; for example, the state or province.
"streetAddress": "A String", # The street address.
"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
},
],
"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
"ageRanges": [ # Output only. The person's age ranges.
{ # A person's age range.
"ageRange": "A String", # The age range.
"metadata": { # Metadata about a field. # Metadata about the age range.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"biographies": [ # The person's biographies. This field is a singleton for contact sources.
{ # A person's short biography.
"contentType": "A String", # The content type of the biography.
"metadata": { # Metadata about a field. # Metadata about the biography.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 short biography.
},
],
"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. Clients should always set the `date` field when mutating birthdays.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The structured 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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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", # Prefer to use the `date` field if set. A free-form string representing the user's birthday. This value is not validated.
},
],
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 bragging rights; for example, `climbed mount everest`.
},
],
"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, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
"url": "A String", # The calendar URL.
},
],
"clientData": [ # The person's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"metadata": { # Metadata about a field. # Metadata about the client data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 client specified value of the client data.
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 cover photo.
},
],
"emailAddresses": [ # The person's email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.
{ # A person's email address.
"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.
"metadata": { # Metadata about a field. # Metadata about the email address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
"value": "A String", # The email address.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 event. The type can be custom or one of these predefined values: * `anniversary` * `other`
},
],
"externalIds": [ # The person's external IDs.
{ # An identifier from an external entity 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 external ID.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
"value": "A String", # The value of the external ID.
},
],
"fileAses": [ # The person's file-ases.
{ # The name that should be used to sort the person in a list.
"metadata": { # Metadata about a field. # Metadata about the file-as.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 file-as value
},
],
"genders": [ # The person's genders. This field is a singleton for contact sources.
{ # A person's gender.
"addressMeAs": "A String", # Free form text field for pronouns that should be used to address the person. Common values are: * `he`/`him` * `she`/`her` * `they`/`them`
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
},
],
"imClients": [ # The person's instant messaging clients.
{ # A person's instant messaging client.
"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the IM client.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"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`
"username": "A String", # The user name used in the IM client.
},
],
"interests": [ # The person's interests.
{ # One of the person's interests.
"metadata": { # Metadata about a field. # Metadata about the interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"locales": [ # The person's locale preferences.
{ # A person's locale preference.
"metadata": { # Metadata about a field. # Metadata about the locale.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
},
],
"locations": [ # The person's locations.
{ # A person's location.
"buildingId": "A String", # The building identifier.
"current": True or False, # Whether the location is the current location.
"deskCode": "A String", # The individual desk location.
"floor": "A String", # The floor name or number.
"floorSection": "A String", # The floor section in `floor_name`.
"metadata": { # Metadata about a field. # Metadata about the location.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
"value": "A String", # The free-form value of the location.
},
],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
},
"domainMembership": { # A Google Workspace Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's Google Workspace domain.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"metadata": { # The metadata about a person. # Output only. Metadata about the person.
"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.
"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
"A String",
],
"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for `people.connections.list` requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
"A String",
],
"sources": [ # The sources of data for the person.
{ # The source of a field.
"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
],
},
"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.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 miscellaneous keyword type.
"value": "A String", # The value of the miscellaneous keyword.
},
],
"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.
"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.
"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.
"familyName": "A String", # The family name.
"givenName": "A String", # The given name.
"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
"metadata": { # Metadata about a field. # Metadata about the name.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"middleName": "A String", # The middle name(s).
"phoneticFamilyName": "A String", # The family name spelled as it sounds.
"phoneticFullName": "A String", # The full name spelled as it sounds.
"phoneticGivenName": "A String", # The given name spelled as it sounds.
"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
"unstructuredName": "A String", # The free form name value.
},
],
"nicknames": [ # The person's nicknames.
{ # A person's nickname.
"metadata": { # Metadata about a field. # Metadata about the nickname.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 nickname.
"value": "A String", # The nickname.
},
],
"occupations": [ # The person's occupations.
{ # A person's occupation.
"metadata": { # Metadata about a field. # Metadata about the occupation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"organizations": [ # The person's past or current organizations.
{ # A person's past or current organization. Overlapping date ranges are permitted.
"costCenter": "A String", # The person's cost center 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.
"department": "A String", # The person's department at the organization.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
"fullTimeEquivalentMillipercent": 42, # The person's full-time equivalent millipercent within the organization (100000 = 100%).
"jobDescription": "A String", # The person's job description at the organization.
"location": "A String", # The location of the organization office the person works at.
"metadata": { # Metadata about a field. # Metadata about the organization.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"name": "A String", # The name of the organization.
"phoneticName": "A String", # The phonetic name of 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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
"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`
},
],
"phoneNumbers": [ # The person's phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.
{ # A person's phone number.
"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the phone number.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
"metadata": { # Metadata about a field. # Metadata about the photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the 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`
},
],
"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
{ # **DEPRECATED**: No data will be returned A person's relationship interest .
"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relationship interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
{ # **DEPRECATED**: No data will be returned A person's relationship status.
"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the relationship status.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
},
],
"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
"metadata": { # Metadata about a field. # Metadata about the residence.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 address of the residence.
},
],
"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`.
"sipAddresses": [ # The person's SIP addresses.
{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the SIP address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"skills": [ # The person's skills.
{ # A skill that the person has.
"metadata": { # Metadata about a field. # Metadata about the skill.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 skill; for example, `underwater basket weaving`.
},
],
"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.
"metadata": { # Metadata about a field. # Metadata about the tagline.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 tagline.
},
],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the URL.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"userDefined": [ # The person's user defined data.
{ # Arbitrary user data that is populated by the end users.
"key": "A String", # The end user specified key of the user defined data.
"metadata": { # Metadata about a field. # Metadata about the user defined data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 end user specified value of the user defined data.
},
],
},
},
],
"readMask": "A String", # Required. A field mask to restrict which fields on each person are returned in the response. Multiple fields can be specified by separating them with commas. If read mask is left empty, the post-mutate-get is skipped and no data will be returned in the response. 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 in the post mutate read. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # If not successful, returns BatchCreateContactsErrorDetails which contains a list of errors for each invalid contact. The response to a request to create a batch of contacts.
"createdPeople": [ # The contacts that were created, unless the request `read_mask` is empty.
{ # The response for a single person
"httpStatusCode": 42, # **DEPRECATED** (Please use status instead) [HTTP 1.1 status code] (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).
"person": { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true. # The person.
"addresses": [ # The person's street addresses.
{ # A person's physical address. May be a P.O. box or street address. All fields are optional.
"city": "A String", # The city of the address.
"country": "A String", # The country of the address.
"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
"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.
"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.
"metadata": { # Metadata about a field. # Metadata about the address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"poBox": "A String", # The P.O. box of the address.
"postalCode": "A String", # The postal code of the address.
"region": "A String", # The region of the address; for example, the state or province.
"streetAddress": "A String", # The street address.
"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
},
],
"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
"ageRanges": [ # Output only. The person's age ranges.
{ # A person's age range.
"ageRange": "A String", # The age range.
"metadata": { # Metadata about a field. # Metadata about the age range.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"biographies": [ # The person's biographies. This field is a singleton for contact sources.
{ # A person's short biography.
"contentType": "A String", # The content type of the biography.
"metadata": { # Metadata about a field. # Metadata about the biography.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 short biography.
},
],
"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. Clients should always set the `date` field when mutating birthdays.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The structured 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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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", # Prefer to use the `date` field if set. A free-form string representing the user's birthday. This value is not validated.
},
],
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 bragging rights; for example, `climbed mount everest`.
},
],
"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, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
"url": "A String", # The calendar URL.
},
],
"clientData": [ # The person's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"metadata": { # Metadata about a field. # Metadata about the client data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 client specified value of the client data.
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 cover photo.
},
],
"emailAddresses": [ # The person's email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.
{ # A person's email address.
"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.
"metadata": { # Metadata about a field. # Metadata about the email address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
"value": "A String", # The email address.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 event. The type can be custom or one of these predefined values: * `anniversary` * `other`
},
],
"externalIds": [ # The person's external IDs.
{ # An identifier from an external entity 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 external ID.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
"value": "A String", # The value of the external ID.
},
],
"fileAses": [ # The person's file-ases.
{ # The name that should be used to sort the person in a list.
"metadata": { # Metadata about a field. # Metadata about the file-as.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 file-as value
},
],
"genders": [ # The person's genders. This field is a singleton for contact sources.
{ # A person's gender.
"addressMeAs": "A String", # Free form text field for pronouns that should be used to address the person. Common values are: * `he`/`him` * `she`/`her` * `they`/`them`
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
},
],
"imClients": [ # The person's instant messaging clients.
{ # A person's instant messaging client.
"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the IM client.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"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`
"username": "A String", # The user name used in the IM client.
},
],
"interests": [ # The person's interests.
{ # One of the person's interests.
"metadata": { # Metadata about a field. # Metadata about the interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"locales": [ # The person's locale preferences.
{ # A person's locale preference.
"metadata": { # Metadata about a field. # Metadata about the locale.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
},
],
"locations": [ # The person's locations.
{ # A person's location.
"buildingId": "A String", # The building identifier.
"current": True or False, # Whether the location is the current location.
"deskCode": "A String", # The individual desk location.
"floor": "A String", # The floor name or number.
"floorSection": "A String", # The floor section in `floor_name`.
"metadata": { # Metadata about a field. # Metadata about the location.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
"value": "A String", # The free-form value of the location.
},
],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
},
"domainMembership": { # A Google Workspace Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's Google Workspace domain.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"metadata": { # The metadata about a person. # Output only. Metadata about the person.
"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.
"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
"A String",
],
"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for `people.connections.list` requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
"A String",
],
"sources": [ # The sources of data for the person.
{ # The source of a field.
"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
],
},
"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.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 miscellaneous keyword type.
"value": "A String", # The value of the miscellaneous keyword.
},
],
"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.
"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.
"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.
"familyName": "A String", # The family name.
"givenName": "A String", # The given name.
"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
"metadata": { # Metadata about a field. # Metadata about the name.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"middleName": "A String", # The middle name(s).
"phoneticFamilyName": "A String", # The family name spelled as it sounds.
"phoneticFullName": "A String", # The full name spelled as it sounds.
"phoneticGivenName": "A String", # The given name spelled as it sounds.
"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
"unstructuredName": "A String", # The free form name value.
},
],
"nicknames": [ # The person's nicknames.
{ # A person's nickname.
"metadata": { # Metadata about a field. # Metadata about the nickname.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 nickname.
"value": "A String", # The nickname.
},
],
"occupations": [ # The person's occupations.
{ # A person's occupation.
"metadata": { # Metadata about a field. # Metadata about the occupation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"organizations": [ # The person's past or current organizations.
{ # A person's past or current organization. Overlapping date ranges are permitted.
"costCenter": "A String", # The person's cost center 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.
"department": "A String", # The person's department at the organization.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
"fullTimeEquivalentMillipercent": 42, # The person's full-time equivalent millipercent within the organization (100000 = 100%).
"jobDescription": "A String", # The person's job description at the organization.
"location": "A String", # The location of the organization office the person works at.
"metadata": { # Metadata about a field. # Metadata about the organization.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"name": "A String", # The name of the organization.
"phoneticName": "A String", # The phonetic name of 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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
"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`
},
],
"phoneNumbers": [ # The person's phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.
{ # A person's phone number.
"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the phone number.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
"metadata": { # Metadata about a field. # Metadata about the photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the 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`
},
],
"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
{ # **DEPRECATED**: No data will be returned A person's relationship interest .
"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relationship interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
{ # **DEPRECATED**: No data will be returned A person's relationship status.
"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the relationship status.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
},
],
"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
"metadata": { # Metadata about a field. # Metadata about the residence.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 address of the residence.
},
],
"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`.
"sipAddresses": [ # The person's SIP addresses.
{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the SIP address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"skills": [ # The person's skills.
{ # A skill that the person has.
"metadata": { # Metadata about a field. # Metadata about the skill.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 skill; for example, `underwater basket weaving`.
},
],
"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.
"metadata": { # Metadata about a field. # Metadata about the tagline.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 tagline.
},
],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the URL.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"userDefined": [ # The person's user defined data.
{ # Arbitrary user data that is populated by the end users.
"key": "A String", # The end user specified key of the user defined data.
"metadata": { # Metadata about a field. # Metadata about the user defined data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 end user specified value of the user defined data.
},
],
},
"requestedResourceName": "A String", # The original requested resource name. May be different than the resource name on the returned person. The resource name can change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or a profile URL.
"status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The status of the response.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
},
],
}
batchDeleteContacts(body=None, x__xgafv=None)
Delete a batch of contacts. Any non-contact data will not be deleted. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
Args:
body: object, The request body.
The object takes the form of:
{ # A request to delete a batch of existing contacts.
"resourceNames": [ # Required. The resource names of the contact to delete. It's repeatable. Allows up to 500 resource names in a single request.
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
batchUpdateContacts(body=None, x__xgafv=None)
Update a batch of contacts and return a map of resource names to PersonResponses for the updated contacts. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
Args:
body: object, The request body.
The object takes the form of:
{ # A request to update a batch of contacts.
"contacts": { # Required. A map of resource names to the person data to be updated. Allows up to 200 contacts in a single request.
"a_key": { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.
"addresses": [ # The person's street addresses.
{ # A person's physical address. May be a P.O. box or street address. All fields are optional.
"city": "A String", # The city of the address.
"country": "A String", # The country of the address.
"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
"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.
"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.
"metadata": { # Metadata about a field. # Metadata about the address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"poBox": "A String", # The P.O. box of the address.
"postalCode": "A String", # The postal code of the address.
"region": "A String", # The region of the address; for example, the state or province.
"streetAddress": "A String", # The street address.
"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
},
],
"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
"ageRanges": [ # Output only. The person's age ranges.
{ # A person's age range.
"ageRange": "A String", # The age range.
"metadata": { # Metadata about a field. # Metadata about the age range.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"biographies": [ # The person's biographies. This field is a singleton for contact sources.
{ # A person's short biography.
"contentType": "A String", # The content type of the biography.
"metadata": { # Metadata about a field. # Metadata about the biography.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 short biography.
},
],
"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. Clients should always set the `date` field when mutating birthdays.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The structured 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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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", # Prefer to use the `date` field if set. A free-form string representing the user's birthday. This value is not validated.
},
],
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 bragging rights; for example, `climbed mount everest`.
},
],
"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, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
"url": "A String", # The calendar URL.
},
],
"clientData": [ # The person's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"metadata": { # Metadata about a field. # Metadata about the client data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 client specified value of the client data.
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 cover photo.
},
],
"emailAddresses": [ # The person's email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.
{ # A person's email address.
"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.
"metadata": { # Metadata about a field. # Metadata about the email address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
"value": "A String", # The email address.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 event. The type can be custom or one of these predefined values: * `anniversary` * `other`
},
],
"externalIds": [ # The person's external IDs.
{ # An identifier from an external entity 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 external ID.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
"value": "A String", # The value of the external ID.
},
],
"fileAses": [ # The person's file-ases.
{ # The name that should be used to sort the person in a list.
"metadata": { # Metadata about a field. # Metadata about the file-as.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 file-as value
},
],
"genders": [ # The person's genders. This field is a singleton for contact sources.
{ # A person's gender.
"addressMeAs": "A String", # Free form text field for pronouns that should be used to address the person. Common values are: * `he`/`him` * `she`/`her` * `they`/`them`
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
},
],
"imClients": [ # The person's instant messaging clients.
{ # A person's instant messaging client.
"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the IM client.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"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`
"username": "A String", # The user name used in the IM client.
},
],
"interests": [ # The person's interests.
{ # One of the person's interests.
"metadata": { # Metadata about a field. # Metadata about the interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"locales": [ # The person's locale preferences.
{ # A person's locale preference.
"metadata": { # Metadata about a field. # Metadata about the locale.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
},
],
"locations": [ # The person's locations.
{ # A person's location.
"buildingId": "A String", # The building identifier.
"current": True or False, # Whether the location is the current location.
"deskCode": "A String", # The individual desk location.
"floor": "A String", # The floor name or number.
"floorSection": "A String", # The floor section in `floor_name`.
"metadata": { # Metadata about a field. # Metadata about the location.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
"value": "A String", # The free-form value of the location.
},
],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
},
"domainMembership": { # A Google Workspace Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's Google Workspace domain.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"metadata": { # The metadata about a person. # Output only. Metadata about the person.
"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.
"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
"A String",
],
"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for `people.connections.list` requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
"A String",
],
"sources": [ # The sources of data for the person.
{ # The source of a field.
"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
],
},
"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.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 miscellaneous keyword type.
"value": "A String", # The value of the miscellaneous keyword.
},
],
"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.
"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.
"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.
"familyName": "A String", # The family name.
"givenName": "A String", # The given name.
"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
"metadata": { # Metadata about a field. # Metadata about the name.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"middleName": "A String", # The middle name(s).
"phoneticFamilyName": "A String", # The family name spelled as it sounds.
"phoneticFullName": "A String", # The full name spelled as it sounds.
"phoneticGivenName": "A String", # The given name spelled as it sounds.
"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
"unstructuredName": "A String", # The free form name value.
},
],
"nicknames": [ # The person's nicknames.
{ # A person's nickname.
"metadata": { # Metadata about a field. # Metadata about the nickname.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 nickname.
"value": "A String", # The nickname.
},
],
"occupations": [ # The person's occupations.
{ # A person's occupation.
"metadata": { # Metadata about a field. # Metadata about the occupation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"organizations": [ # The person's past or current organizations.
{ # A person's past or current organization. Overlapping date ranges are permitted.
"costCenter": "A String", # The person's cost center 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.
"department": "A String", # The person's department at the organization.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
"fullTimeEquivalentMillipercent": 42, # The person's full-time equivalent millipercent within the organization (100000 = 100%).
"jobDescription": "A String", # The person's job description at the organization.
"location": "A String", # The location of the organization office the person works at.
"metadata": { # Metadata about a field. # Metadata about the organization.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"name": "A String", # The name of the organization.
"phoneticName": "A String", # The phonetic name of 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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
"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`
},
],
"phoneNumbers": [ # The person's phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.
{ # A person's phone number.
"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the phone number.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
"metadata": { # Metadata about a field. # Metadata about the photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the 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`
},
],
"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
{ # **DEPRECATED**: No data will be returned A person's relationship interest .
"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relationship interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
{ # **DEPRECATED**: No data will be returned A person's relationship status.
"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the relationship status.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
},
],
"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
"metadata": { # Metadata about a field. # Metadata about the residence.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 address of the residence.
},
],
"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`.
"sipAddresses": [ # The person's SIP addresses.
{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the SIP address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"skills": [ # The person's skills.
{ # A skill that the person has.
"metadata": { # Metadata about a field. # Metadata about the skill.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 skill; for example, `underwater basket weaving`.
},
],
"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.
"metadata": { # Metadata about a field. # Metadata about the tagline.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 tagline.
},
],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the URL.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"userDefined": [ # The person's user defined data.
{ # Arbitrary user data that is populated by the end users.
"key": "A String", # The end user specified key of the user defined data.
"metadata": { # Metadata about a field. # Metadata about the user defined data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 end user specified value of the user defined data.
},
],
},
},
"readMask": "A String", # Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. If read mask is left empty, the post-mutate-get is skipped and no data will be returned in the response. 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",
],
"updateMask": "A String", # Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All specified fields will be replaced, or cleared if left empty for each person. Valid values are: * addresses * biographies * birthdays * calendarUrls * clientData * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * sipAddresses * urls * userDefined
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # If not successful, returns BatchUpdateContactsErrorDetails, a list of errors corresponding to each contact. The response to a request to update a batch of contacts.
"updateResult": { # A map of resource names to the contacts that were updated, unless the request `read_mask` is empty.
"a_key": { # The response for a single person
"httpStatusCode": 42, # **DEPRECATED** (Please use status instead) [HTTP 1.1 status code] (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).
"person": { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true. # The person.
"addresses": [ # The person's street addresses.
{ # A person's physical address. May be a P.O. box or street address. All fields are optional.
"city": "A String", # The city of the address.
"country": "A String", # The country of the address.
"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
"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.
"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.
"metadata": { # Metadata about a field. # Metadata about the address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"poBox": "A String", # The P.O. box of the address.
"postalCode": "A String", # The postal code of the address.
"region": "A String", # The region of the address; for example, the state or province.
"streetAddress": "A String", # The street address.
"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
},
],
"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
"ageRanges": [ # Output only. The person's age ranges.
{ # A person's age range.
"ageRange": "A String", # The age range.
"metadata": { # Metadata about a field. # Metadata about the age range.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"biographies": [ # The person's biographies. This field is a singleton for contact sources.
{ # A person's short biography.
"contentType": "A String", # The content type of the biography.
"metadata": { # Metadata about a field. # Metadata about the biography.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 short biography.
},
],
"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. Clients should always set the `date` field when mutating birthdays.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The structured 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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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", # Prefer to use the `date` field if set. A free-form string representing the user's birthday. This value is not validated.
},
],
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 bragging rights; for example, `climbed mount everest`.
},
],
"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, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
"url": "A String", # The calendar URL.
},
],
"clientData": [ # The person's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"metadata": { # Metadata about a field. # Metadata about the client data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 client specified value of the client data.
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 cover photo.
},
],
"emailAddresses": [ # The person's email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.
{ # A person's email address.
"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.
"metadata": { # Metadata about a field. # Metadata about the email address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
"value": "A String", # The email address.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 event. The type can be custom or one of these predefined values: * `anniversary` * `other`
},
],
"externalIds": [ # The person's external IDs.
{ # An identifier from an external entity 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 external ID.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
"value": "A String", # The value of the external ID.
},
],
"fileAses": [ # The person's file-ases.
{ # The name that should be used to sort the person in a list.
"metadata": { # Metadata about a field. # Metadata about the file-as.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 file-as value
},
],
"genders": [ # The person's genders. This field is a singleton for contact sources.
{ # A person's gender.
"addressMeAs": "A String", # Free form text field for pronouns that should be used to address the person. Common values are: * `he`/`him` * `she`/`her` * `they`/`them`
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
},
],
"imClients": [ # The person's instant messaging clients.
{ # A person's instant messaging client.
"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the IM client.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"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`
"username": "A String", # The user name used in the IM client.
},
],
"interests": [ # The person's interests.
{ # One of the person's interests.
"metadata": { # Metadata about a field. # Metadata about the interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"locales": [ # The person's locale preferences.
{ # A person's locale preference.
"metadata": { # Metadata about a field. # Metadata about the locale.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
},
],
"locations": [ # The person's locations.
{ # A person's location.
"buildingId": "A String", # The building identifier.
"current": True or False, # Whether the location is the current location.
"deskCode": "A String", # The individual desk location.
"floor": "A String", # The floor name or number.
"floorSection": "A String", # The floor section in `floor_name`.
"metadata": { # Metadata about a field. # Metadata about the location.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
"value": "A String", # The free-form value of the location.
},
],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
},
"domainMembership": { # A Google Workspace Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's Google Workspace domain.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"metadata": { # The metadata about a person. # Output only. Metadata about the person.
"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.
"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
"A String",
],
"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for `people.connections.list` requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
"A String",
],
"sources": [ # The sources of data for the person.
{ # The source of a field.
"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
],
},
"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.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 miscellaneous keyword type.
"value": "A String", # The value of the miscellaneous keyword.
},
],
"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.
"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.
"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.
"familyName": "A String", # The family name.
"givenName": "A String", # The given name.
"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
"metadata": { # Metadata about a field. # Metadata about the name.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"middleName": "A String", # The middle name(s).
"phoneticFamilyName": "A String", # The family name spelled as it sounds.
"phoneticFullName": "A String", # The full name spelled as it sounds.
"phoneticGivenName": "A String", # The given name spelled as it sounds.
"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
"unstructuredName": "A String", # The free form name value.
},
],
"nicknames": [ # The person's nicknames.
{ # A person's nickname.
"metadata": { # Metadata about a field. # Metadata about the nickname.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 nickname.
"value": "A String", # The nickname.
},
],
"occupations": [ # The person's occupations.
{ # A person's occupation.
"metadata": { # Metadata about a field. # Metadata about the occupation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"organizations": [ # The person's past or current organizations.
{ # A person's past or current organization. Overlapping date ranges are permitted.
"costCenter": "A String", # The person's cost center 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.
"department": "A String", # The person's department at the organization.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
"fullTimeEquivalentMillipercent": 42, # The person's full-time equivalent millipercent within the organization (100000 = 100%).
"jobDescription": "A String", # The person's job description at the organization.
"location": "A String", # The location of the organization office the person works at.
"metadata": { # Metadata about a field. # Metadata about the organization.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"name": "A String", # The name of the organization.
"phoneticName": "A String", # The phonetic name of 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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
"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`
},
],
"phoneNumbers": [ # The person's phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.
{ # A person's phone number.
"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the phone number.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
"metadata": { # Metadata about a field. # Metadata about the photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the 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`
},
],
"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
{ # **DEPRECATED**: No data will be returned A person's relationship interest .
"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relationship interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
{ # **DEPRECATED**: No data will be returned A person's relationship status.
"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the relationship status.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
},
],
"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
"metadata": { # Metadata about a field. # Metadata about the residence.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 address of the residence.
},
],
"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`.
"sipAddresses": [ # The person's SIP addresses.
{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the SIP address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"skills": [ # The person's skills.
{ # A skill that the person has.
"metadata": { # Metadata about a field. # Metadata about the skill.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 skill; for example, `underwater basket weaving`.
},
],
"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.
"metadata": { # Metadata about a field. # Metadata about the tagline.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 tagline.
},
],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the URL.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"userDefined": [ # The person's user defined data.
{ # Arbitrary user data that is populated by the end users.
"key": "A String", # The end user specified key of the user defined data.
"metadata": { # Metadata about a field. # Metadata about the user defined data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 end user specified value of the user defined data.
},
],
},
"requestedResourceName": "A String", # The original requested resource name. May be different than the resource name on the returned person. The resource name can change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or a profile URL.
"status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The status of the response.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
},
},
}
close()
Close httplib2 connections.
createContact(body=None, personFields=None, sources=None, x__xgafv=None)
Create a new contact and return the person resource for that contact. The request returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
Args:
body: object, The request body.
The object takes the form of:
{ # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.
"addresses": [ # The person's street addresses.
{ # A person's physical address. May be a P.O. box or street address. All fields are optional.
"city": "A String", # The city of the address.
"country": "A String", # The country of the address.
"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
"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.
"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.
"metadata": { # Metadata about a field. # Metadata about the address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"poBox": "A String", # The P.O. box of the address.
"postalCode": "A String", # The postal code of the address.
"region": "A String", # The region of the address; for example, the state or province.
"streetAddress": "A String", # The street address.
"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
},
],
"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
"ageRanges": [ # Output only. The person's age ranges.
{ # A person's age range.
"ageRange": "A String", # The age range.
"metadata": { # Metadata about a field. # Metadata about the age range.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"biographies": [ # The person's biographies. This field is a singleton for contact sources.
{ # A person's short biography.
"contentType": "A String", # The content type of the biography.
"metadata": { # Metadata about a field. # Metadata about the biography.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 short biography.
},
],
"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. Clients should always set the `date` field when mutating birthdays.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The structured 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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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", # Prefer to use the `date` field if set. A free-form string representing the user's birthday. This value is not validated.
},
],
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 bragging rights; for example, `climbed mount everest`.
},
],
"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, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
"url": "A String", # The calendar URL.
},
],
"clientData": [ # The person's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"metadata": { # Metadata about a field. # Metadata about the client data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 client specified value of the client data.
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 cover photo.
},
],
"emailAddresses": [ # The person's email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.
{ # A person's email address.
"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.
"metadata": { # Metadata about a field. # Metadata about the email address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
"value": "A String", # The email address.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 event. The type can be custom or one of these predefined values: * `anniversary` * `other`
},
],
"externalIds": [ # The person's external IDs.
{ # An identifier from an external entity 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 external ID.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
"value": "A String", # The value of the external ID.
},
],
"fileAses": [ # The person's file-ases.
{ # The name that should be used to sort the person in a list.
"metadata": { # Metadata about a field. # Metadata about the file-as.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 file-as value
},
],
"genders": [ # The person's genders. This field is a singleton for contact sources.
{ # A person's gender.
"addressMeAs": "A String", # Free form text field for pronouns that should be used to address the person. Common values are: * `he`/`him` * `she`/`her` * `they`/`them`
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
},
],
"imClients": [ # The person's instant messaging clients.
{ # A person's instant messaging client.
"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the IM client.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"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`
"username": "A String", # The user name used in the IM client.
},
],
"interests": [ # The person's interests.
{ # One of the person's interests.
"metadata": { # Metadata about a field. # Metadata about the interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"locales": [ # The person's locale preferences.
{ # A person's locale preference.
"metadata": { # Metadata about a field. # Metadata about the locale.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
},
],
"locations": [ # The person's locations.
{ # A person's location.
"buildingId": "A String", # The building identifier.
"current": True or False, # Whether the location is the current location.
"deskCode": "A String", # The individual desk location.
"floor": "A String", # The floor name or number.
"floorSection": "A String", # The floor section in `floor_name`.
"metadata": { # Metadata about a field. # Metadata about the location.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
"value": "A String", # The free-form value of the location.
},
],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
},
"domainMembership": { # A Google Workspace Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's Google Workspace domain.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"metadata": { # The metadata about a person. # Output only. Metadata about the person.
"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.
"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
"A String",
],
"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for `people.connections.list` requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
"A String",
],
"sources": [ # The sources of data for the person.
{ # The source of a field.
"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
],
},
"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.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 miscellaneous keyword type.
"value": "A String", # The value of the miscellaneous keyword.
},
],
"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.
"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.
"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.
"familyName": "A String", # The family name.
"givenName": "A String", # The given name.
"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
"metadata": { # Metadata about a field. # Metadata about the name.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"middleName": "A String", # The middle name(s).
"phoneticFamilyName": "A String", # The family name spelled as it sounds.
"phoneticFullName": "A String", # The full name spelled as it sounds.
"phoneticGivenName": "A String", # The given name spelled as it sounds.
"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
"unstructuredName": "A String", # The free form name value.
},
],
"nicknames": [ # The person's nicknames.
{ # A person's nickname.
"metadata": { # Metadata about a field. # Metadata about the nickname.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 nickname.
"value": "A String", # The nickname.
},
],
"occupations": [ # The person's occupations.
{ # A person's occupation.
"metadata": { # Metadata about a field. # Metadata about the occupation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"organizations": [ # The person's past or current organizations.
{ # A person's past or current organization. Overlapping date ranges are permitted.
"costCenter": "A String", # The person's cost center 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.
"department": "A String", # The person's department at the organization.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
"fullTimeEquivalentMillipercent": 42, # The person's full-time equivalent millipercent within the organization (100000 = 100%).
"jobDescription": "A String", # The person's job description at the organization.
"location": "A String", # The location of the organization office the person works at.
"metadata": { # Metadata about a field. # Metadata about the organization.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"name": "A String", # The name of the organization.
"phoneticName": "A String", # The phonetic name of 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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
"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`
},
],
"phoneNumbers": [ # The person's phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.
{ # A person's phone number.
"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the phone number.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
"metadata": { # Metadata about a field. # Metadata about the photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the 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`
},
],
"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
{ # **DEPRECATED**: No data will be returned A person's relationship interest .
"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relationship interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
{ # **DEPRECATED**: No data will be returned A person's relationship status.
"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the relationship status.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
},
],
"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
"metadata": { # Metadata about a field. # Metadata about the residence.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 address of the residence.
},
],
"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`.
"sipAddresses": [ # The person's SIP addresses.
{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the SIP address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"skills": [ # The person's skills.
{ # A skill that the person has.
"metadata": { # Metadata about a field. # Metadata about the skill.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 skill; for example, `underwater basket weaving`.
},
],
"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.
"metadata": { # Metadata about a field. # Metadata about the tagline.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 tagline.
},
],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the URL.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"userDefined": [ # The person's user defined data.
{ # Arbitrary user data that is populated by the end users.
"key": "A String", # The end user specified key of the user defined data.
"metadata": { # Metadata about a field. # Metadata about the user defined data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 end user specified value of the user defined data.
},
],
}
personFields: string, Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
sources: string, Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set. (repeated)
Allowed values
READ_SOURCE_TYPE_UNSPECIFIED - Unspecified.
READ_SOURCE_TYPE_PROFILE - Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.
READ_SOURCE_TYPE_CONTACT - Returns SourceType.CONTACT.
READ_SOURCE_TYPE_DOMAIN_CONTACT - Returns SourceType.DOMAIN_CONTACT.
READ_SOURCE_TYPE_OTHER_CONTACT - Returns SourceType.OTHER_CONTACT.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.
"addresses": [ # The person's street addresses.
{ # A person's physical address. May be a P.O. box or street address. All fields are optional.
"city": "A String", # The city of the address.
"country": "A String", # The country of the address.
"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
"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.
"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.
"metadata": { # Metadata about a field. # Metadata about the address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"poBox": "A String", # The P.O. box of the address.
"postalCode": "A String", # The postal code of the address.
"region": "A String", # The region of the address; for example, the state or province.
"streetAddress": "A String", # The street address.
"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
},
],
"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
"ageRanges": [ # Output only. The person's age ranges.
{ # A person's age range.
"ageRange": "A String", # The age range.
"metadata": { # Metadata about a field. # Metadata about the age range.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"biographies": [ # The person's biographies. This field is a singleton for contact sources.
{ # A person's short biography.
"contentType": "A String", # The content type of the biography.
"metadata": { # Metadata about a field. # Metadata about the biography.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 short biography.
},
],
"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. Clients should always set the `date` field when mutating birthdays.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The structured 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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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", # Prefer to use the `date` field if set. A free-form string representing the user's birthday. This value is not validated.
},
],
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 bragging rights; for example, `climbed mount everest`.
},
],
"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, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
"url": "A String", # The calendar URL.
},
],
"clientData": [ # The person's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"metadata": { # Metadata about a field. # Metadata about the client data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 client specified value of the client data.
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 cover photo.
},
],
"emailAddresses": [ # The person's email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.
{ # A person's email address.
"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.
"metadata": { # Metadata about a field. # Metadata about the email address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
"value": "A String", # The email address.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 event. The type can be custom or one of these predefined values: * `anniversary` * `other`
},
],
"externalIds": [ # The person's external IDs.
{ # An identifier from an external entity 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 external ID.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
"value": "A String", # The value of the external ID.
},
],
"fileAses": [ # The person's file-ases.
{ # The name that should be used to sort the person in a list.
"metadata": { # Metadata about a field. # Metadata about the file-as.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 file-as value
},
],
"genders": [ # The person's genders. This field is a singleton for contact sources.
{ # A person's gender.
"addressMeAs": "A String", # Free form text field for pronouns that should be used to address the person. Common values are: * `he`/`him` * `she`/`her` * `they`/`them`
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
},
],
"imClients": [ # The person's instant messaging clients.
{ # A person's instant messaging client.
"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the IM client.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"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`
"username": "A String", # The user name used in the IM client.
},
],
"interests": [ # The person's interests.
{ # One of the person's interests.
"metadata": { # Metadata about a field. # Metadata about the interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"locales": [ # The person's locale preferences.
{ # A person's locale preference.
"metadata": { # Metadata about a field. # Metadata about the locale.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
},
],
"locations": [ # The person's locations.
{ # A person's location.
"buildingId": "A String", # The building identifier.
"current": True or False, # Whether the location is the current location.
"deskCode": "A String", # The individual desk location.
"floor": "A String", # The floor name or number.
"floorSection": "A String", # The floor section in `floor_name`.
"metadata": { # Metadata about a field. # Metadata about the location.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
"value": "A String", # The free-form value of the location.
},
],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
},
"domainMembership": { # A Google Workspace Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's Google Workspace domain.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"metadata": { # The metadata about a person. # Output only. Metadata about the person.
"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.
"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
"A String",
],
"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for `people.connections.list` requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
"A String",
],
"sources": [ # The sources of data for the person.
{ # The source of a field.
"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
],
},
"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.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 miscellaneous keyword type.
"value": "A String", # The value of the miscellaneous keyword.
},
],
"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.
"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.
"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.
"familyName": "A String", # The family name.
"givenName": "A String", # The given name.
"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
"metadata": { # Metadata about a field. # Metadata about the name.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"middleName": "A String", # The middle name(s).
"phoneticFamilyName": "A String", # The family name spelled as it sounds.
"phoneticFullName": "A String", # The full name spelled as it sounds.
"phoneticGivenName": "A String", # The given name spelled as it sounds.
"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
"unstructuredName": "A String", # The free form name value.
},
],
"nicknames": [ # The person's nicknames.
{ # A person's nickname.
"metadata": { # Metadata about a field. # Metadata about the nickname.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 nickname.
"value": "A String", # The nickname.
},
],
"occupations": [ # The person's occupations.
{ # A person's occupation.
"metadata": { # Metadata about a field. # Metadata about the occupation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"organizations": [ # The person's past or current organizations.
{ # A person's past or current organization. Overlapping date ranges are permitted.
"costCenter": "A String", # The person's cost center 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.
"department": "A String", # The person's department at the organization.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
"fullTimeEquivalentMillipercent": 42, # The person's full-time equivalent millipercent within the organization (100000 = 100%).
"jobDescription": "A String", # The person's job description at the organization.
"location": "A String", # The location of the organization office the person works at.
"metadata": { # Metadata about a field. # Metadata about the organization.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"name": "A String", # The name of the organization.
"phoneticName": "A String", # The phonetic name of 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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
"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`
},
],
"phoneNumbers": [ # The person's phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.
{ # A person's phone number.
"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the phone number.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
"metadata": { # Metadata about a field. # Metadata about the photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the 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`
},
],
"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
{ # **DEPRECATED**: No data will be returned A person's relationship interest .
"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relationship interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
{ # **DEPRECATED**: No data will be returned A person's relationship status.
"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the relationship status.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
},
],
"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
"metadata": { # Metadata about a field. # Metadata about the residence.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 address of the residence.
},
],
"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`.
"sipAddresses": [ # The person's SIP addresses.
{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the SIP address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"skills": [ # The person's skills.
{ # A skill that the person has.
"metadata": { # Metadata about a field. # Metadata about the skill.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 skill; for example, `underwater basket weaving`.
},
],
"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.
"metadata": { # Metadata about a field. # Metadata about the tagline.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 tagline.
},
],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the URL.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"userDefined": [ # The person's user defined data.
{ # Arbitrary user data that is populated by the end users.
"key": "A String", # The end user specified key of the user defined data.
"metadata": { # Metadata about a field. # Metadata about the user defined data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 end user specified value of the user defined data.
},
],
}
deleteContact(resourceName, x__xgafv=None)
Delete a contact person. Any non-contact data will not be deleted. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
Args:
resourceName: string, Required. The resource name of the contact to delete. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
deleteContactPhoto(resourceName, personFields=None, sources=None, x__xgafv=None)
Delete a contact's photo. Mutate requests for the same user should be done sequentially to avoid // lock contention.
Args:
resourceName: string, Required. The resource name of the contact whose photo will be deleted. (required)
personFields: string, Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
sources: string, Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set. (repeated)
Allowed values
READ_SOURCE_TYPE_UNSPECIFIED - Unspecified.
READ_SOURCE_TYPE_PROFILE - Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.
READ_SOURCE_TYPE_CONTACT - Returns SourceType.CONTACT.
READ_SOURCE_TYPE_DOMAIN_CONTACT - Returns SourceType.DOMAIN_CONTACT.
READ_SOURCE_TYPE_OTHER_CONTACT - Returns SourceType.OTHER_CONTACT.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response for deleting a contact's photo.
"person": { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true. # The updated person, if person_fields is set in the DeleteContactPhotoRequest; otherwise this will be unset.
"addresses": [ # The person's street addresses.
{ # A person's physical address. May be a P.O. box or street address. All fields are optional.
"city": "A String", # The city of the address.
"country": "A String", # The country of the address.
"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
"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.
"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.
"metadata": { # Metadata about a field. # Metadata about the address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"poBox": "A String", # The P.O. box of the address.
"postalCode": "A String", # The postal code of the address.
"region": "A String", # The region of the address; for example, the state or province.
"streetAddress": "A String", # The street address.
"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
},
],
"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
"ageRanges": [ # Output only. The person's age ranges.
{ # A person's age range.
"ageRange": "A String", # The age range.
"metadata": { # Metadata about a field. # Metadata about the age range.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"biographies": [ # The person's biographies. This field is a singleton for contact sources.
{ # A person's short biography.
"contentType": "A String", # The content type of the biography.
"metadata": { # Metadata about a field. # Metadata about the biography.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 short biography.
},
],
"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. Clients should always set the `date` field when mutating birthdays.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The structured 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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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", # Prefer to use the `date` field if set. A free-form string representing the user's birthday. This value is not validated.
},
],
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 bragging rights; for example, `climbed mount everest`.
},
],
"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, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
"url": "A String", # The calendar URL.
},
],
"clientData": [ # The person's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"metadata": { # Metadata about a field. # Metadata about the client data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 client specified value of the client data.
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 cover photo.
},
],
"emailAddresses": [ # The person's email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.
{ # A person's email address.
"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.
"metadata": { # Metadata about a field. # Metadata about the email address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
"value": "A String", # The email address.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 event. The type can be custom or one of these predefined values: * `anniversary` * `other`
},
],
"externalIds": [ # The person's external IDs.
{ # An identifier from an external entity 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 external ID.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
"value": "A String", # The value of the external ID.
},
],
"fileAses": [ # The person's file-ases.
{ # The name that should be used to sort the person in a list.
"metadata": { # Metadata about a field. # Metadata about the file-as.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 file-as value
},
],
"genders": [ # The person's genders. This field is a singleton for contact sources.
{ # A person's gender.
"addressMeAs": "A String", # Free form text field for pronouns that should be used to address the person. Common values are: * `he`/`him` * `she`/`her` * `they`/`them`
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
},
],
"imClients": [ # The person's instant messaging clients.
{ # A person's instant messaging client.
"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the IM client.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"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`
"username": "A String", # The user name used in the IM client.
},
],
"interests": [ # The person's interests.
{ # One of the person's interests.
"metadata": { # Metadata about a field. # Metadata about the interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"locales": [ # The person's locale preferences.
{ # A person's locale preference.
"metadata": { # Metadata about a field. # Metadata about the locale.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
},
],
"locations": [ # The person's locations.
{ # A person's location.
"buildingId": "A String", # The building identifier.
"current": True or False, # Whether the location is the current location.
"deskCode": "A String", # The individual desk location.
"floor": "A String", # The floor name or number.
"floorSection": "A String", # The floor section in `floor_name`.
"metadata": { # Metadata about a field. # Metadata about the location.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
"value": "A String", # The free-form value of the location.
},
],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
},
"domainMembership": { # A Google Workspace Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's Google Workspace domain.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"metadata": { # The metadata about a person. # Output only. Metadata about the person.
"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.
"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
"A String",
],
"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for `people.connections.list` requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
"A String",
],
"sources": [ # The sources of data for the person.
{ # The source of a field.
"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
],
},
"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.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 miscellaneous keyword type.
"value": "A String", # The value of the miscellaneous keyword.
},
],
"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.
"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.
"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.
"familyName": "A String", # The family name.
"givenName": "A String", # The given name.
"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
"metadata": { # Metadata about a field. # Metadata about the name.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"middleName": "A String", # The middle name(s).
"phoneticFamilyName": "A String", # The family name spelled as it sounds.
"phoneticFullName": "A String", # The full name spelled as it sounds.
"phoneticGivenName": "A String", # The given name spelled as it sounds.
"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
"unstructuredName": "A String", # The free form name value.
},
],
"nicknames": [ # The person's nicknames.
{ # A person's nickname.
"metadata": { # Metadata about a field. # Metadata about the nickname.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 nickname.
"value": "A String", # The nickname.
},
],
"occupations": [ # The person's occupations.
{ # A person's occupation.
"metadata": { # Metadata about a field. # Metadata about the occupation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"organizations": [ # The person's past or current organizations.
{ # A person's past or current organization. Overlapping date ranges are permitted.
"costCenter": "A String", # The person's cost center 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.
"department": "A String", # The person's department at the organization.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
"fullTimeEquivalentMillipercent": 42, # The person's full-time equivalent millipercent within the organization (100000 = 100%).
"jobDescription": "A String", # The person's job description at the organization.
"location": "A String", # The location of the organization office the person works at.
"metadata": { # Metadata about a field. # Metadata about the organization.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"name": "A String", # The name of the organization.
"phoneticName": "A String", # The phonetic name of 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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
"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`
},
],
"phoneNumbers": [ # The person's phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.
{ # A person's phone number.
"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the phone number.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
"metadata": { # Metadata about a field. # Metadata about the photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the 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`
},
],
"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
{ # **DEPRECATED**: No data will be returned A person's relationship interest .
"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relationship interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
{ # **DEPRECATED**: No data will be returned A person's relationship status.
"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the relationship status.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
},
],
"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
"metadata": { # Metadata about a field. # Metadata about the residence.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 address of the residence.
},
],
"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`.
"sipAddresses": [ # The person's SIP addresses.
{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the SIP address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"skills": [ # The person's skills.
{ # A skill that the person has.
"metadata": { # Metadata about a field. # Metadata about the skill.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 skill; for example, `underwater basket weaving`.
},
],
"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.
"metadata": { # Metadata about a field. # Metadata about the tagline.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 tagline.
},
],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the URL.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"userDefined": [ # The person's user defined data.
{ # Arbitrary user data that is populated by the end users.
"key": "A String", # The end user specified key of the user defined data.
"metadata": { # Metadata about a field. # Metadata about the user defined data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 end user specified value of the user defined data.
},
],
},
}
get(resourceName, personFields=None, requestMask_includeField=None, sources=None, x__xgafv=None)
Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.
Args:
resourceName: string, Required. The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by `people.connections.list`. (required)
personFields: string, Required. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
requestMask_includeField: string, Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.
sources: string, Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_PROFILE and READ_SOURCE_TYPE_CONTACT if not set. (repeated)
Allowed values
READ_SOURCE_TYPE_UNSPECIFIED - Unspecified.
READ_SOURCE_TYPE_PROFILE - Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.
READ_SOURCE_TYPE_CONTACT - Returns SourceType.CONTACT.
READ_SOURCE_TYPE_DOMAIN_CONTACT - Returns SourceType.DOMAIN_CONTACT.
READ_SOURCE_TYPE_OTHER_CONTACT - Returns SourceType.OTHER_CONTACT.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.
"addresses": [ # The person's street addresses.
{ # A person's physical address. May be a P.O. box or street address. All fields are optional.
"city": "A String", # The city of the address.
"country": "A String", # The country of the address.
"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
"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.
"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.
"metadata": { # Metadata about a field. # Metadata about the address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"poBox": "A String", # The P.O. box of the address.
"postalCode": "A String", # The postal code of the address.
"region": "A String", # The region of the address; for example, the state or province.
"streetAddress": "A String", # The street address.
"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
},
],
"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
"ageRanges": [ # Output only. The person's age ranges.
{ # A person's age range.
"ageRange": "A String", # The age range.
"metadata": { # Metadata about a field. # Metadata about the age range.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"biographies": [ # The person's biographies. This field is a singleton for contact sources.
{ # A person's short biography.
"contentType": "A String", # The content type of the biography.
"metadata": { # Metadata about a field. # Metadata about the biography.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 short biography.
},
],
"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. Clients should always set the `date` field when mutating birthdays.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The structured 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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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", # Prefer to use the `date` field if set. A free-form string representing the user's birthday. This value is not validated.
},
],
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 bragging rights; for example, `climbed mount everest`.
},
],
"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, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
"url": "A String", # The calendar URL.
},
],
"clientData": [ # The person's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"metadata": { # Metadata about a field. # Metadata about the client data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 client specified value of the client data.
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 cover photo.
},
],
"emailAddresses": [ # The person's email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.
{ # A person's email address.
"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.
"metadata": { # Metadata about a field. # Metadata about the email address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
"value": "A String", # The email address.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 event. The type can be custom or one of these predefined values: * `anniversary` * `other`
},
],
"externalIds": [ # The person's external IDs.
{ # An identifier from an external entity 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 external ID.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
"value": "A String", # The value of the external ID.
},
],
"fileAses": [ # The person's file-ases.
{ # The name that should be used to sort the person in a list.
"metadata": { # Metadata about a field. # Metadata about the file-as.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 file-as value
},
],
"genders": [ # The person's genders. This field is a singleton for contact sources.
{ # A person's gender.
"addressMeAs": "A String", # Free form text field for pronouns that should be used to address the person. Common values are: * `he`/`him` * `she`/`her` * `they`/`them`
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
},
],
"imClients": [ # The person's instant messaging clients.
{ # A person's instant messaging client.
"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the IM client.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"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`
"username": "A String", # The user name used in the IM client.
},
],
"interests": [ # The person's interests.
{ # One of the person's interests.
"metadata": { # Metadata about a field. # Metadata about the interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"locales": [ # The person's locale preferences.
{ # A person's locale preference.
"metadata": { # Metadata about a field. # Metadata about the locale.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
},
],
"locations": [ # The person's locations.
{ # A person's location.
"buildingId": "A String", # The building identifier.
"current": True or False, # Whether the location is the current location.
"deskCode": "A String", # The individual desk location.
"floor": "A String", # The floor name or number.
"floorSection": "A String", # The floor section in `floor_name`.
"metadata": { # Metadata about a field. # Metadata about the location.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
"value": "A String", # The free-form value of the location.
},
],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
},
"domainMembership": { # A Google Workspace Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's Google Workspace domain.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"metadata": { # The metadata about a person. # Output only. Metadata about the person.
"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.
"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
"A String",
],
"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for `people.connections.list` requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
"A String",
],
"sources": [ # The sources of data for the person.
{ # The source of a field.
"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
],
},
"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.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 miscellaneous keyword type.
"value": "A String", # The value of the miscellaneous keyword.
},
],
"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.
"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.
"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.
"familyName": "A String", # The family name.
"givenName": "A String", # The given name.
"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
"metadata": { # Metadata about a field. # Metadata about the name.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"middleName": "A String", # The middle name(s).
"phoneticFamilyName": "A String", # The family name spelled as it sounds.
"phoneticFullName": "A String", # The full name spelled as it sounds.
"phoneticGivenName": "A String", # The given name spelled as it sounds.
"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
"unstructuredName": "A String", # The free form name value.
},
],
"nicknames": [ # The person's nicknames.
{ # A person's nickname.
"metadata": { # Metadata about a field. # Metadata about the nickname.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 nickname.
"value": "A String", # The nickname.
},
],
"occupations": [ # The person's occupations.
{ # A person's occupation.
"metadata": { # Metadata about a field. # Metadata about the occupation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"organizations": [ # The person's past or current organizations.
{ # A person's past or current organization. Overlapping date ranges are permitted.
"costCenter": "A String", # The person's cost center 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.
"department": "A String", # The person's department at the organization.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
"fullTimeEquivalentMillipercent": 42, # The person's full-time equivalent millipercent within the organization (100000 = 100%).
"jobDescription": "A String", # The person's job description at the organization.
"location": "A String", # The location of the organization office the person works at.
"metadata": { # Metadata about a field. # Metadata about the organization.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"name": "A String", # The name of the organization.
"phoneticName": "A String", # The phonetic name of 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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
"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`
},
],
"phoneNumbers": [ # The person's phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.
{ # A person's phone number.
"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the phone number.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
"metadata": { # Metadata about a field. # Metadata about the photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the 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`
},
],
"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
{ # **DEPRECATED**: No data will be returned A person's relationship interest .
"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relationship interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
{ # **DEPRECATED**: No data will be returned A person's relationship status.
"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the relationship status.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
},
],
"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
"metadata": { # Metadata about a field. # Metadata about the residence.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 address of the residence.
},
],
"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`.
"sipAddresses": [ # The person's SIP addresses.
{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the SIP address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"skills": [ # The person's skills.
{ # A skill that the person has.
"metadata": { # Metadata about a field. # Metadata about the skill.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 skill; for example, `underwater basket weaving`.
},
],
"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.
"metadata": { # Metadata about a field. # Metadata about the tagline.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 tagline.
},
],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the URL.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"userDefined": [ # The person's user defined data.
{ # Arbitrary user data that is populated by the end users.
"key": "A String", # The end user specified key of the user defined data.
"metadata": { # Metadata about a field. # Metadata about the user defined data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 end user specified value of the user defined data.
},
],
}
getBatchGet(personFields=None, requestMask_includeField=None, resourceNames=None, sources=None, x__xgafv=None)
Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.
Args:
personFields: string, Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
requestMask_includeField: string, Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.
resourceNames: string, Required. The resource names of the people to provide information about. It's repeatable. The URL query parameter should be resourceNames=<name1>&resourceNames=<name2>&... - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by `people.connections.list`. There is a maximum of 200 resource names. (repeated)
sources: string, Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set. (repeated)
Allowed values
READ_SOURCE_TYPE_UNSPECIFIED - Unspecified.
READ_SOURCE_TYPE_PROFILE - Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.
READ_SOURCE_TYPE_CONTACT - Returns SourceType.CONTACT.
READ_SOURCE_TYPE_DOMAIN_CONTACT - Returns SourceType.DOMAIN_CONTACT.
READ_SOURCE_TYPE_OTHER_CONTACT - Returns SourceType.OTHER_CONTACT.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response to a get request for a list of people by resource name.
"responses": [ # The response for each requested resource name.
{ # The response for a single person
"httpStatusCode": 42, # **DEPRECATED** (Please use status instead) [HTTP 1.1 status code] (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).
"person": { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true. # The person.
"addresses": [ # The person's street addresses.
{ # A person's physical address. May be a P.O. box or street address. All fields are optional.
"city": "A String", # The city of the address.
"country": "A String", # The country of the address.
"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
"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.
"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.
"metadata": { # Metadata about a field. # Metadata about the address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"poBox": "A String", # The P.O. box of the address.
"postalCode": "A String", # The postal code of the address.
"region": "A String", # The region of the address; for example, the state or province.
"streetAddress": "A String", # The street address.
"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
},
],
"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
"ageRanges": [ # Output only. The person's age ranges.
{ # A person's age range.
"ageRange": "A String", # The age range.
"metadata": { # Metadata about a field. # Metadata about the age range.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"biographies": [ # The person's biographies. This field is a singleton for contact sources.
{ # A person's short biography.
"contentType": "A String", # The content type of the biography.
"metadata": { # Metadata about a field. # Metadata about the biography.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 short biography.
},
],
"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. Clients should always set the `date` field when mutating birthdays.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The structured 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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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", # Prefer to use the `date` field if set. A free-form string representing the user's birthday. This value is not validated.
},
],
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 bragging rights; for example, `climbed mount everest`.
},
],
"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, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
"url": "A String", # The calendar URL.
},
],
"clientData": [ # The person's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"metadata": { # Metadata about a field. # Metadata about the client data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 client specified value of the client data.
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 cover photo.
},
],
"emailAddresses": [ # The person's email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.
{ # A person's email address.
"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.
"metadata": { # Metadata about a field. # Metadata about the email address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
"value": "A String", # The email address.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 event. The type can be custom or one of these predefined values: * `anniversary` * `other`
},
],
"externalIds": [ # The person's external IDs.
{ # An identifier from an external entity 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 external ID.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
"value": "A String", # The value of the external ID.
},
],
"fileAses": [ # The person's file-ases.
{ # The name that should be used to sort the person in a list.
"metadata": { # Metadata about a field. # Metadata about the file-as.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 file-as value
},
],
"genders": [ # The person's genders. This field is a singleton for contact sources.
{ # A person's gender.
"addressMeAs": "A String", # Free form text field for pronouns that should be used to address the person. Common values are: * `he`/`him` * `she`/`her` * `they`/`them`
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
},
],
"imClients": [ # The person's instant messaging clients.
{ # A person's instant messaging client.
"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the IM client.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"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`
"username": "A String", # The user name used in the IM client.
},
],
"interests": [ # The person's interests.
{ # One of the person's interests.
"metadata": { # Metadata about a field. # Metadata about the interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"locales": [ # The person's locale preferences.
{ # A person's locale preference.
"metadata": { # Metadata about a field. # Metadata about the locale.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
},
],
"locations": [ # The person's locations.
{ # A person's location.
"buildingId": "A String", # The building identifier.
"current": True or False, # Whether the location is the current location.
"deskCode": "A String", # The individual desk location.
"floor": "A String", # The floor name or number.
"floorSection": "A String", # The floor section in `floor_name`.
"metadata": { # Metadata about a field. # Metadata about the location.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
"value": "A String", # The free-form value of the location.
},
],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
},
"domainMembership": { # A Google Workspace Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's Google Workspace domain.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"metadata": { # The metadata about a person. # Output only. Metadata about the person.
"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.
"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
"A String",
],
"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for `people.connections.list` requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
"A String",
],
"sources": [ # The sources of data for the person.
{ # The source of a field.
"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
],
},
"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.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 miscellaneous keyword type.
"value": "A String", # The value of the miscellaneous keyword.
},
],
"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.
"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.
"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.
"familyName": "A String", # The family name.
"givenName": "A String", # The given name.
"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
"metadata": { # Metadata about a field. # Metadata about the name.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"middleName": "A String", # The middle name(s).
"phoneticFamilyName": "A String", # The family name spelled as it sounds.
"phoneticFullName": "A String", # The full name spelled as it sounds.
"phoneticGivenName": "A String", # The given name spelled as it sounds.
"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
"unstructuredName": "A String", # The free form name value.
},
],
"nicknames": [ # The person's nicknames.
{ # A person's nickname.
"metadata": { # Metadata about a field. # Metadata about the nickname.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 nickname.
"value": "A String", # The nickname.
},
],
"occupations": [ # The person's occupations.
{ # A person's occupation.
"metadata": { # Metadata about a field. # Metadata about the occupation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"organizations": [ # The person's past or current organizations.
{ # A person's past or current organization. Overlapping date ranges are permitted.
"costCenter": "A String", # The person's cost center 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.
"department": "A String", # The person's department at the organization.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
"fullTimeEquivalentMillipercent": 42, # The person's full-time equivalent millipercent within the organization (100000 = 100%).
"jobDescription": "A String", # The person's job description at the organization.
"location": "A String", # The location of the organization office the person works at.
"metadata": { # Metadata about a field. # Metadata about the organization.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"name": "A String", # The name of the organization.
"phoneticName": "A String", # The phonetic name of 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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
"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`
},
],
"phoneNumbers": [ # The person's phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.
{ # A person's phone number.
"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the phone number.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
"metadata": { # Metadata about a field. # Metadata about the photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the 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`
},
],
"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
{ # **DEPRECATED**: No data will be returned A person's relationship interest .
"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relationship interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
{ # **DEPRECATED**: No data will be returned A person's relationship status.
"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the relationship status.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
},
],
"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
"metadata": { # Metadata about a field. # Metadata about the residence.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 address of the residence.
},
],
"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`.
"sipAddresses": [ # The person's SIP addresses.
{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the SIP address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"skills": [ # The person's skills.
{ # A skill that the person has.
"metadata": { # Metadata about a field. # Metadata about the skill.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 skill; for example, `underwater basket weaving`.
},
],
"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.
"metadata": { # Metadata about a field. # Metadata about the tagline.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 tagline.
},
],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the URL.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"userDefined": [ # The person's user defined data.
{ # Arbitrary user data that is populated by the end users.
"key": "A String", # The end user specified key of the user defined data.
"metadata": { # Metadata about a field. # Metadata about the user defined data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 end user specified value of the user defined data.
},
],
},
"requestedResourceName": "A String", # The original requested resource name. May be different than the resource name on the returned person. The resource name can change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or a profile URL.
"status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The status of the response.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
},
],
}
listDirectoryPeople(mergeSources=None, pageSize=None, pageToken=None, readMask=None, requestSyncToken=None, sources=None, syncToken=None, x__xgafv=None)
Provides a list of domain profiles and domain contacts in the authenticated user's domain directory. When the `sync_token` is specified, resources deleted since the last sync will be returned as a person with `PersonMetadata.deleted` set to true. When the `page_token` or `sync_token` is specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at [List the directory people that have changed](/people/v1/directory#list_the_directory_people_that_have_changed).
Args:
mergeSources: string, Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers. (repeated)
Allowed values
DIRECTORY_MERGE_SOURCE_TYPE_UNSPECIFIED - Unspecified.
DIRECTORY_MERGE_SOURCE_TYPE_CONTACT - User owned contact.
pageSize: integer, Optional. The number of people to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.
pageToken: string, Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `people.listDirectoryPeople` must match the first call that provided the page token.
readMask: string, Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
requestSyncToken: boolean, Optional. Whether the response should return `next_sync_token`. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `people.listDirectoryPeople`.
sources: string, Required. Directory sources to return. (repeated)
Allowed values
DIRECTORY_SOURCE_TYPE_UNSPECIFIED - Unspecified.
DIRECTORY_SOURCE_TYPE_DOMAIN_CONTACT - Google Workspace domain shared contact.
DIRECTORY_SOURCE_TYPE_DOMAIN_PROFILE - Google Workspace domain profile.
syncToken: string, Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `people.listDirectoryPeople` must match the first call that provided the sync token. More details about sync behavior at `people.listDirectoryPeople`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response to a request for the authenticated user's domain directory.
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"nextSyncToken": "A String", # A token, which can be sent as `sync_token` to retrieve changes since the last request. Request must set `request_sync_token` to return the sync token.
"people": [ # The list of people in the domain directory.
{ # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.
"addresses": [ # The person's street addresses.
{ # A person's physical address. May be a P.O. box or street address. All fields are optional.
"city": "A String", # The city of the address.
"country": "A String", # The country of the address.
"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
"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.
"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.
"metadata": { # Metadata about a field. # Metadata about the address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"poBox": "A String", # The P.O. box of the address.
"postalCode": "A String", # The postal code of the address.
"region": "A String", # The region of the address; for example, the state or province.
"streetAddress": "A String", # The street address.
"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
},
],
"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
"ageRanges": [ # Output only. The person's age ranges.
{ # A person's age range.
"ageRange": "A String", # The age range.
"metadata": { # Metadata about a field. # Metadata about the age range.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"biographies": [ # The person's biographies. This field is a singleton for contact sources.
{ # A person's short biography.
"contentType": "A String", # The content type of the biography.
"metadata": { # Metadata about a field. # Metadata about the biography.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 short biography.
},
],
"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. Clients should always set the `date` field when mutating birthdays.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The structured 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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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", # Prefer to use the `date` field if set. A free-form string representing the user's birthday. This value is not validated.
},
],
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 bragging rights; for example, `climbed mount everest`.
},
],
"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, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
"url": "A String", # The calendar URL.
},
],
"clientData": [ # The person's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"metadata": { # Metadata about a field. # Metadata about the client data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 client specified value of the client data.
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 cover photo.
},
],
"emailAddresses": [ # The person's email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.
{ # A person's email address.
"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.
"metadata": { # Metadata about a field. # Metadata about the email address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
"value": "A String", # The email address.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 event. The type can be custom or one of these predefined values: * `anniversary` * `other`
},
],
"externalIds": [ # The person's external IDs.
{ # An identifier from an external entity 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 external ID.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
"value": "A String", # The value of the external ID.
},
],
"fileAses": [ # The person's file-ases.
{ # The name that should be used to sort the person in a list.
"metadata": { # Metadata about a field. # Metadata about the file-as.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 file-as value
},
],
"genders": [ # The person's genders. This field is a singleton for contact sources.
{ # A person's gender.
"addressMeAs": "A String", # Free form text field for pronouns that should be used to address the person. Common values are: * `he`/`him` * `she`/`her` * `they`/`them`
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
},
],
"imClients": [ # The person's instant messaging clients.
{ # A person's instant messaging client.
"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the IM client.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"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`
"username": "A String", # The user name used in the IM client.
},
],
"interests": [ # The person's interests.
{ # One of the person's interests.
"metadata": { # Metadata about a field. # Metadata about the interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"locales": [ # The person's locale preferences.
{ # A person's locale preference.
"metadata": { # Metadata about a field. # Metadata about the locale.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
},
],
"locations": [ # The person's locations.
{ # A person's location.
"buildingId": "A String", # The building identifier.
"current": True or False, # Whether the location is the current location.
"deskCode": "A String", # The individual desk location.
"floor": "A String", # The floor name or number.
"floorSection": "A String", # The floor section in `floor_name`.
"metadata": { # Metadata about a field. # Metadata about the location.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
"value": "A String", # The free-form value of the location.
},
],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
},
"domainMembership": { # A Google Workspace Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's Google Workspace domain.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"metadata": { # The metadata about a person. # Output only. Metadata about the person.
"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.
"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
"A String",
],
"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for `people.connections.list` requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
"A String",
],
"sources": [ # The sources of data for the person.
{ # The source of a field.
"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
],
},
"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.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 miscellaneous keyword type.
"value": "A String", # The value of the miscellaneous keyword.
},
],
"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.
"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.
"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.
"familyName": "A String", # The family name.
"givenName": "A String", # The given name.
"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
"metadata": { # Metadata about a field. # Metadata about the name.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"middleName": "A String", # The middle name(s).
"phoneticFamilyName": "A String", # The family name spelled as it sounds.
"phoneticFullName": "A String", # The full name spelled as it sounds.
"phoneticGivenName": "A String", # The given name spelled as it sounds.
"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
"unstructuredName": "A String", # The free form name value.
},
],
"nicknames": [ # The person's nicknames.
{ # A person's nickname.
"metadata": { # Metadata about a field. # Metadata about the nickname.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 nickname.
"value": "A String", # The nickname.
},
],
"occupations": [ # The person's occupations.
{ # A person's occupation.
"metadata": { # Metadata about a field. # Metadata about the occupation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"organizations": [ # The person's past or current organizations.
{ # A person's past or current organization. Overlapping date ranges are permitted.
"costCenter": "A String", # The person's cost center 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.
"department": "A String", # The person's department at the organization.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
"fullTimeEquivalentMillipercent": 42, # The person's full-time equivalent millipercent within the organization (100000 = 100%).
"jobDescription": "A String", # The person's job description at the organization.
"location": "A String", # The location of the organization office the person works at.
"metadata": { # Metadata about a field. # Metadata about the organization.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"name": "A String", # The name of the organization.
"phoneticName": "A String", # The phonetic name of 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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
"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`
},
],
"phoneNumbers": [ # The person's phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.
{ # A person's phone number.
"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the phone number.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
"metadata": { # Metadata about a field. # Metadata about the photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the 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`
},
],
"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
{ # **DEPRECATED**: No data will be returned A person's relationship interest .
"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relationship interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
{ # **DEPRECATED**: No data will be returned A person's relationship status.
"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the relationship status.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
},
],
"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
"metadata": { # Metadata about a field. # Metadata about the residence.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 address of the residence.
},
],
"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`.
"sipAddresses": [ # The person's SIP addresses.
{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the SIP address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"skills": [ # The person's skills.
{ # A skill that the person has.
"metadata": { # Metadata about a field. # Metadata about the skill.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 skill; for example, `underwater basket weaving`.
},
],
"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.
"metadata": { # Metadata about a field. # Metadata about the tagline.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 tagline.
},
],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the URL.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"userDefined": [ # The person's user defined data.
{ # Arbitrary user data that is populated by the end users.
"key": "A String", # The end user specified key of the user defined data.
"metadata": { # Metadata about a field. # Metadata about the user defined data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 end user specified value of the user defined data.
},
],
},
],
}
listDirectoryPeople_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
searchContacts(pageSize=None, query=None, readMask=None, sources=None, x__xgafv=None)
Provides a list of contacts in the authenticated user's grouped contacts that matches the search query. The query matches on a contact's `names`, `nickNames`, `emailAddresses`, `phoneNumbers`, and `organizations` fields that are from the CONTACT source. **IMPORTANT**: Before searching, clients should send a warmup request with an empty query to update the cache. See https://developers.google.com/people/v1/contacts#search_the_users_contacts
Args:
pageSize: integer, Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 30 will be capped to 30.
query: string, Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name "foo name" matches queries such as "f", "fo", "foo", "foo n", "nam", etc., but not "oo n".
readMask: string, Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
sources: string, Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set. (repeated)
Allowed values
READ_SOURCE_TYPE_UNSPECIFIED - Unspecified.
READ_SOURCE_TYPE_PROFILE - Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.
READ_SOURCE_TYPE_CONTACT - Returns SourceType.CONTACT.
READ_SOURCE_TYPE_DOMAIN_CONTACT - Returns SourceType.DOMAIN_CONTACT.
READ_SOURCE_TYPE_OTHER_CONTACT - Returns SourceType.OTHER_CONTACT.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response to a search request for the authenticated user, given a query.
"results": [ # The results of the request.
{ # A result of a search query.
"person": { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true. # The matched Person.
"addresses": [ # The person's street addresses.
{ # A person's physical address. May be a P.O. box or street address. All fields are optional.
"city": "A String", # The city of the address.
"country": "A String", # The country of the address.
"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
"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.
"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.
"metadata": { # Metadata about a field. # Metadata about the address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"poBox": "A String", # The P.O. box of the address.
"postalCode": "A String", # The postal code of the address.
"region": "A String", # The region of the address; for example, the state or province.
"streetAddress": "A String", # The street address.
"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
},
],
"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
"ageRanges": [ # Output only. The person's age ranges.
{ # A person's age range.
"ageRange": "A String", # The age range.
"metadata": { # Metadata about a field. # Metadata about the age range.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"biographies": [ # The person's biographies. This field is a singleton for contact sources.
{ # A person's short biography.
"contentType": "A String", # The content type of the biography.
"metadata": { # Metadata about a field. # Metadata about the biography.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 short biography.
},
],
"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. Clients should always set the `date` field when mutating birthdays.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The structured 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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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", # Prefer to use the `date` field if set. A free-form string representing the user's birthday. This value is not validated.
},
],
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 bragging rights; for example, `climbed mount everest`.
},
],
"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, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
"url": "A String", # The calendar URL.
},
],
"clientData": [ # The person's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"metadata": { # Metadata about a field. # Metadata about the client data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 client specified value of the client data.
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 cover photo.
},
],
"emailAddresses": [ # The person's email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.
{ # A person's email address.
"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.
"metadata": { # Metadata about a field. # Metadata about the email address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
"value": "A String", # The email address.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 event. The type can be custom or one of these predefined values: * `anniversary` * `other`
},
],
"externalIds": [ # The person's external IDs.
{ # An identifier from an external entity 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 external ID.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
"value": "A String", # The value of the external ID.
},
],
"fileAses": [ # The person's file-ases.
{ # The name that should be used to sort the person in a list.
"metadata": { # Metadata about a field. # Metadata about the file-as.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 file-as value
},
],
"genders": [ # The person's genders. This field is a singleton for contact sources.
{ # A person's gender.
"addressMeAs": "A String", # Free form text field for pronouns that should be used to address the person. Common values are: * `he`/`him` * `she`/`her` * `they`/`them`
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
},
],
"imClients": [ # The person's instant messaging clients.
{ # A person's instant messaging client.
"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the IM client.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"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`
"username": "A String", # The user name used in the IM client.
},
],
"interests": [ # The person's interests.
{ # One of the person's interests.
"metadata": { # Metadata about a field. # Metadata about the interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"locales": [ # The person's locale preferences.
{ # A person's locale preference.
"metadata": { # Metadata about a field. # Metadata about the locale.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
},
],
"locations": [ # The person's locations.
{ # A person's location.
"buildingId": "A String", # The building identifier.
"current": True or False, # Whether the location is the current location.
"deskCode": "A String", # The individual desk location.
"floor": "A String", # The floor name or number.
"floorSection": "A String", # The floor section in `floor_name`.
"metadata": { # Metadata about a field. # Metadata about the location.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
"value": "A String", # The free-form value of the location.
},
],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
},
"domainMembership": { # A Google Workspace Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's Google Workspace domain.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"metadata": { # The metadata about a person. # Output only. Metadata about the person.
"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.
"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
"A String",
],
"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for `people.connections.list` requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
"A String",
],
"sources": [ # The sources of data for the person.
{ # The source of a field.
"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
],
},
"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.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 miscellaneous keyword type.
"value": "A String", # The value of the miscellaneous keyword.
},
],
"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.
"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.
"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.
"familyName": "A String", # The family name.
"givenName": "A String", # The given name.
"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
"metadata": { # Metadata about a field. # Metadata about the name.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"middleName": "A String", # The middle name(s).
"phoneticFamilyName": "A String", # The family name spelled as it sounds.
"phoneticFullName": "A String", # The full name spelled as it sounds.
"phoneticGivenName": "A String", # The given name spelled as it sounds.
"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
"unstructuredName": "A String", # The free form name value.
},
],
"nicknames": [ # The person's nicknames.
{ # A person's nickname.
"metadata": { # Metadata about a field. # Metadata about the nickname.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 nickname.
"value": "A String", # The nickname.
},
],
"occupations": [ # The person's occupations.
{ # A person's occupation.
"metadata": { # Metadata about a field. # Metadata about the occupation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"organizations": [ # The person's past or current organizations.
{ # A person's past or current organization. Overlapping date ranges are permitted.
"costCenter": "A String", # The person's cost center 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.
"department": "A String", # The person's department at the organization.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
"fullTimeEquivalentMillipercent": 42, # The person's full-time equivalent millipercent within the organization (100000 = 100%).
"jobDescription": "A String", # The person's job description at the organization.
"location": "A String", # The location of the organization office the person works at.
"metadata": { # Metadata about a field. # Metadata about the organization.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"name": "A String", # The name of the organization.
"phoneticName": "A String", # The phonetic name of 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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
"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`
},
],
"phoneNumbers": [ # The person's phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.
{ # A person's phone number.
"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the phone number.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
"metadata": { # Metadata about a field. # Metadata about the photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the 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`
},
],
"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
{ # **DEPRECATED**: No data will be returned A person's relationship interest .
"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relationship interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
{ # **DEPRECATED**: No data will be returned A person's relationship status.
"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the relationship status.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
},
],
"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
"metadata": { # Metadata about a field. # Metadata about the residence.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 address of the residence.
},
],
"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`.
"sipAddresses": [ # The person's SIP addresses.
{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the SIP address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"skills": [ # The person's skills.
{ # A skill that the person has.
"metadata": { # Metadata about a field. # Metadata about the skill.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 skill; for example, `underwater basket weaving`.
},
],
"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.
"metadata": { # Metadata about a field. # Metadata about the tagline.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 tagline.
},
],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the URL.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"userDefined": [ # The person's user defined data.
{ # Arbitrary user data that is populated by the end users.
"key": "A String", # The end user specified key of the user defined data.
"metadata": { # Metadata about a field. # Metadata about the user defined data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 end user specified value of the user defined data.
},
],
},
},
],
}
searchDirectoryPeople(mergeSources=None, pageSize=None, pageToken=None, query=None, readMask=None, sources=None, x__xgafv=None)
Provides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query.
Args:
mergeSources: string, Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers. (repeated)
Allowed values
DIRECTORY_MERGE_SOURCE_TYPE_UNSPECIFIED - Unspecified.
DIRECTORY_MERGE_SOURCE_TYPE_CONTACT - User owned contact.
pageSize: integer, Optional. The number of people to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100 if not set or set to 0.
pageToken: string, Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchDirectoryPeople` must match the first call that provided the page token.
query: string, Required. Prefix query that matches fields in the person. Does NOT use the read_mask for determining what fields to match.
readMask: string, Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
sources: string, Required. Directory sources to return. (repeated)
Allowed values
DIRECTORY_SOURCE_TYPE_UNSPECIFIED - Unspecified.
DIRECTORY_SOURCE_TYPE_DOMAIN_CONTACT - Google Workspace domain shared contact.
DIRECTORY_SOURCE_TYPE_DOMAIN_PROFILE - Google Workspace domain profile.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response to a request for people in the authenticated user's domain directory that match the specified query.
"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.
"people": [ # The list of people in the domain directory that match the query.
{ # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.
"addresses": [ # The person's street addresses.
{ # A person's physical address. May be a P.O. box or street address. All fields are optional.
"city": "A String", # The city of the address.
"country": "A String", # The country of the address.
"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
"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.
"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.
"metadata": { # Metadata about a field. # Metadata about the address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"poBox": "A String", # The P.O. box of the address.
"postalCode": "A String", # The postal code of the address.
"region": "A String", # The region of the address; for example, the state or province.
"streetAddress": "A String", # The street address.
"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
},
],
"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
"ageRanges": [ # Output only. The person's age ranges.
{ # A person's age range.
"ageRange": "A String", # The age range.
"metadata": { # Metadata about a field. # Metadata about the age range.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"biographies": [ # The person's biographies. This field is a singleton for contact sources.
{ # A person's short biography.
"contentType": "A String", # The content type of the biography.
"metadata": { # Metadata about a field. # Metadata about the biography.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 short biography.
},
],
"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. Clients should always set the `date` field when mutating birthdays.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The structured 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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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", # Prefer to use the `date` field if set. A free-form string representing the user's birthday. This value is not validated.
},
],
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 bragging rights; for example, `climbed mount everest`.
},
],
"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, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
"url": "A String", # The calendar URL.
},
],
"clientData": [ # The person's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"metadata": { # Metadata about a field. # Metadata about the client data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 client specified value of the client data.
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 cover photo.
},
],
"emailAddresses": [ # The person's email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.
{ # A person's email address.
"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.
"metadata": { # Metadata about a field. # Metadata about the email address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
"value": "A String", # The email address.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 event. The type can be custom or one of these predefined values: * `anniversary` * `other`
},
],
"externalIds": [ # The person's external IDs.
{ # An identifier from an external entity 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 external ID.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
"value": "A String", # The value of the external ID.
},
],
"fileAses": [ # The person's file-ases.
{ # The name that should be used to sort the person in a list.
"metadata": { # Metadata about a field. # Metadata about the file-as.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 file-as value
},
],
"genders": [ # The person's genders. This field is a singleton for contact sources.
{ # A person's gender.
"addressMeAs": "A String", # Free form text field for pronouns that should be used to address the person. Common values are: * `he`/`him` * `she`/`her` * `they`/`them`
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
},
],
"imClients": [ # The person's instant messaging clients.
{ # A person's instant messaging client.
"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the IM client.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"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`
"username": "A String", # The user name used in the IM client.
},
],
"interests": [ # The person's interests.
{ # One of the person's interests.
"metadata": { # Metadata about a field. # Metadata about the interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"locales": [ # The person's locale preferences.
{ # A person's locale preference.
"metadata": { # Metadata about a field. # Metadata about the locale.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
},
],
"locations": [ # The person's locations.
{ # A person's location.
"buildingId": "A String", # The building identifier.
"current": True or False, # Whether the location is the current location.
"deskCode": "A String", # The individual desk location.
"floor": "A String", # The floor name or number.
"floorSection": "A String", # The floor section in `floor_name`.
"metadata": { # Metadata about a field. # Metadata about the location.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
"value": "A String", # The free-form value of the location.
},
],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
},
"domainMembership": { # A Google Workspace Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's Google Workspace domain.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"metadata": { # The metadata about a person. # Output only. Metadata about the person.
"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.
"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
"A String",
],
"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for `people.connections.list` requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
"A String",
],
"sources": [ # The sources of data for the person.
{ # The source of a field.
"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
],
},
"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.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 miscellaneous keyword type.
"value": "A String", # The value of the miscellaneous keyword.
},
],
"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.
"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.
"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.
"familyName": "A String", # The family name.
"givenName": "A String", # The given name.
"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
"metadata": { # Metadata about a field. # Metadata about the name.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"middleName": "A String", # The middle name(s).
"phoneticFamilyName": "A String", # The family name spelled as it sounds.
"phoneticFullName": "A String", # The full name spelled as it sounds.
"phoneticGivenName": "A String", # The given name spelled as it sounds.
"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
"unstructuredName": "A String", # The free form name value.
},
],
"nicknames": [ # The person's nicknames.
{ # A person's nickname.
"metadata": { # Metadata about a field. # Metadata about the nickname.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 nickname.
"value": "A String", # The nickname.
},
],
"occupations": [ # The person's occupations.
{ # A person's occupation.
"metadata": { # Metadata about a field. # Metadata about the occupation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"organizations": [ # The person's past or current organizations.
{ # A person's past or current organization. Overlapping date ranges are permitted.
"costCenter": "A String", # The person's cost center 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.
"department": "A String", # The person's department at the organization.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
"fullTimeEquivalentMillipercent": 42, # The person's full-time equivalent millipercent within the organization (100000 = 100%).
"jobDescription": "A String", # The person's job description at the organization.
"location": "A String", # The location of the organization office the person works at.
"metadata": { # Metadata about a field. # Metadata about the organization.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"name": "A String", # The name of the organization.
"phoneticName": "A String", # The phonetic name of 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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
"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`
},
],
"phoneNumbers": [ # The person's phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.
{ # A person's phone number.
"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the phone number.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
"metadata": { # Metadata about a field. # Metadata about the photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the 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`
},
],
"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
{ # **DEPRECATED**: No data will be returned A person's relationship interest .
"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relationship interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
{ # **DEPRECATED**: No data will be returned A person's relationship status.
"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the relationship status.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
},
],
"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
"metadata": { # Metadata about a field. # Metadata about the residence.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 address of the residence.
},
],
"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`.
"sipAddresses": [ # The person's SIP addresses.
{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the SIP address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"skills": [ # The person's skills.
{ # A skill that the person has.
"metadata": { # Metadata about a field. # Metadata about the skill.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 skill; for example, `underwater basket weaving`.
},
],
"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.
"metadata": { # Metadata about a field. # Metadata about the tagline.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 tagline.
},
],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the URL.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"userDefined": [ # The person's user defined data.
{ # Arbitrary user data that is populated by the end users.
"key": "A String", # The end user specified key of the user defined data.
"metadata": { # Metadata about a field. # Metadata about the user defined data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 end user specified value of the user defined data.
},
],
},
],
"totalSize": 42, # The total number of items in the list without pagination.
}
searchDirectoryPeople_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
updateContact(resourceName, body=None, personFields=None, sources=None, updatePersonFields=None, x__xgafv=None)
Update contact data for an existing contact person. Any non-contact data will not be modified. Any non-contact data in the person to update will be ignored. All fields specified in the `update_mask` will be replaced. The server returns a 400 error if `person.metadata.sources` is not specified for the contact to be updated or if there is no contact source. The server returns a 400 error with reason `"failedPrecondition"` if `person.metadata.sources.etag` is different than the contact's etag, which indicates the contact has changed since its data was read. Clients should get the latest person and merge their updates into the latest person. The server returns a 400 error if `memberships` are being updated and there are no contact group memberships specified on the person. The server returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
Args:
resourceName: string, The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`. (required)
body: object, The request body.
The object takes the form of:
{ # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.
"addresses": [ # The person's street addresses.
{ # A person's physical address. May be a P.O. box or street address. All fields are optional.
"city": "A String", # The city of the address.
"country": "A String", # The country of the address.
"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
"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.
"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.
"metadata": { # Metadata about a field. # Metadata about the address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"poBox": "A String", # The P.O. box of the address.
"postalCode": "A String", # The postal code of the address.
"region": "A String", # The region of the address; for example, the state or province.
"streetAddress": "A String", # The street address.
"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
},
],
"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
"ageRanges": [ # Output only. The person's age ranges.
{ # A person's age range.
"ageRange": "A String", # The age range.
"metadata": { # Metadata about a field. # Metadata about the age range.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"biographies": [ # The person's biographies. This field is a singleton for contact sources.
{ # A person's short biography.
"contentType": "A String", # The content type of the biography.
"metadata": { # Metadata about a field. # Metadata about the biography.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 short biography.
},
],
"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. Clients should always set the `date` field when mutating birthdays.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The structured 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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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", # Prefer to use the `date` field if set. A free-form string representing the user's birthday. This value is not validated.
},
],
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 bragging rights; for example, `climbed mount everest`.
},
],
"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, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
"url": "A String", # The calendar URL.
},
],
"clientData": [ # The person's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"metadata": { # Metadata about a field. # Metadata about the client data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 client specified value of the client data.
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 cover photo.
},
],
"emailAddresses": [ # The person's email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.
{ # A person's email address.
"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.
"metadata": { # Metadata about a field. # Metadata about the email address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
"value": "A String", # The email address.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 event. The type can be custom or one of these predefined values: * `anniversary` * `other`
},
],
"externalIds": [ # The person's external IDs.
{ # An identifier from an external entity 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 external ID.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
"value": "A String", # The value of the external ID.
},
],
"fileAses": [ # The person's file-ases.
{ # The name that should be used to sort the person in a list.
"metadata": { # Metadata about a field. # Metadata about the file-as.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 file-as value
},
],
"genders": [ # The person's genders. This field is a singleton for contact sources.
{ # A person's gender.
"addressMeAs": "A String", # Free form text field for pronouns that should be used to address the person. Common values are: * `he`/`him` * `she`/`her` * `they`/`them`
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
},
],
"imClients": [ # The person's instant messaging clients.
{ # A person's instant messaging client.
"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the IM client.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"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`
"username": "A String", # The user name used in the IM client.
},
],
"interests": [ # The person's interests.
{ # One of the person's interests.
"metadata": { # Metadata about a field. # Metadata about the interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"locales": [ # The person's locale preferences.
{ # A person's locale preference.
"metadata": { # Metadata about a field. # Metadata about the locale.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
},
],
"locations": [ # The person's locations.
{ # A person's location.
"buildingId": "A String", # The building identifier.
"current": True or False, # Whether the location is the current location.
"deskCode": "A String", # The individual desk location.
"floor": "A String", # The floor name or number.
"floorSection": "A String", # The floor section in `floor_name`.
"metadata": { # Metadata about a field. # Metadata about the location.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
"value": "A String", # The free-form value of the location.
},
],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
},
"domainMembership": { # A Google Workspace Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's Google Workspace domain.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"metadata": { # The metadata about a person. # Output only. Metadata about the person.
"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.
"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
"A String",
],
"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for `people.connections.list` requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
"A String",
],
"sources": [ # The sources of data for the person.
{ # The source of a field.
"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
],
},
"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.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 miscellaneous keyword type.
"value": "A String", # The value of the miscellaneous keyword.
},
],
"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.
"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.
"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.
"familyName": "A String", # The family name.
"givenName": "A String", # The given name.
"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
"metadata": { # Metadata about a field. # Metadata about the name.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"middleName": "A String", # The middle name(s).
"phoneticFamilyName": "A String", # The family name spelled as it sounds.
"phoneticFullName": "A String", # The full name spelled as it sounds.
"phoneticGivenName": "A String", # The given name spelled as it sounds.
"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
"unstructuredName": "A String", # The free form name value.
},
],
"nicknames": [ # The person's nicknames.
{ # A person's nickname.
"metadata": { # Metadata about a field. # Metadata about the nickname.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 nickname.
"value": "A String", # The nickname.
},
],
"occupations": [ # The person's occupations.
{ # A person's occupation.
"metadata": { # Metadata about a field. # Metadata about the occupation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"organizations": [ # The person's past or current organizations.
{ # A person's past or current organization. Overlapping date ranges are permitted.
"costCenter": "A String", # The person's cost center 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.
"department": "A String", # The person's department at the organization.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
"fullTimeEquivalentMillipercent": 42, # The person's full-time equivalent millipercent within the organization (100000 = 100%).
"jobDescription": "A String", # The person's job description at the organization.
"location": "A String", # The location of the organization office the person works at.
"metadata": { # Metadata about a field. # Metadata about the organization.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"name": "A String", # The name of the organization.
"phoneticName": "A String", # The phonetic name of 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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
"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`
},
],
"phoneNumbers": [ # The person's phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.
{ # A person's phone number.
"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the phone number.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
"metadata": { # Metadata about a field. # Metadata about the photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the 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`
},
],
"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
{ # **DEPRECATED**: No data will be returned A person's relationship interest .
"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relationship interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
{ # **DEPRECATED**: No data will be returned A person's relationship status.
"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the relationship status.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
},
],
"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
"metadata": { # Metadata about a field. # Metadata about the residence.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 address of the residence.
},
],
"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`.
"sipAddresses": [ # The person's SIP addresses.
{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the SIP address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"skills": [ # The person's skills.
{ # A skill that the person has.
"metadata": { # Metadata about a field. # Metadata about the skill.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 skill; for example, `underwater basket weaving`.
},
],
"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.
"metadata": { # Metadata about a field. # Metadata about the tagline.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 tagline.
},
],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the URL.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"userDefined": [ # The person's user defined data.
{ # Arbitrary user data that is populated by the end users.
"key": "A String", # The end user specified key of the user defined data.
"metadata": { # Metadata about a field. # Metadata about the user defined data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 end user specified value of the user defined data.
},
],
}
personFields: string, Optional. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
sources: string, Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set. (repeated)
Allowed values
READ_SOURCE_TYPE_UNSPECIFIED - Unspecified.
READ_SOURCE_TYPE_PROFILE - Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.
READ_SOURCE_TYPE_CONTACT - Returns SourceType.CONTACT.
READ_SOURCE_TYPE_DOMAIN_CONTACT - Returns SourceType.DOMAIN_CONTACT.
READ_SOURCE_TYPE_OTHER_CONTACT - Returns SourceType.OTHER_CONTACT.
updatePersonFields: string, Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * calendarUrls * clientData * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * sipAddresses * urls * userDefined
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.
"addresses": [ # The person's street addresses.
{ # A person's physical address. May be a P.O. box or street address. All fields are optional.
"city": "A String", # The city of the address.
"country": "A String", # The country of the address.
"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
"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.
"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.
"metadata": { # Metadata about a field. # Metadata about the address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"poBox": "A String", # The P.O. box of the address.
"postalCode": "A String", # The postal code of the address.
"region": "A String", # The region of the address; for example, the state or province.
"streetAddress": "A String", # The street address.
"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
},
],
"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
"ageRanges": [ # Output only. The person's age ranges.
{ # A person's age range.
"ageRange": "A String", # The age range.
"metadata": { # Metadata about a field. # Metadata about the age range.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"biographies": [ # The person's biographies. This field is a singleton for contact sources.
{ # A person's short biography.
"contentType": "A String", # The content type of the biography.
"metadata": { # Metadata about a field. # Metadata about the biography.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 short biography.
},
],
"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. Clients should always set the `date` field when mutating birthdays.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The structured 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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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", # Prefer to use the `date` field if set. A free-form string representing the user's birthday. This value is not validated.
},
],
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 bragging rights; for example, `climbed mount everest`.
},
],
"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, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
"url": "A String", # The calendar URL.
},
],
"clientData": [ # The person's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"metadata": { # Metadata about a field. # Metadata about the client data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 client specified value of the client data.
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 cover photo.
},
],
"emailAddresses": [ # The person's email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.
{ # A person's email address.
"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.
"metadata": { # Metadata about a field. # Metadata about the email address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
"value": "A String", # The email address.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 event. The type can be custom or one of these predefined values: * `anniversary` * `other`
},
],
"externalIds": [ # The person's external IDs.
{ # An identifier from an external entity 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 external ID.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
"value": "A String", # The value of the external ID.
},
],
"fileAses": [ # The person's file-ases.
{ # The name that should be used to sort the person in a list.
"metadata": { # Metadata about a field. # Metadata about the file-as.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 file-as value
},
],
"genders": [ # The person's genders. This field is a singleton for contact sources.
{ # A person's gender.
"addressMeAs": "A String", # Free form text field for pronouns that should be used to address the person. Common values are: * `he`/`him` * `she`/`her` * `they`/`them`
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
},
],
"imClients": [ # The person's instant messaging clients.
{ # A person's instant messaging client.
"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the IM client.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"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`
"username": "A String", # The user name used in the IM client.
},
],
"interests": [ # The person's interests.
{ # One of the person's interests.
"metadata": { # Metadata about a field. # Metadata about the interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"locales": [ # The person's locale preferences.
{ # A person's locale preference.
"metadata": { # Metadata about a field. # Metadata about the locale.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
},
],
"locations": [ # The person's locations.
{ # A person's location.
"buildingId": "A String", # The building identifier.
"current": True or False, # Whether the location is the current location.
"deskCode": "A String", # The individual desk location.
"floor": "A String", # The floor name or number.
"floorSection": "A String", # The floor section in `floor_name`.
"metadata": { # Metadata about a field. # Metadata about the location.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
"value": "A String", # The free-form value of the location.
},
],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
},
"domainMembership": { # A Google Workspace Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's Google Workspace domain.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"metadata": { # The metadata about a person. # Output only. Metadata about the person.
"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.
"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
"A String",
],
"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for `people.connections.list` requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
"A String",
],
"sources": [ # The sources of data for the person.
{ # The source of a field.
"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
],
},
"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.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 miscellaneous keyword type.
"value": "A String", # The value of the miscellaneous keyword.
},
],
"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.
"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.
"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.
"familyName": "A String", # The family name.
"givenName": "A String", # The given name.
"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
"metadata": { # Metadata about a field. # Metadata about the name.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"middleName": "A String", # The middle name(s).
"phoneticFamilyName": "A String", # The family name spelled as it sounds.
"phoneticFullName": "A String", # The full name spelled as it sounds.
"phoneticGivenName": "A String", # The given name spelled as it sounds.
"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
"unstructuredName": "A String", # The free form name value.
},
],
"nicknames": [ # The person's nicknames.
{ # A person's nickname.
"metadata": { # Metadata about a field. # Metadata about the nickname.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 nickname.
"value": "A String", # The nickname.
},
],
"occupations": [ # The person's occupations.
{ # A person's occupation.
"metadata": { # Metadata about a field. # Metadata about the occupation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"organizations": [ # The person's past or current organizations.
{ # A person's past or current organization. Overlapping date ranges are permitted.
"costCenter": "A String", # The person's cost center 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.
"department": "A String", # The person's department at the organization.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
"fullTimeEquivalentMillipercent": 42, # The person's full-time equivalent millipercent within the organization (100000 = 100%).
"jobDescription": "A String", # The person's job description at the organization.
"location": "A String", # The location of the organization office the person works at.
"metadata": { # Metadata about a field. # Metadata about the organization.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"name": "A String", # The name of the organization.
"phoneticName": "A String", # The phonetic name of 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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
"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`
},
],
"phoneNumbers": [ # The person's phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.
{ # A person's phone number.
"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the phone number.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
"metadata": { # Metadata about a field. # Metadata about the photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the 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`
},
],
"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
{ # **DEPRECATED**: No data will be returned A person's relationship interest .
"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relationship interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
{ # **DEPRECATED**: No data will be returned A person's relationship status.
"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the relationship status.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
},
],
"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
"metadata": { # Metadata about a field. # Metadata about the residence.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 address of the residence.
},
],
"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`.
"sipAddresses": [ # The person's SIP addresses.
{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the SIP address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"skills": [ # The person's skills.
{ # A skill that the person has.
"metadata": { # Metadata about a field. # Metadata about the skill.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 skill; for example, `underwater basket weaving`.
},
],
"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.
"metadata": { # Metadata about a field. # Metadata about the tagline.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 tagline.
},
],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the URL.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"userDefined": [ # The person's user defined data.
{ # Arbitrary user data that is populated by the end users.
"key": "A String", # The end user specified key of the user defined data.
"metadata": { # Metadata about a field. # Metadata about the user defined data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 end user specified value of the user defined data.
},
],
}
updateContactPhoto(resourceName, body=None, x__xgafv=None)
Update a contact's photo. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
Args:
resourceName: string, Required. Person resource name (required)
body: object, The request body.
The object takes the form of:
{ # A request to update an existing contact's photo. All requests must have a valid photo format: JPEG or PNG.
"personFields": "A String", # Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * 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
"photoBytes": "A String", # Required. Raw photo bytes
"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",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response for updating a contact's photo.
"person": { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true. # The updated person, if person_fields is set in the UpdateContactPhotoRequest; otherwise this will be unset.
"addresses": [ # The person's street addresses.
{ # A person's physical address. May be a P.O. box or street address. All fields are optional.
"city": "A String", # The city of the address.
"country": "A String", # The country of the address.
"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
"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.
"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.
"metadata": { # Metadata about a field. # Metadata about the address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"poBox": "A String", # The P.O. box of the address.
"postalCode": "A String", # The postal code of the address.
"region": "A String", # The region of the address; for example, the state or province.
"streetAddress": "A String", # The street address.
"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
},
],
"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
"ageRanges": [ # Output only. The person's age ranges.
{ # A person's age range.
"ageRange": "A String", # The age range.
"metadata": { # Metadata about a field. # Metadata about the age range.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"biographies": [ # The person's biographies. This field is a singleton for contact sources.
{ # A person's short biography.
"contentType": "A String", # The content type of the biography.
"metadata": { # Metadata about a field. # Metadata about the biography.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 short biography.
},
],
"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. Clients should always set the `date` field when mutating birthdays.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The structured 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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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", # Prefer to use the `date` field if set. A free-form string representing the user's birthday. This value is not validated.
},
],
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 bragging rights; for example, `climbed mount everest`.
},
],
"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, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
"url": "A String", # The calendar URL.
},
],
"clientData": [ # The person's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"metadata": { # Metadata about a field. # Metadata about the client data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 client specified value of the client data.
},
],
"coverPhotos": [ # Output only. The person's cover photos.
{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
"metadata": { # Metadata about a field. # Metadata about the cover photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 cover photo.
},
],
"emailAddresses": [ # The person's email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.
{ # A person's email address.
"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.
"metadata": { # Metadata about a field. # Metadata about the email address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
"value": "A String", # The email address.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 event. The type can be custom or one of these predefined values: * `anniversary` * `other`
},
],
"externalIds": [ # The person's external IDs.
{ # An identifier from an external entity 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 external ID.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
"value": "A String", # The value of the external ID.
},
],
"fileAses": [ # The person's file-ases.
{ # The name that should be used to sort the person in a list.
"metadata": { # Metadata about a field. # Metadata about the file-as.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 file-as value
},
],
"genders": [ # The person's genders. This field is a singleton for contact sources.
{ # A person's gender.
"addressMeAs": "A String", # Free form text field for pronouns that should be used to address the person. Common values are: * `he`/`him` * `she`/`her` * `they`/`them`
"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.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`
},
],
"imClients": [ # The person's instant messaging clients.
{ # A person's instant messaging client.
"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the IM client.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"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`
"username": "A String", # The user name used in the IM client.
},
],
"interests": [ # The person's interests.
{ # One of the person's interests.
"metadata": { # Metadata about a field. # Metadata about the interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"locales": [ # The person's locale preferences.
{ # A person's locale preference.
"metadata": { # Metadata about a field. # Metadata about the locale.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
},
],
"locations": [ # The person's locations.
{ # A person's location.
"buildingId": "A String", # The building identifier.
"current": True or False, # Whether the location is the current location.
"deskCode": "A String", # The individual desk location.
"floor": "A String", # The floor name or number.
"floorSection": "A String", # The floor section in `floor_name`.
"metadata": { # Metadata about a field. # Metadata about the location.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
"value": "A String", # The free-form value of the location.
},
],
"memberships": [ # The person's group memberships.
{ # A person's membership in a group. Only contact group memberships can be modified.
"contactGroupMembership": { # A Google contact group membership. # The contact group membership.
"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
},
"domainMembership": { # A Google Workspace Domain membership. # Output only. The domain membership.
"inViewerDomain": True or False, # True if the person is in the viewer's Google Workspace domain.
},
"metadata": { # Metadata about a field. # Metadata about the membership.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
},
],
"metadata": { # The metadata about a person. # Output only. Metadata about the person.
"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.
"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
"A String",
],
"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for `people.connections.list` requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
"A String",
],
"sources": [ # The sources of data for the person.
{ # The source of a field.
"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
],
},
"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.
"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 miscellaneous keyword type.
"value": "A String", # The value of the miscellaneous keyword.
},
],
"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.
"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.
"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.
"familyName": "A String", # The family name.
"givenName": "A String", # The given name.
"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
"metadata": { # Metadata about a field. # Metadata about the name.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"middleName": "A String", # The middle name(s).
"phoneticFamilyName": "A String", # The family name spelled as it sounds.
"phoneticFullName": "A String", # The full name spelled as it sounds.
"phoneticGivenName": "A String", # The given name spelled as it sounds.
"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
"unstructuredName": "A String", # The free form name value.
},
],
"nicknames": [ # The person's nicknames.
{ # A person's nickname.
"metadata": { # Metadata about a field. # Metadata about the nickname.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 nickname.
"value": "A String", # The nickname.
},
],
"occupations": [ # The person's occupations.
{ # A person's occupation.
"metadata": { # Metadata about a field. # Metadata about the occupation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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`.
},
],
"organizations": [ # The person's past or current organizations.
{ # A person's past or current organization. Overlapping date ranges are permitted.
"costCenter": "A String", # The person's cost center 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.
"department": "A String", # The person's department at the organization.
"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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
"fullTimeEquivalentMillipercent": 42, # The person's full-time equivalent millipercent within the organization (100000 = 100%).
"jobDescription": "A String", # The person's job description at the organization.
"location": "A String", # The location of the organization office the person works at.
"metadata": { # Metadata about a field. # Metadata about the organization.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
},
"name": "A String", # The name of the organization.
"phoneticName": "A String", # The phonetic name of 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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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.
},
"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
"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`
},
],
"phoneNumbers": [ # The person's phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.
{ # A person's phone number.
"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the phone number.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"photos": [ # Output only. The person's photos.
{ # A person's photo. A picture shown next to the person's name to help others recognize the person.
"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.
"metadata": { # Metadata about a field. # Metadata about the photo.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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
},
],
"relations": [ # The person's relations.
{ # A person's relation to another person.
"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relation.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the 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`
},
],
"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
{ # **DEPRECATED**: No data will be returned A person's relationship interest .
"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
"metadata": { # Metadata about a field. # Metadata about the relationship interest.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
},
],
"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
{ # **DEPRECATED**: No data will be returned A person's relationship status.
"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the relationship status.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
},
],
"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
"metadata": { # Metadata about a field. # Metadata about the residence.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 address of the residence.
},
],
"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`.
"sipAddresses": [ # The person's SIP addresses.
{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the SIP address.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
},
],
"skills": [ # The person's skills.
{ # A skill that the person has.
"metadata": { # Metadata about a field. # Metadata about the skill.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 skill; for example, `underwater basket weaving`.
},
],
"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.
{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.
"metadata": { # Metadata about a field. # Metadata about the tagline.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 tagline.
},
],
"urls": [ # The person's associated URLs.
{ # A person's associated URLs.
"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
"metadata": { # Metadata about a field. # Metadata about the URL.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 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.
},
],
"userDefined": [ # The person's user defined data.
{ # Arbitrary user data that is populated by the end users.
"key": "A String", # The end user specified key of the user defined data.
"metadata": { # Metadata about a field. # Metadata about the user defined data.
"primary": True or False, # Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
"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.
"id": "A String", # The unique identifier within the source type generated by the server.
"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
"objectType": "A String", # Output only. The profile object type.
"userTypes": [ # Output only. The user types.
"A String",
],
},
"type": "A String", # The source type.
"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
},
"sourcePrimary": True or False, # True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
"verified": True or False, # Output only. True if the field is verified; false if the field is 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 end user specified value of the user defined data.
},
],
},
}