patch method

Future<NegativeKeywordList> patch(NegativeKeywordList request, String advertiserId, String negativeKeywordListId, { String? updateMask, String? $fields, })

Updates a negative keyword list.

Returns the updated negative keyword list if successful.

request - The metadata request object.

Request parameters:

advertiserId - Required. The ID of the DV360 advertiser to which the negative keyword list belongs. Value must have pattern ^\[^/\]+$.

negativeKeywordListId - Output only. The unique ID of the negative keyword list. Assigned by the system.

updateMask - Required. The mask to control which fields to update.

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

Completes with a NegativeKeywordList.

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<NegativeKeywordList> patch(
  NegativeKeywordList request,
  core.String advertiserId,
  core.String negativeKeywordListId, {
  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_ = 'v2/advertisers/' +
      core.Uri.encodeFull('$advertiserId') +
      '/negativeKeywordLists/' +
      commons.escapeVariable('$negativeKeywordListId');

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