GoogleApi.People.V1.Api.People.people_people_get_batch_get
You're seeing just the function
people_people_get_batch_get
, go back to GoogleApi.People.V1.Api.People module for more information.
Link to this function
people_people_get_batch_get(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
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 withperson.
: for example,person.names
orperson.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, specifypeople/me
. - To get information about a google account, specifypeople/{account_id}
. - To get information about a contact, specify the resource name that identifies the contact as returned bypeople.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