Skip to main content
GET
List Google Ads incentives

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>.

Path Parameters

app_id
string
required

ID of the app whose Google Ads campaigns to manage.

Query Parameters

account_id
string
default:""

ID of the app's Google Ads account, as returned in id by Get Google Ads account. Leave it out before the app has an account. Defaults to empty, which quotes the offers for a new account.

Response

The offers you can apply, or an empty list when there are none.

id
string
required

Google's ID for the offer.

Example:

"1234567"

code
string
required

Token to send as coupon_code to Apply a Google Ads incentive. Treat it as opaque. It's bound to the currency the offer was quoted in.

Example:

"SELECTED:1234567:USD"

currency_code
string
required

Currency of reward_amount_micros and required_min_spend_micros, as an ISO 4217 code. It's the account's currency, or the currency a new account would be created in when you left out account_id.

Example:

"USD"

approximate
boolean
required

Whether the amounts were converted from the currency Google quoted the offer in (true) or are Google's own figures (false). Google converts again at its own rate when it grants the reward, so a converted amount can differ slightly from the credit granted.

Example:

false

reward_amount_micros
integer
required

Ad credit Google grants once the spend requirement is met, in micros of currency_code, so 500000000 is 500.00.

Example:

500000000

required_min_spend_micros
integer
required

Ad spend the account has to reach to earn the reward, in micros of currency_code.

Example:

500000000

terms_url
string
required

Google's terms and conditions for the offer. Empty when Google didn't return a link.

Example:

"https://ads.google.com/intl/en/home/terms-and-conditions/incentives/"