REST Resource: accounts

Resource: Account

An account is a container for campaigns, locations, budget plans, and ads. For guidance on when we recommend that you organize your resources into separate accounts, see the developer documentation.

JSON representation
{
  "name": string,
  "type": enum (Type),
  "createTime": string,
  "title": string,
  "state": enum (State),
  "category": enum (Category),
  "payment": {
    object (Payment)
  },
  "advertisingRegionCode": string
}
Fields
name

string

Immutable. The resource name of the account. Format: accounts/{account}

type

enum (Type)

Required. Account type.

createTime

string (Timestamp format)

Output only. Time when this account 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".

title

string

Required. Title used to identify the account in the dashboard and in reports. Not visible to Waze drivers. The maximum length is 50 characters.

state

enum (State)

Required. Account state. Accounts can only be created in the ACTIVE or PAUSED states. This field can only be changed with the state transition methods accounts.activate and accounts.pause, not accounts.patch.

category

enum (Category)

Required. Category that describes the locations associated with this account.

payment

object (Payment)

Required. Payment data for this account.

advertisingRegionCode

string

Required. Immutable. Region where advertising is conducted for this account. All locations associated with this account must be created in the same region as this value. The field must be populated with value from the supported list.

Type

Account type.

Enums
TYPE_UNSPECIFIED Type unspecified.
LOCAL_STARTER Waze Ads Starter account. For details of account types, see Waze Ads Starter.

State

The state of the Account.

Enums
STATE_UNSPECIFIED State unspecified.
ACTIVE The account is active.
PAUSED The account is paused, so campaigns associated with this account aren't currently serving. The account can be activated by any user with write access to this account.
SUSPENDED The account is suspended, so campaigns associated with this account aren't currently serving. The account can only be activated by Waze.
PENDING Recent changes to this account are pending approval by Waze.

Category

Waze categories available for advertisers

Enums
CATEGORY_UNSPECIFIED Category unspecified.
BAKERY A shop that sells bread or cakes.
BANK_OR_FINANCIAL A bank or financial institution.
CAR_DEALER A business that sells new or used cars.
CAR_SERVICES Car services such as an auto repair shop.
CAR_WASH Car wash.
COFFEE_SHOP Coffee shop.
COLLEGE_OR_UNIVERSITY College or university.
CONVENIENCE_STORE Convenience store.
CONVENTIONS_OR_EVENT_CENTER Convention or event center.
CULTURE_AND_ENTERTAINMENT A culture or entertainment venue.
DOCTOR_OR_CLINIC Doctor or other medical clinic.
ELECTRONICS_STORE Electronics store.
FASHION_AND_CLOTHING_STORE Fashion or clothing store.
FAST_FOOD_RESTAURANT Fast food restaurant.
FLORIST Florist.
FOOD_AND_DRINK A general category for food and drink when RESTAURANT is not appropriate. Note that businesses promoting alcohol consumption are prohibited on Waze.
FURNITURE_OR_HOME_STORE Furniture or home goods store.
GAS_STATION Gas station.
GYM_OR_FITNESS Gym or fitness center.
HOTEL Hotel.
JEWELRY_STORE Jewelry store.
LAUNDRY_OR_DRY_CLEAN Laundry or dry cleaners.
MOVIE_THEATER Movie theater.
NON_PROFIT_ORGANIZATION Non-profit organization.
OFFICES Offices.
PARKING_LOT Parking lot.
PERSONAL_CARE Personal care stores such as hairdressers or nail salons.
PET_STORE A shop selling pets or pet supplies.
PHARMACY Pharmacy.
REAL_ESTATE_AGENT Real estate agent.
REAL_ESTATE_PROJECT_SITE Real estate project site.
RESTAURANT General restaurant. Note that fast food restaurants should use FAST_FOOD_RESTAURANT.
SCHOOL A school.
SHOPPING_AND_SERVICES A general category for shops.
SUPERMARKET_OR_GROCERY Supermarket or grocery store.
TAXICAB_STAND Taxicab stand.
TRANSPORTATION A general category for transportation businesses.

Payment

Payment details for the account

JSON representation
{
  "currencyCode": string,
  "method": enum (Method)
}
Fields
currencyCode

string

Required. Immutable. Currency code for use in billing. The format is the 3-letter currency code defined in ISO 4217. The following values are supported:

  • ARS Argentine Peso
  • AUD Australian Dollar
  • BRL Brazilian Real
  • CAD Canadian Dollar
  • CLP Chilean Peso
  • COP Colombian Peso
  • EUR Euro
  • GBP British Pound
  • IDR Indonesian Rupiah
  • ILS Israeli New Shekel
  • MXN Mexican Peso
  • MYR Malaysian Ringgit
  • SGD Singapore Dollar
  • USD US Dollar

Note that resellers can only set this value to the billing currency associated with their user. To create accounts with different currencies, resellers should contact their sales representatives to set up additional users.

method

enum (Method)

Required. The payment method for this account. Currently the API doesn't support credit card payments.

Method

Payment method.

Enums
METHOD_UNSPECIFIED Method unspecified.
INVOICE Payment by invoice, organised separately with Waze outside of the API.
BRAINTREE_CREDIT_CARD Payment by Braintree credit card.

Methods

activate

Activates an account.

create

Creates a new account.

generateRateCard

Returns the rate card which applies for the provided Account for a budget plan of the specified duration.

generateReport

Fetch metrics for Waze Ads campaigns.

get

Returns the requested account.

list

Lists the accounts the authenticated user can access, ordered by name.

patch

Updates an existing account.

pause

Pauses an account.