Method: cities.list
Stay organized with collections
Save and categorize content based on your preferences.
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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eRetrieves a list of cities, filtered by name prefix, country, region, or DART IDs.\u003c/p\u003e\n"],["\u003cp\u003eThe request is a GET request to the specified URL, with filtering options provided as query parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of cities matching the criteria, along with resource kind information.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003edfatrafficking\u003c/code\u003e scope.\u003c/p\u003e\n"]]],[],null,["# Method: cities.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.CitiesListResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nRetrieves a list of cities, possibly filtered.\n\n### HTTP request\n\n`GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/cities`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `profile``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` User profile ID associated with this request. |\n\n### Query parameters\n\n| Parameters ||\n|------------------------|------------------------------------------------------------------------------------------------------------------------------|\n| `name``Prefix` | `string` Select only cities with names starting with this prefix. |\n| `country``Dart``Ids[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only cities from these countries. |\n| `dart``Ids[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only cities with these DART IDs. |\n| `region``Dart``Ids[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only cities from these regions. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nCity cities.list Response\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"cities\": [ { object (/doubleclick-advertisers/rest/v4/GeoTargeting#City) } ] } ``` |\n\n| Fields ||\n|------------|------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#citiesListResponse\"` . |\n| `cities[]` | `object (`[City](/doubleclick-advertisers/rest/v4/GeoTargeting#City)`)` City collection. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/dfatrafficking`"]]
