This guide describes each of the Waze Ads resources, how they're related conceptually, and the correct order to follow when you create them.
Waze Ads resources
The following list provides definitions of the main Waze Ads resources.
Accountresources are the foundation of the Ads resources. An
Accountencapsulates all other user-editable Waze Ads resources, namely
- Create one
Accountfor each business you want to advertise. If you're a reseller, create many
Accountresources. If you run a single business with multiple stores, you can use a single
Accountand associate all of the
Locationinstances with that
Locationresources associated with an
Accountmust be in the same region specified by the
- You must specify a single
Account. If you have businesses in different categories, create separate
Accountinstances for each of them.
- Reports generated from the
accounts.generateReportmethod can only include data from a single
RoleAssignmentresources determine the
role, such as
EDITOR, that a user has for a specific
Invitationresources invite a user to obtain a
roleover a specific
- Create one
Adresources associate the call-to-action (CTA), ad text, and images. They determine the visual presentation and the behavior of an ad.
- Budget Plan
BudgetPlanspecifies the budget over a period of time that can be used for a
Locationinstances contain a pair of coordinates (longitude and latitude) along with metadata about the
Location, such as a business name. When you create a
Location, it's scoped under an
Locationresources are necessary in order to serve the ads. They're the first layer of targeting and determine where the ads are eligible to serve.
Regioninstances contain a reference to a geographicalRegion polygon along with metadata about the
Region, such as a business name and phone number. When you create a
Region, it's scoped under an
Adinstances, and they associate a
Campaignresources enable the ads to be served.
See limits and quotas for details on the maximum number of resources that can be created within an account.
Waze API: Resource Creation Dependency flow
The following steps guide you through the resource order of creation:
- Create an
Account. Upon creation, a
RoleAssignmentis automatically created with your email, name, and the
Role, which grants you read and write permissions over the new
- Create the
Locationresources in any order. Each resource is associated with the
- Finally, create the
Campaignresources and associate them with the
Account, a single
Ad, and a single
Campaigninstances can be created without a
Location. However, to serve ads, they must target at least one
The following image displays the Resource Creation Dependency flow:
Create a Campaign
Campaign resources are created within the scope or context of a Waze Ads
Campaign targets either a specific location or all
Location instances. (You can target up to 50 specific
Campaign resources can share the same set of
Location instances, but each
Campaign can only hold one type of ad unit,
Pin, Takeover, Arrow, or Search.