type Location (v202411)

  • A Location object represents a targetable geographical entity like a country, city, or state, and is categorized by its type and ID.

  • Locations are hierarchical, with canonicalParentId indicating the nearest parent location in the geographical hierarchy.

  • Each Location has a unique ID, a type indicating its geographical classification, a parent ID for hierarchy, and a localized display name.

  • The API version you use determines the available location types, with older versions potentially representing locations using only the base class instead of specific subtypes.

A Location represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.


Namespace
https://www.google.com/apis/ads/publisher/v202411

Field

id

xsd:long

Uniquely identifies each Location.

type

xsd:string

The location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)

canonicalParentId

xsd:int

The nearest location parent's ID for this geographical entity.

displayName

xsd:string

The localized name of the geographical entity.