Skip to main content
Locations are the containers for your screens. Each location represents a physical place (mall, airport, gym, office building, etc.) where one or more screens are installed. Locations hold geo-coordinates, opening hours, and visitor estimates. They go through an approval workflow before they can receive ads.
You must create a location before you can add screens to it. Screens inherit their geographic context from their parent location.

The Location object

FieldTypeDescription
location_idstringUnique identifier assigned by the system
titlestringHuman-readable location name
statusstringApproval status: DRAFT, REVIEW, or APPROVED
available_for_adsbooleanWhether ads can be delivered to screens at this location
venue_type_idstringLevel 2 venue type ID (see Venue Types)
latfloatLatitude (-90 to 90)
longfloatLongitude (-180 to 180)
opening_168boolean[168]Hourly open/closed schedule (see Opening 168)
visitors_7int[7]Daily visitor estimates, Monday through Sunday (see Visitors 7)
archivedbooleanWhether the location is hidden from the dashboard
timezonestringIANA timezone, auto-derived from coordinates (e.g., Europe/Berlin)
countrystringISO 3166-1 alpha-3 country code, auto-derived
regionstringRegion or state name, auto-derived
citystringCity name, auto-derived
zipstringPostal code, auto-derived
addressstringStreet address, auto-derived
emailstringContact email for this location
phonestringContact phone for this location
The fields timezone, country, region, city, zip, and address are read-only. They are automatically derived from lat and long. Do not include them in create or update requests.

Approval workflow

Locations go through a three-stage approval process:
DRAFT -> REVIEW -> APPROVED
StatusTriggerWhat it means
DRAFTCreated without all required fieldsLocation is incomplete. Cannot receive ads.
REVIEWAll required fields providedAwaiting review. Cannot receive ads yet.
APPROVEDLocation is approvedEligible for ad delivery. available_for_ads can now be set.
Fields required for REVIEW status: title, venue_type_id, lat, long, opening_168, visitors_7. When all of these fields are present on creation, the location skips DRAFT and goes directly to REVIEW.
Updating venue_type_id, lat, or long on an APPROVED location resets its status to REVIEW. This may temporarily disrupt ad delivery to screens at that location.

Archiving vs. disabling ads

There are two ways to take a location out of active use:
ActionEffect
"archived": trueHides the location from the dashboard. Screens remain but are effectively inactive.
"available_for_ads": falseLocation becomes invisible to the Ads Manager for new campaign targeting. Already running campaigns continue delivering.
To immediately stop all ad delivery at a location, set available_for_ads: false on each individual screen.