GoogleApi.People.V1.Api.People.people_people_connections_list
You're seeing just the function
people_people_connections_list
, go back to GoogleApi.People.V1.Api.People module for more information.
Link to this function
people_people_connections_list(connection, people_id, optional_params \\ [], opts \\ [])
View SourceSpecs
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 ofresourceName
. Required. The resource name to return connections for. Onlypeople/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 previousListConnections
call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListConnections
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 withperson.
: for example,person.names
orperson.photos
. -
:requestSyncToken
(type:boolean()
) - Optional. Whether the response should includenext_sync_token
on the last page, which can be used to get all changes since the last request. For subsequent sync requests use thesync_token
param instead. Initial full sync requests that specifyrequest_sync_token
and do not specifysync_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 toLAST_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 previousListConnections
call. Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided toListConnections
exceptpage_size
andpage_token
must match the initial call that provided the sync token. Sync tokens expire after seven days, after which a full sync request without async_token
should be made.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.People.V1.Model.ListConnectionsResponse{}}
on success -
{:error, info}
on failure