customers

POST /v23/customers/{customersId}/incentives/{incentivesId}:applyIncentive

Applies the incentive for the ads customer.

Request

Base URL
https://searchads360.googleapis.com
Auth
OAuth 2 and OAuth 2
Implicithttps://accounts.google.com/o/oauth2/auth
Scopeshttps://www.googleapis.com/auth/doubleclicksearch
Authorization codehttps://accounts.google.com/o/oauth2/auth
Token URLhttps://accounts.google.com/o/oauth2/token
Scopeshttps://www.googleapis.com/auth/doubleclicksearch
TypeScript
https://skmtc.dev/google/apis/searchads360/docs/v23/customers/:customersId/incentives/:incentivesId:applyIncentive/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

customersIdstring required

incentivesIdstring required

Request body

countryCodestring

Required. User's country code. Required. This field must be equal to the Google Ads account's billing country. Incentive eligibility, terms of service, and reward values are often country-specific. This country code is used to ensure the selected incentive is applicable to the user. Possible country codes: https://developers.google.com/google-ads/api/data/codes-formats#country_codes

Response

Successful response

couponCodestring

The coupon code of the applied incentive. A globally unique identifier of the applied incentive. This code is separate and distinct from the selected_incentive_id in the request.

creationTimestring

The timestamp when this incentive was applied. The timestamp is in UTC timezone and in "yyyy-MM-dd HH:mm:ss" format.

Changes

No recorded changes to this operation across all 4 revisions of this API.