List
|
|||||
|
|
||||
Retrieves a list of cities, possibly filtered
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns
Input
This building block consumes 5 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
countryDartIds |
INTEGER |
Select only cities from these countries |
dartIds |
INTEGER |
Select only cities with these DART IDs |
namePrefix |
STRING |
Select only cities with names starting with this prefix |
regionDartIds |
INTEGER |
Select only cities from these regions |
= Parameter name
= Format
|
profileId INTEGER Required User profile ID associated with this request |
|
countryDartIds INTEGER Select only cities from these countries |
|
dartIds INTEGER Select only cities with these DART IDs |
|
namePrefix STRING Select only cities with names starting with this prefix |
|
regionDartIds INTEGER Select only cities from these regions |
Output
This building block provides 11 output parameters
| Name | Format | Description |
|---|---|---|
cities[] |
OBJECT |
Contains information about a city that can be targeted by ads |
cities[].countryCode |
STRING |
Country code of the country to which this city belongs |
cities[].countryDartId |
INTEGER |
DART ID of the country to which this city belongs |
cities[].dartId |
INTEGER |
DART ID of this city. This is the ID used for targeting and generating reports |
cities[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#city" |
cities[].metroCode |
STRING |
Metro region code of the metro region (DMA) to which this city belongs |
cities[].metroDmaId |
INTEGER |
ID of the metro region (DMA) to which this city belongs |
cities[].name |
STRING |
Name of this city |
cities[].regionCode |
STRING |
Region code of the region to which this city belongs |
cities[].regionDartId |
INTEGER |
DART ID of the region to which this city belongs |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse" |
= Parameter name
= Format
|
cities[] OBJECT Contains information about a city that can be targeted by ads |
|
cities[].countryCode STRING Country code of the country to which this city belongs |
|
cities[].countryDartId INTEGER DART ID of the country to which this city belongs |
|
cities[].dartId INTEGER DART ID of this city. This is the ID used for targeting and generating reports |
|
cities[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#city" |
|
cities[].metroCode STRING Metro region code of the metro region (DMA) to which this city belongs |
|
cities[].metroDmaId INTEGER ID of the metro region (DMA) to which this city belongs |
|
cities[].name STRING Name of this city |
|
cities[].regionCode STRING Region code of the region to which this city belongs |
|
cities[].regionDartId INTEGER DART ID of the region to which this city belongs |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse" |