GoogleApi.People.V1.Api.People.people_people_list_directory_people

You're seeing just the function people_people_list_directory_people, go back to GoogleApi.People.V1.Api.People module for more information.
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