REST Resource: accounts.locations

Stay organized with collections Save and categorize content based on your preferences.

Resource: Location

A Location allows advertisers to advertise a specific lat/lon location on the Waze driver map.

Within an account each Location should reference a unique latLng.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "title": string,
  "description": string,
  "storeCode": string,
  "phone": string,
  "uri": string,
  "displayUri": string,
  "regularHours": {
    object (WeeklySchedule)
  },
  "address": string,
  "locality": string,
  "latLng": {
    object (LatLng)
  },
  "additionalInfo": string,
  "services": [
    enum (Service)
  ]
}
Fields
name

string

The resource name of the location. Format: accounts/{account}/locations/{location}.
createTime

string (Timestamp format)

Output only. Time when this location was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. Time when this location was most recently updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Required. Determines whether the location is active and is included in campaigns. A location that isn't active doesn't appear in advertising campaigns, even if explicitly included. Locations can only be created in the ACTIVE or PAUSED states. This field can only be changed with the state transition methods locations.activate and locations.pause, not locations.patch.
title

string

Required. Title of this location. For details on how to format this data, see this help center article.

The maximum length is 30 characters.
description

string

Location description. For details on how to format this data, see this help center article.

The maximum length is 80 characters.
storeCode

string

External identifier for this location, which must be unique inside a given account. This is a way to associate the location with your own records.

The maximum length is 100 characters.
phone

string

Location phone number.

The maximum length is 20 characters.
uri

string

URI opened in a Waze driver's browser for this location.

The maximum length is 500 characters.
displayUri

string

URI shown to Waze drivers for this location.

The maximum length is 500 characters.
regularHours

object (WeeklySchedule)

A collection of times that this location is open for business. Each period represents a range of hours when the location is open during the week in the time zone of the location.

Example: Open on Saturdays from 09:00-12:00 and 13:00-17:00:

regularHours: {
  timePeriods: [
    {
      startDay: SATURDAY
      startTime: "09:00"
      endDay: SATURDAY
      endTime: "12:00"
    },
    {
      startDay: SATURDAY
      startTime: "13:00"
      endDay: SATURDAY
      endTime: "17:00"
    }
  ]
}

The closing time must occur after the opening time, either later in the same day, or on a subsequent day.

Note: Overnight hours, such as Monday 20:00 until Tuesday 02:00, are allowed on writes. On reads, they are split into multiple day components.
address

string

Location address line.

The maximum length is 50 characters.
locality

string

The city/town portion of an address. Examples: US city, IT commune, UK post town.

The maximum length is 50 characters.
latLng

object (LatLng)

Required. Latitude/longitude of the location.

This must be unique for every Location in an account.
additionalInfo

string

Additional location information to show in the ad useful to Waze drivers such as "on the second floor", "behind the supermarket" or "3 parking spaces behind the store".

The maximum length is 70 characters.
services[]

enum (Service)

Characteristics of the business to share with Waze drivers. When you specify these services, a badge appears when the location is shown to Waze drivers. See this help center article for more information about services.

State

Location state.

Enums
STATE_UNSPECIFIED State unspecified.
ACTIVE Location is active, so ads can be served for the location.
PAUSED Location is paused, so ads aren't served for the location.

LatLng

An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.

JSON representation 
{
  "latitude": number,
  "longitude": number
}
Fields
latitude

number

The latitude in degrees. It must be in the range [-90.0, +90.0].
longitude

number

The longitude in degrees. It must be in the range [-180.0, +180.0].

Service

Service types.

Enums
SERVICE_UNSPECIFIED Service unspecified.
CREDIT_CARDS Location accepts credit cards.
RESERVATIONS Location takes reservations.
DELIVERIES Location offers delivery.
TAKEOUT Location offers takeout.
VALET Location offers valet parking.
DRIVE_THRU Location where customers are served without leaving their cars.
CUSTOMER_PARKING Location has parking for customers.
WI_FI Location has Wi-Fi.
OUTDOOR_SEATING Location has outdoor seating.
WHEELCHAIR_ACCESSIBLE Location is wheelchair accessible.
PUBLIC_RESTROOMS Location has restrooms.
AIR_CONDITIONING Location has air conditioning.
CURBSIDE_PICKUP Customers can collect food from the store without entering the premises.

Methods

activate

 Activates a location.

batchGet

 Returns the requested locations.

create

 Creates a new location.

get

 Returns the requested location.

list

 Lists the locations from an account, ordered by name.

patch

 Updates an existing location.

pause

 Pauses a location.