applyIncentive method

Future<GoogleAdsSearchads360V23ServicesApplyIncentiveResponse> applyIncentive(
  1. GoogleAdsSearchads360V23ServicesApplyIncentiveRequest request,
  2. String customerId,
  3. String selectedIncentiveId, {
  4. String? $fields,
})

Applies the incentive for the ads customer.

request - The metadata request object.

Request parameters:

customerId - The customer ID of the account that the incentive is being applied to. Value must have pattern ^\[^/\]+$.

selectedIncentiveId - The incentive ID of this incentive. This is used to identify which incentive is selected by the user in the CYO flow. Value must have pattern ^\[^/\]+$.

$fields - Selector specifying which fields to include in a partial response.

Completes with a GoogleAdsSearchads360V23ServicesApplyIncentiveResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<GoogleAdsSearchads360V23ServicesApplyIncentiveResponse>
applyIncentive(
  GoogleAdsSearchads360V23ServicesApplyIncentiveRequest request,
  core.String customerId,
  core.String selectedIncentiveId, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ =
      'v23/customers/' +
      core.Uri.encodeFull('$customerId') +
      '/incentives/' +
      core.Uri.encodeFull('$selectedIncentiveId') +
      ':applyIncentive';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return GoogleAdsSearchads360V23ServicesApplyIncentiveResponse.fromJson(
    response_ as core.Map<core.String, core.dynamic>,
  );
}