Waze Ads Management v1 API

Create and manage Waze Ads accounts.

Service: ads.wazeapis.com

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://ads.wazeapis.com

REST Resource: v1

Methods
generateWazeAccessToken POST /v1/generateWazeAccessToken
User login with Google OAuth credentials.
health GET /v1/health
Check the health of the API or a specific service.
refreshWazeAccessToken POST /v1/refreshWazeAccessToken
Use an existing token (provided in a header) to generate a new Waze access token.

REST Resource: v1.accounts

Methods
activate POST /v1/{name=accounts/*}:activate
Activates an account.
create POST /v1/accounts
Creates a new account.
generateRateCard POST /v1/{account=accounts/*}:generateRateCard
Returns the rate card which applies for the provided Account for a budget plan of the specified duration.
generateReport POST /v1/{account=accounts/*}:generateReport
Fetch metrics for Waze Ads campaigns.
get GET /v1/{name=accounts/*}
Returns the requested account.
list GET /v1/accounts
Lists the accounts the authenticated user can access, ordered by name.
patch PATCH /v1/{account.name=accounts/*}
Updates an existing account.
pause POST /v1/{name=accounts/*}:pause
Pauses an account.

REST Resource: v1.accounts.ads

Methods
create POST /v1/{parent=accounts/*}/ads
Creates a new ad.
get GET /v1/{name=accounts/*/ads/*}
Returns the requested ad.
list GET /v1/{parent=accounts/*}/ads
Lists the ads from an account, ordered by name.
patch PATCH /v1/{ad.name=accounts/*/ads/*}
Updates an existing ad.

REST Resource: v1.accounts.budgetPlans

Methods
create POST /v1/{parent=accounts/*}/budgetPlans
Creates a new budget plan.
get GET /v1/{name=accounts/*/budgetPlans/*}
Returns the requested budget plan.
list GET /v1/{parent=accounts/*}/budgetPlans
Lists the budget plans from an account, ordered by name.
patch PATCH /v1/{budgetPlan.name=accounts/*/budgetPlans/*}
Updates an existing budget plan.

REST Resource: v1.accounts.campaigns

Methods
activate POST /v1/{name=accounts/*/campaigns/*}:activate
Activates a campaign.
create POST /v1/{parent=accounts/*}/campaigns
Creates a new campaign.
get GET /v1/{name=accounts/*/campaigns/*}
Returns the requested campaign.
list GET /v1/{parent=accounts/*}/campaigns
Lists the campaigns from an account, ordered by name.
patch PATCH /v1/{campaign.name=accounts/*/campaigns/*}
Updates an existing campaign.
pause POST /v1/{name=accounts/*/campaigns/*}:pause
Pauses a campaign.

REST Resource: v1.accounts.invitations

Methods
create POST /v1/{parent=accounts/*}/invitations
Creates a new invitation.
delete DELETE /v1/{name=accounts/*/invitations/*}
Deletes an invitation.
get GET /v1/{name=accounts/*/invitations/*}
Returns the requested invitation.
list GET /v1/{parent=accounts/*}/invitations
Lists the invitations the authenticated user can access for a given account, ordered by name.

REST Resource: v1.accounts.locations

Methods
activate POST /v1/{name=accounts/*/locations/*}:activate
Activates a location.
create POST /v1/{parent=accounts/*}/locations
Creates a new location.
get GET /v1/{name=accounts/*/locations/*}
Returns the requested location.
list GET /v1/{parent=accounts/*}/locations
Lists the locations from an account, ordered by name.
patch PATCH /v1/{location.name=accounts/*/locations/*}
Updates an existing location.
pause POST /v1/{name=accounts/*/locations/*}:pause
Pauses a location.

REST Resource: v1.accounts.regions

Methods
activate POST /v1/{name=accounts/*/regions/*}:activate
Activates a region.
create POST /v1/{parent=accounts/*}/regions
Creates a new region.
get GET /v1/{name=accounts/*/regions/*}
Returns the requested region.
list GET /v1/{parent=accounts/*}/regions
Lists the regions from an account, ordered by name.
patch PATCH /v1/{region.name=accounts/*/regions/*}
Updates an existing region.
pause POST /v1/{name=accounts/*/regions/*}:pause
Pauses a region.

REST Resource: v1.accounts.roleAssignments

Methods
create POST /v1/{parent=accounts/*}/roleAssignments
Creates a new role assignment.
delete DELETE /v1/{name=accounts/*/roleAssignments/*}
Deletes a role assignment.
get GET /v1/{name=accounts/*/roleAssignments/*}
Returns the requested role assignment.
list GET /v1/{parent=accounts/*}/roleAssignments
Lists the role assignments from an account, ordered by name.
patch PATCH /v1/{roleAssignment.name=accounts/*/roleAssignments/*}
Updates an existing role assignment.

REST Resource: v1.geographicalRegions

Methods
get GET /v1/{name=geographicalRegions/*}
Returns the requested GeographicalRegion.
search GET /v1/geographicalRegions:search
Search all available GeographicalRegions by region_code and title.