patch method

Future<BuyOnGoogleProgramStatus> patch(
  1. BuyOnGoogleProgramStatus request,
  2. String merchantId,
  3. String regionCode, {
  4. String? updateMask,
  5. String? $fields,
})

Updates the status of the BoG program for your Merchant Center account.

request - The metadata request object.

Request parameters:

merchantId - Required. The ID of the account.

regionCode - Required. The program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available.

updateMask - The list of fields to update. If the update mask is not provided, then all the fields set in buyOnGoogleProgramStatus will be updated. Clearing fields is only possible if update mask is provided.

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

Completes with a BuyOnGoogleProgramStatus.

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<BuyOnGoogleProgramStatus> patch(
  BuyOnGoogleProgramStatus request,
  core.String merchantId,
  core.String regionCode, {
  core.String? updateMask,
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if (updateMask != null) 'updateMask': [updateMask],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = commons.escapeVariable('$merchantId') +
      '/buyongoogleprograms/' +
      commons.escapeVariable('$regionCode');

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