Method: cities.list

  • This API call retrieves a list of cities, with optional filtering.

  • The request uses a GET method to the specified URL, including a required profileId path parameter.

  • You can filter the results using various query parameters like namePrefix, countryDartIds, dartIds, and regionDartIds.

  • The request body is empty, and a successful response returns a JSON object containing a list of cities.

  • The request requires the https://www.googleapis.com/auth/dfatrafficking authorization scope.

Retrieves a list of cities, possibly filtered.

HTTP request

GET https://dfareporting.googleapis.com/dfareporting/v5/userprofiles/{profileId}/cities

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
profileId

string (int64 format)

User profile ID associated with this request.

Query parameters

Parameters
namePrefix

string

Select only cities with names starting with this prefix.
countryDartIds[]

string (int64 format)

Select only cities from these countries.
dartIds[]

string (int64 format)

Select only cities with these DART IDs.
regionDartIds[]

string (int64 format)

Select only cities from these regions.

Request body

The request body must be empty.

Response body

City cities.list Response

If successful, the response body contains data with the following structure:

JSON representation 
{
  "kind": string,
  "cities": [
    {
      object (City)
    }
  ]
}
Fields
kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#citiesListResponse"

.
cities[]

object (City)

City collection.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/dfatrafficking