GoogleApi.DFAReporting.V4.Api.Cities (google_api_dfa_reporting v0.31.0)

View Source

API calls for all endpoints tagged Cities.

Summary

Functions

dfareporting_cities_list(connection, profile_id, optional_params \\ [], opts \\ [])

@spec dfareporting_cities_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.DFAReporting.V4.Model.CitiesListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a list of cities, possibly filtered.

Parameters

  • connection (type: GoogleApi.DFAReporting.V4.Connection.t) - Connection to server
  • profile_id (type: String.t) - User profile ID associated with this request.
  • 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").
    • :countryDartIds (type: list(String.t)) - Select only cities from these countries.
    • :dartIds (type: list(String.t)) - Select only cities with these DART IDs.
    • :namePrefix (type: String.t) - Select only cities with names starting with this prefix.
    • :regionDartIds (type: list(String.t)) - Select only cities from these regions.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DFAReporting.V4.Model.CitiesListResponse{}} on success
  • {:error, info} on failure