GoogleApi.People.V1.Api.People (google_api_people v0.37.3) View Source

API calls for all endpoints tagged People.

Link to this section Summary

Functions

Create a batch of new contacts and return the PersonResponses for the newly created contacts. Limited to 10 parallel requests per user.

Delete a batch of contacts. Any non-contact data will not be deleted. Limited to 10 parallel requests per user.

Update a batch of contacts and return a map of resource names to PersonResponses for the updated contacts. Limited to 10 parallel requests per user.

Provides a list of the authenticated user's contacts. The request returns a 400 error if personFields is not specified. The request returns a 410 error if sync_token is specified and is expired. Sync tokens expire after 7 days to prevent data drift between clients and the server. To handle a sync token expired error, a request should be sent without sync_token to get all contacts.

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

Delete a contact person. Any non-contact data will not be deleted.

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.

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

Link to this section Functions

Link to this function

people_people_batch_create_contacts(connection, optional_params \\ [], opts \\ [])

View Source

Specs

people_people_batch_create_contacts(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.People.V1.Model.BatchCreateContactsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Create a batch of new contacts and return the PersonResponses for the newly created contacts. Limited to 10 parallel requests per user.

Parameters

  • connection (type: GoogleApi.People.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.People.V1.Model.BatchCreateContactsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.People.V1.Model.BatchCreateContactsResponse{}} on success
  • {:error, info} on failure
Link to this function

people_people_batch_delete_contacts(connection, optional_params \\ [], opts \\ [])

View Source

Specs

people_people_batch_delete_contacts(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.People.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Delete a batch of contacts. Any non-contact data will not be deleted. Limited to 10 parallel requests per user.

Parameters

  • connection (type: GoogleApi.People.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.People.V1.Model.BatchDeleteContactsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.People.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

people_people_batch_update_contacts(connection, optional_params \\ [], opts \\ [])

View Source

Specs

people_people_batch_update_contacts(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.People.V1.Model.BatchUpdateContactsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Update a batch of contacts and return a map of resource names to PersonResponses for the updated contacts. Limited to 10 parallel requests per user.

Parameters

  • connection (type: GoogleApi.People.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.People.V1.Model.BatchUpdateContactsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.People.V1.Model.BatchUpdateContactsResponse{}} on success
  • {:error, info} on failure
Link to this function

people_people_connections_list(connection, people_id, optional_params \\ [], opts \\ [])

View Source

Specs

people_people_connections_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.People.V1.Model.ListConnectionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Provides a list of the authenticated user's contacts. The request returns a 400 error if personFields is not specified. The request returns a 410 error if sync_token is specified and is expired. Sync tokens expire after 7 days to prevent data drift between clients and the server. To handle a sync token expired error, a request should be sent without sync_token to get all contacts.

Parameters

  • connection (type: GoogleApi.People.V1.Connection.t) - Connection to server
  • people_id (type: String.t) - Part of resourceName. Required. The resource name to return connections for. Only people/me is valid.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The number of connections to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.
    • :pageToken (type: String.t) - Optional. A page token, received from a previous ListConnections call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListConnections must match the call that provided the page token.
    • :personFields (type: String.t) - 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" (type: String.t) - 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.
    • :requestSyncToken (type: boolean()) - Optional. Whether the response should include next_sync_token on the last page, which can be used to get all changes since the last request. For subsequent sync requests use the sync_token param instead. Initial full sync requests that specify request_sync_token and do not specify sync_token have an additional rate limit per user. Each client should generally only be doing a full sync once every few days per user and so should not hit this limit.
    • :sortOrder (type: String.t) - Optional. The order in which the connections should be sorted. Defaults to LAST_MODIFIED_ASCENDING.
    • :sources (type: list(String.t)) - Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
    • :syncToken (type: String.t) - Optional. A sync token, received from a previous ListConnections call. Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to ListConnections except page_size and page_token must match the initial call that provided the sync token. Sync tokens expire after seven days, after which a full sync request without a sync_token should be made.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.People.V1.Model.ListConnectionsResponse{}} on success
  • {:error, info} on failure
Link to this function

people_people_create_contact(connection, optional_params \\ [], opts \\ [])

View Source

Specs

people_people_create_contact(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.People.V1.Model.Person.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.People.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :personFields (type: String.t) - 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 (type: list(String.t)) - Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
    • :body (type: GoogleApi.People.V1.Model.Person.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.People.V1.Model.Person{}} on success
  • {:error, info} on failure
Link to this function

people_people_delete_contact(connection, people_id, optional_params \\ [], opts \\ [])

View Source

Specs

people_people_delete_contact(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.People.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Delete a contact person. Any non-contact data will not be deleted.

Parameters

  • connection (type: GoogleApi.People.V1.Connection.t) - Connection to server
  • people_id (type: String.t) - Part of resourceName. Required. The resource name of the contact to delete.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.People.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

people_people_delete_contact_photo(connection, people_id, optional_params \\ [], opts \\ [])

View Source

Specs

people_people_delete_contact_photo(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.People.V1.Model.DeleteContactPhotoResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Delete a contact's photo.

Parameters

  • connection (type: GoogleApi.People.V1.Connection.t) - Connection to server
  • people_id (type: String.t) - Part of resourceName. Required. The resource name of the contact whose photo will be deleted.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :personFields (type: String.t) - 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 (type: list(String.t)) - Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.People.V1.Model.DeleteContactPhotoResponse{}} on success
  • {:error, info} on failure
Link to this function

people_people_get(connection, people_id, optional_params \\ [], opts \\ [])

View Source

Specs

people_people_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.People.V1.Model.Person.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.People.V1.Connection.t) - Connection to server
  • people_id (type: String.t) - Part of resourceName. 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.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :personFields (type: String.t) - 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" (type: String.t) - 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 (type: list(String.t)) - Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_PROFILE and READ_SOURCE_TYPE_CONTACT if not set.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.People.V1.Model.Person{}} on success
  • {:error, info} on failure
Link to this function

people_people_get_batch_get(connection, optional_params \\ [], opts \\ [])

View Source

Specs

people_people_get_batch_get(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.People.V1.Model.GetPeopleResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.People.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :personFields (type: String.t) - 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" (type: String.t) - 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 (type: list(String.t)) - 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.
    • :sources (type: list(String.t)) - Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.People.V1.Model.GetPeopleResponse{}} on success
  • {:error, info} on failure
Link to this function

people_people_list_directory_people(connection, optional_params \\ [], opts \\ [])

View Source

Specs

people_people_list_directory_people(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.People.V1.Model.ListDirectoryPeopleResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Provides a list of domain profiles and domain contacts in the authenticated user's domain directory.

Parameters

  • connection (type: GoogleApi.People.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :mergeSources (type: list(String.t)) - Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.
    • :pageSize (type: 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 (type: String.t) - Optional. A page token, received from a previous ListDirectoryPeople call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDirectoryPeople must match the call that provided the page token.
    • :readMask (type: String.t) - 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 (type: boolean()) - Optional. Whether the response should include next_sync_token, which can be used to get all changes since the last request. For subsequent sync requests use the sync_token param instead.
    • :sources (type: list(String.t)) - Required. Directory sources to return.
    • :syncToken (type: String.t) - Optional. A sync token, received from a previous ListDirectoryPeople call. Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to ListDirectoryPeople must match the call that provided the sync token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.People.V1.Model.ListDirectoryPeopleResponse{}} on success
  • {:error, info} on failure
Link to this function

people_people_search_contacts(connection, optional_params \\ [], opts \\ [])

View Source

Specs

people_people_search_contacts(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.People.V1.Model.SearchResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.People.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 10 will be capped to 10.
    • :query (type: String.t) - 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 (type: String.t) - 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 (type: list(String.t)) - Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.People.V1.Model.SearchResponse{}} on success
  • {:error, info} on failure
Link to this function

people_people_search_directory_people(connection, optional_params \\ [], opts \\ [])

View Source

Specs

people_people_search_directory_people(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.People.V1.Model.SearchDirectoryPeopleResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Provides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query.

Parameters

  • connection (type: GoogleApi.People.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :mergeSources (type: list(String.t)) - Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.
    • :pageSize (type: 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 (type: String.t) - Optional. A page token, received from a previous SearchDirectoryPeople call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchDirectoryPeople must match the call that provided the page token.
    • :query (type: String.t) - Required. Prefix query that matches fields in the person. Does NOT use the read_mask for determining what fields to match.
    • :readMask (type: String.t) - 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 (type: list(String.t)) - Required. Directory sources to return.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.People.V1.Model.SearchDirectoryPeopleResponse{}} on success
  • {:error, info} on failure
Link to this function

people_people_update_contact(connection, people_id, optional_params \\ [], opts \\ [])

View Source

Specs

people_people_update_contact(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.People.V1.Model.Person.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.People.V1.Connection.t) - Connection to server
  • people_id (type: String.t) - Part of person.resourceName. The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of people/{person_id}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :personFields (type: String.t) - 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 (type: list(String.t)) - Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
    • :updatePersonFields (type: String.t) - 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
    • :body (type: GoogleApi.People.V1.Model.Person.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.People.V1.Model.Person{}} on success
  • {:error, info} on failure
Link to this function

people_people_update_contact_photo(connection, people_id, optional_params \\ [], opts \\ [])

View Source

Specs

people_people_update_contact_photo(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.People.V1.Model.UpdateContactPhotoResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Update a contact's photo.

Parameters

  • connection (type: GoogleApi.People.V1.Connection.t) - Connection to server
  • people_id (type: String.t) - Part of resourceName. Required. Person resource name
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.People.V1.Model.UpdateContactPhotoRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.People.V1.Model.UpdateContactPhotoResponse{}} on success
  • {:error, info} on failure