GoogleApi.People.V1.Api.OtherContacts.people_other_contacts_list
You're seeing just the function
people_other_contacts_list
, go back to GoogleApi.People.V1.Api.OtherContacts module for more information.
Link to this function
people_other_contacts_list(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
people_other_contacts_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.People.V1.Model.ListOtherContactsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
List all "Other contacts", that is contacts that are not in a contact group. "Other contacts" are typically auto created contacts from interactions.
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 "Other contacts" to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0. -
:pageToken
(type:String.t
) - Optional. A page token, received from a previousListOtherContacts
call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListOtherContacts
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: emailAddresses metadata names phoneNumbers -
:requestSyncToken
(type:boolean()
) - Optional. Whether the response should includenext_sync_token
, which can be used to get all changes since the last request. For subsequent sync requests use thesync_token
param instead. Initial sync requests that specifyrequest_sync_token
have an additional rate limit. -
:syncToken
(type:String.t
) - Optional. A sync token, received from a previousListOtherContacts
call. Provide this to retrieve only the resources changed since the last request. Sync requests that specifysync_token
have an additional rate limit. When thesyncToken
is specified, resources deleted since the last sync will be returned as a person withPersonMetadata.deleted
set to true. When thesyncToken
is specified, all other parameters provided toListOtherContacts
must match the call that provided the sync token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.People.V1.Model.ListOtherContactsResponse{}}
on success -
{:error, info}
on failure