Method: cities.list

  • This API call retrieves a list of cities, which can be filtered using query parameters.

  • The HTTP request uses a GET method to the specified URL, including a profile ID in the path.

  • Optional query parameters like namePrefix, countryDartIds, dartIds, and regionDartIds can be used to refine the city list.

  • The request body must be empty.

  • The response body contains a JSON object with the kind and cities fields, where cities is an array of city objects.

Retrieves a list of cities, possibly filtered.

HTTP request

GET https://dfareporting.googleapis.com/dfareporting/v4/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