List Google Ads incentives
<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>
Returns the promotional offers Google Ads has for the app's account. Each one grants ad credit once the account's spend reaches a set amount.
The offers are personal to you. Google picks them from your email address, so another member of the workspace can see different ones.
Pass account_id once the app has a Google Ads account, so the offers are quoted in its currency. Before then, leave it out and the offers are quoted in the currency a new account would be created in, which depends on where the request comes from. If the account ends up in a different currency, applying an offer read that way is rejected.
An empty list is a normal answer. It comes back when the account already holds an incentive, when incentives aren't offered in the account's currency, which today means anything other than USD or ILS, and when Google has nothing for you.
Take an offer with Apply a Google Ads incentive.
<Note>This endpoint accepts a personal API key. Workspace API keys are not authorized for it and are rejected with a 403.</Note>
<Warning>The response includes fields beyond the ones documented here. Don't rely on undocumented response fields, as they can change at any time.</Warning>
Path parameters
ID of the app whose Google Ads campaigns to manage.
ID of the app whose Google Ads campaigns to manage.
Query parameters
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.
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.
Example response
[
{
"id": "1234567",
"code": "SELECTED:1234567:USD",
"currency_code": "USD",
"reward_amount_micros": 500000000,
"required_min_spend_micros": 500000000,
"terms_url": "https://ads.google.com/intl/en/home/terms-and-conditions/incentives/"
}
]Changes
Changed in 1 of the 18 revisions of this API.1
- ○
endpoint added
endpoint-added
- ○
Of the 18 revisions, 1 has no diff computed.