google_api_dfa_reporting v0.17.0 GoogleApi.DFAReporting.V34.Api.Cities View Source
API calls for all endpoints tagged Cities
.
Link to this section Summary
Functions
Retrieves a list of cities, possibly filtered.
Link to this section Functions
Link to this function
dfareporting_cities_list(connection, profile_id, optional_params \\ [], opts \\ [])
View SourceSpecs
dfareporting_cities_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.DFAReporting.V34.Model.CitiesListResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieves a list of cities, possibly filtered.
Parameters
-
connection
(type:GoogleApi.DFAReporting.V34.Connection.t
) - Connection to server -
profile_id
(type:String.t
) - User profile ID associated with this request. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead. -
: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.V34.Model.CitiesListResponse{}}
on success -
{:error, info}
on failure