Namespace Google.Apis.PeopleService.v1
Classes
ContactGroupsResource
The "contactGroups" collection of methods.
ContactGroupsResource.BatchGetRequest
Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.
ContactGroupsResource.CreateRequest
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.
ContactGroupsResource.DeleteRequest
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.
ContactGroupsResource.GetRequest
Get a specific contact group owned by the authenticated user by specifying a contact group resource name.
ContactGroupsResource.ListRequest
List all contact groups owned by the authenticated user. Members of the contact groups are not populated.
ContactGroupsResource.MembersResource
The "members" collection of methods.
ContactGroupsResource.MembersResource.ModifyRequest
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.
ContactGroupsResource.UpdateRequest
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.
OtherContactsResource
The "otherContacts" collection of methods.
OtherContactsResource.CopyOtherContactToMyContactsGroupRequest
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.
OtherContactsResource.ListRequest
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.
OtherContactsResource.SearchRequest
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
PeopleResource
The "people" collection of methods.
PeopleResource.BatchCreateContactsRequest
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.
PeopleResource.BatchDeleteContactsRequest
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.
PeopleResource.BatchUpdateContactsRequest
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.
PeopleResource.ConnectionsResource
The "connections" collection of methods.
PeopleResource.ConnectionsResource.ListRequest
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.
PeopleResource.CreateContactRequest
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.
PeopleResource.DeleteContactPhotoRequest
Delete a contact's photo. Mutate requests for the same user should be done sequentially to avoid // lock contention.
PeopleResource.DeleteContactRequest
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.
PeopleResource.GetBatchGetRequest
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.
PeopleResource.GetRequest
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.
PeopleResource.ListDirectoryPeopleRequest
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.
PeopleResource.SearchContactsRequest
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
PeopleResource.SearchDirectoryPeopleRequest
Provides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query.
PeopleResource.UpdateContactPhotoRequest
Update a contact's photo. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
PeopleResource.UpdateContactRequest
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.
PeopleServiceBaseServiceRequest<TResponse>
A base abstract class for PeopleService requests.
PeopleServiceService
The PeopleService Service.
PeopleServiceService.Scope
Available OAuth 2.0 scopes for use with the People API.
PeopleServiceService.ScopeConstants
Available OAuth 2.0 scope constants for use with the People API.
Enums
OtherContactsResource.ListRequest.SourcesEnum
Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set. Possible values for this field are: * READ_SOURCE_TYPE_CONTACT * READ_SOURCE_TYPE_CONTACT,READ_SOURCE_TYPE_PROFILE Specifying READ_SOURCE_TYPE_PROFILE without specifying READ_SOURCE_TYPE_CONTACT is not permitted.
PeopleResource.ConnectionsResource.ListRequest.SortOrderEnum
Optional. The order in which the connections should be sorted. Defaults to
LAST_MODIFIED_ASCENDING
.
PeopleResource.ConnectionsResource.ListRequest.SourcesEnum
Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
PeopleResource.CreateContactRequest.SourcesEnum
Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
PeopleResource.DeleteContactPhotoRequest.SourcesEnum
Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
PeopleResource.GetBatchGetRequest.SourcesEnum
Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
PeopleResource.GetRequest.SourcesEnum
Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_PROFILE and READ_SOURCE_TYPE_CONTACT if not set.
PeopleResource.ListDirectoryPeopleRequest.MergeSourcesEnum
Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.
PeopleResource.ListDirectoryPeopleRequest.SourcesEnum
Required. Directory sources to return.
PeopleResource.SearchContactsRequest.SourcesEnum
Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set.
PeopleResource.SearchDirectoryPeopleRequest.MergeSourcesEnum
Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.
PeopleResource.SearchDirectoryPeopleRequest.SourcesEnum
Required. Directory sources to return.
PeopleResource.UpdateContactRequest.SourcesEnum
Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
PeopleServiceBaseServiceRequest<TResponse>.AltEnum
Data format for response.
PeopleServiceBaseServiceRequest<TResponse>.XgafvEnum
V1 error format.