GeoTargeting

  • Geographical targeting allows you to target or exclude ads based on countries, regions, cities, metros, and postal codes.

  • When targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.

  • Regions, cities, and metros can be targeted, but if a more specific location within them is targeted, do not target the broader area or its country.

  • For countries, regions, cities, metros, and postal codes, typically only a specific ID (dartId, dmaId, or id) is required for targeting, with other fields being automatically populated.

Geographical Targeting.

JSON representation 
{
  "excludeCountries": boolean,
  "countries": [
    {
      object (Country)
    }
  ],
  "regions": [
    {
      object (Region)
    }
  ],
  "cities": [
    {
      object (City)
    }
  ],
  "metros": [
    {
      object (Metro)
    }
  ],
  "postalCodes": [
    {
      object (PostalCode)
    }
  ]
}
Fields
excludeCountries

boolean

Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
countries[]

object (Country)

Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
regions[]

object (Region)

Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
cities[]

object (City)

Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
metros[]

object (Metro)

Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
postalCodes[]

object (PostalCode)

Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.

Region

Contains information about a region that can be targeted by ads.

JSON representation 
{
  "dartId": string,
  "name": string,
  "countryCode": string,
  "countryDartId": string,
  "regionCode": string,
  "kind": string
}
Fields
dartId

string (int64 format)

DART ID of this region.
name

string

Name of this region.
countryCode

string

Country code of the country to which this region belongs.
countryDartId

string (int64 format)

DART ID of the country to which this region belongs.
regionCode

string

Region code.
kind

string

Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".

City

Contains information about a city that can be targeted by ads.

JSON representation 
{
  "dartId": string,
  "name": string,
  "countryCode": string,
  "countryDartId": string,
  "regionCode": string,
  "regionDartId": string,
  "metroCode": string,
  "metroDmaId": string,
  "kind": string
}
Fields
dartId

string (int64 format)

DART ID of this city. This is the ID used for targeting and generating reports.
name

string

Name of this city.
countryCode

string

Country code of the country to which this city belongs.
countryDartId

string (int64 format)

DART ID of the country to which this city belongs.
regionCode

string

Region code of the region to which this city belongs.
regionDartId

string (int64 format)

DART ID of the region to which this city belongs.
metroCode

string

Metro region code of the metro region (DMA) to which this city belongs.
metroDmaId

string (int64 format)

ID of the metro region (DMA) to which this city belongs.
kind

string

Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".

Metro

Contains information about a metro region that can be targeted by ads.

JSON representation 
{
  "dmaId": string,
  "dartId": string,
  "name": string,
  "metroCode": string,
  "countryCode": string,
  "countryDartId": string,
  "kind": string
}
Fields
dmaId

string (int64 format)

DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metroCode.
dartId

string (int64 format)

DART ID of this metro region.
name

string

Name of this metro region.
metroCode

string

Metro code of this metro region. This is equivalent to dmaId.
countryCode

string

Country code of the country to which this metro region belongs.
countryDartId

string (int64 format)

DART ID of the country to which this metro region belongs.
kind

string

Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".