GoogleApi.People.V1.Api.ContactGroups.people_contact_groups_list

You're seeing just the function people_contact_groups_list, go back to GoogleApi.People.V1.Api.ContactGroups module for more information.
Link to this function

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

View Source

Specs

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

List all contact groups owned by the authenticated user. Members of the contact groups are not populated.

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").
    • :groupFields (type: String.t) - Optional. A field mask to restrict which fields on the group are returned. Defaults to metadata, groupType, memberCount, and name if not set or set to empty. Valid fields are: clientData groupType memberCount metadata * name
    • :pageSize (type: integer()) - Optional. The maximum number of resources to return. Valid values are between 1 and 1000, inclusive. Defaults to 30 if not set or set to 0.
    • :pageToken (type: String.t) - Optional. The next_page_token value returned from a previous call to ListContactGroups. Requests the next page of resources.
    • :syncToken (type: String.t) - Optional. A sync token, returned by a previous call to contactgroups.list. Only resources changed since the sync token was created will be returned.
  • opts (type: keyword()) - Call options

Returns

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