A person’s physical address. May be a P.O. box or street address. All fields are optional.
A person’s age range.
A request to create a batch of contacts.
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.
A request to delete a batch of existing contacts.
The response to a batch get contact groups request.
A request to update a batch of contacts.
If not successful, returns BatchUpdateContactsErrorDetails, a list of errors corresponding to each contact. The response to a request to update a batch of contacts.
A person’s short biography.
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.
DEPRECATED: No data will be returned A person’s bragging rights.
A person’s calendar URL.
Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
A contact group.
Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.
Create a new contact group owned by the authenticated user. Created contact group names must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
Delete an existing contact group owned by the authenticated user by specifying a contact group resource name. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
Get a specific contact group owned by the authenticated user by specifying a contact group resource name.
List all contact groups owned by the authenticated user. Members of the contact groups are not populated.
Modify the members of a contact group owned by the authenticated user. The only system contact groups that can have members added are contactGroups/myContacts and contactGroups/starred. Other system contact groups are deprecated and can only have contacts removed.
A Google contact group membership.
The metadata about a contact group.
A builder providing access to all methods supported on
contactGroup resources.
It is not used directly, but through the
PeopleService hub.
The response for a specific contact group.
Update the name of an existing contact group owned by the authenticated user. Updated contact group names must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
A wrapper that contains the person data to populate a newly created source.
A request to copy an “Other contact” to my contacts group.
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.
A request to create a new contact group.
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 response for deleting a contact’s photo.
A Google Workspace Domain membership.
A person’s email address.
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); }
An event related to the person.
An identifier from an external entity related to the person.
Metadata about a field.
The name that should be used to sort the person in a list.
A person’s gender.
The response to a get request for a list of people by resource name.
Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
A person’s instant messaging client.
One of the person’s interests.
The response to a request for the authenticated user’s connections.
The response to a list contact groups request.
The response to a request for the authenticated user’s domain directory.
The response to a request for the authenticated user’s “Other contacts”.
A person’s locale preference.
A person’s location.
A person’s membership in a group. Only contact group memberships can be modified.
A person’s miscellaneous keyword.
A request to modify an existing contact group’s members. Contacts can be removed from any group but they can only be added to a user group or “myContacts” or “starred” system groups.
The response to a modify contact group members request.
A person’s name. If the name is a mononym, the family name is empty.
A person’s nickname.
A person’s occupation.
A person’s past or current organization. Overlapping date ranges are permitted.
Copies an “Other contact” to a new contact in the user’s “myContacts” group Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
List all “Other contacts”, that is contacts that are not in a contact group. “Other contacts” are typically auto created contacts from interactions. Sync tokens expire 7 days after the full sync. A request with an expired sync token will get an error with an
google.rpc.ErrorInfo with reason “EXPIRED_SYNC_TOKEN”. In the case of such an error clients should make a full sync request without a
sync_token. The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fixed and can not be increased. 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 user’s other contacts that have changed.
A builder providing access to all methods supported on
otherContact resources.
It is not used directly, but through the
PeopleService hub.
Provides a list of contacts in the authenticated user’s other contacts that matches the search query. The query matches on a contact’s names, emailAddresses, and phoneNumbers fields that are from the OTHER_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/other-contacts#search_the_users_other_contacts
Central instance to access all PeopleService related resource activities
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.
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.
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.
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.
Provides a list of the authenticated user’s contacts. Sync tokens expire 7 days after the full sync. A request with an expired sync token will get an error with an
google.rpc.ErrorInfo with reason “EXPIRED_SYNC_TOKEN”. In the case of such an error clients should make a full sync request without a
sync_token. The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fixed and can not be increased. 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 user’s contacts that have changed.
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.
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.
Delete a contact’s photo. Mutate requests for the same user should be done sequentially to avoid // lock contention.
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 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 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.
The metadata about a person.
A builder providing access to all methods supported on
person resources.
It is not used directly, but through the
PeopleService hub.
The response for a single person
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.
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.
Update a contact’s photo. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
A person’s phone number.
A person’s photo. A picture shown next to the person’s name to help others recognize the person.
The metadata about a profile.
A person’s relation to another person.
DEPRECATED: No data will be returned A person’s relationship interest .
DEPRECATED: No data will be returned A person’s relationship status.
DEPRECATED: Please use person.locations instead. A person’s past or current residence.
The response to a request for people in the authenticated user’s domain directory that match the specified query.
The response to a search request for the authenticated user, given a query.
A result of a search query.
A person’s SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
A skill that the person has.
The source of a field.
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. 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.
DEPRECATED: No data will be returned A brief one-line description of the person.
A request to update an existing user contact group. All updated fields will be replaced.
A request to update an existing contact’s photo. All requests must have a valid photo format: JPEG or PNG.
The response for updating a contact’s photo.
A person’s associated URLs.
Arbitrary user data that is populated by the end users.