REST Resource: accounts.ads

Type

The type of advertisement to display to drivers.

Enums
TYPE_UNSPECIFIED Type unspecified.
DRIVE_THERE An ad with a button that changes the driver's navigation to the advertised location.
SAVE_FOR_LATER An ad with a button that sends drivers to visit a web page. Includes an optional inbox message.
CALL_NOW An ad with a button that calls the phone number specified for the location.
SAVE_LOCATION An ad with a button that saves the location to the driver's navigation history.

Image

Image data. Note that updating an ad image will send your ad for approval, which can take up to 48h. See this help center article for more information.

JSON representation
{

  // Union field image_data can be only one of the following:
  "imageBytes": {
    object (ImageBytes)
  },
  "sourceUri": string,
  "uri": string
  // End of list of possible types for union field image_data.
}
Fields

Union field image_data.

image_data can be only one of the following:

imageBytes

object (ImageBytes)

Input only. When you create or update an image, the imageBytes or sourceUri must be specified.

This field should contain a base64-encoded byte string and with an image format. This field isn't populated when an Ad is read.

sourceUri

string

Input only. When you create or update an image, the imageBytes or sourceUri must be specified.

The URI for a stock image or an existing ad image that starts with https://adsassets.waze.com/

uri

string

Output only. Read-only URI for an image. To change this image, send an UpdateAdRequest with either the imageBytes or sourceUri fields set.

ImageBytes

Wrapper class for the bytes of a base64-encoded image.

JSON representation
{
  "mimeType": string,
  "data": string
}
Fields
mimeType

string

The mime type of the supplied data. Supported values are image/png and image/jpeg.

This field is required for imageBytes.

data

string (bytes format)

base64-encoded image data.

This field is required for imageBytes.

A base64-encoded string.

PremiumImages

Images shown to drivers as a single large image.

JSON representation
{
  "premiumImage": {
    object (Image)
  },
  "premiumWideImage": {
    object (Image)
  }
}
Fields
premiumImage

object (Image)

608x240 px image. This image is shown when Waze drivers don't fit the criteria for any other premium images or when other premium images aren't specified.

This image is required for premiumImages.

premiumWideImage

object (Image)

788x240 px image. This image is shown when Waze drivers have a widescreen device or are in landscape mode.

This image is optional for premiumImages.

IabImages

Images shown to drivers side-by-side, with iabStandardLogoImage on the left and iabStandardBannerImage on the right. The ratios of these images match the ratios for the Native Image Assets Main-Large as specified by the Interactive Advertising Bureau (IAB).

JSON representation
{
  "iabStandardBannerImage": {
    object (Image)
  },
  "iabStandardLogoImage": {
    object (Image)
  }
}
Fields
iabStandardBannerImage

object (Image)

458x240 px image, 1.91:1 ratio.

This image is required for iabImages.

iabStandardLogoImage

object (Image)

170x170 px image, 1:1 ratio.

This image is required for iabImages.

StandardBanner

Optional image shown alongside text.

JSON representation
{
  "image": {
    object (Image)
  },
  "title": string,
  "description": string
}
Fields
image

object (Image)

200x200 px image. For details, see How to choose your images. This image is shown to drivers alongside this Ad's title and description. If no image is specified, a default image for the category of the account is shown.

title

string

The maximum length is 30 characters.

This field is required for standard banners.

description

string

The maximum length is 80 characters.

This field is required for standard banners.

LocationBanner

Optional image shown alongside text from the location title and description from the advertised location.

This option can't be set when a campaign targets regions.

JSON representation
{
  "image": {
    object (Image)
  }
}
Fields
image

object (Image)

200x200 px image. For details, see How to choose your images. This image is shown to drivers alongside this Ad's title and description. If no image is specified, a default image for the category of the account is shown.

InboxData

Data to populate a message shown in the Waze driver's inbox.

JSON representation
{
  "title": string,
  "body": string,
  "buttonText": string
}
Fields
title

string

Title of message shown in the driver's inbox.

The maximum length is 50 characters.

body

string

Body of message shown in the driver's inbox.

The maximum length is 80 characters.

buttonText

string

Text of the button shown in the driver's inbox.

The maximum length is 50 characters.

Reminder

JSON representation
{
  "pushMessage": enum (PushMessage),
  "advertiserNotificationDisplayName": string,
  "title": string,
  "description": string,
  "uri": string,

  // Union field trigger can be only one of the following:
  "radiusMeters": string,
  "triggerTime": string,
  "delayDuration": string
  // End of list of possible types for union field trigger.
}
Fields
pushMessage

enum (PushMessage)

Template message to send as a push notification. If the field isn't specified, there isn't a push notification.

advertiserNotificationDisplayName

string

Advertiser name displayed on the notification message. See PushMessage.

The maximum length is 30 characters.

title

string

Title of the reminder message.

The maximum length is 60 characters.

description

string

Description of the reminder message.

The maximum length is 400 characters.

uri

string

URI opened in a user's browser for this reminder message.

The maximum length is 500 characters.

Union field trigger.

trigger can be only one of the following:

radiusMeters

string (int64 format)

Show the reminder when the user is near the location. Only the value 1000 can be set.

triggerTime

string (Timestamp format)

Trigger the reminder at this scheduled time (UTC).

This time must be in the future.

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".

delayDuration

string (Duration format)

Show the reminder this amount of time. This value must be set to a positive number of hours, with maximum value 120 (5 days). When setting seconds this means the value must be a multiple of 3600. For example, "3600s", "7200s", "86,400s". (1 hour, 2 hours, 24 hours respectively). Note that Duration JSON input is in seconds.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

PushMessage

Enums
PUSH_MESSAGE_UNSPECIFIED
REACHED_LOCATION_INFO Send Waze drivers the message "You've reached location.title. Check your inbox for info from advertiserNotificationDisplayName." Available only for the radiusMeters trigger.
REACHED_LOCATION_OFFER Send Waze drivers the message "You've reached location.title. Check your inbox for an offer from advertiserNotificationDisplayName." Available only for the radiusMeters trigger.
INBOX_MESSAGE Send Waze drivers the message "You have a reminder from advertiserNotificationDisplayName in your Waze Inbox." Available only for the triggerTime and delayDuration triggers.

State

Ad state.

Enums
STATE_UNSPECIFIED State unspecified.
ACTIVE Ad is active, so ads can be served using this Ad.
PENDING Ad is under review, so ads can't be served using this Ad.
REJECTED Ad is rejected, so ads can't be served using this Ad.

Methods

create

Creates a new ad.

get

Returns the requested ad.

list

Lists the ads from an account, ordered by name.

patch

Updates an existing ad.