bulkEdit method

Future<BulkEditNegativeKeywordsResponse> bulkEdit(BulkEditNegativeKeywordsRequest request, String advertiserId, String negativeKeywordListId, { String? $fields, })

Bulk edits negative keywords in a single negative keyword list.

The operation will delete the negative keywords provided in BulkEditNegativeKeywordsRequest.deleted_negative_keywords and then create the negative keywords provided in BulkEditNegativeKeywordsRequest.created_negative_keywords. This operation is guaranteed to be atomic and will never result in a partial success or partial failure.

request - The metadata request object.

Request parameters:

advertiserId - Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.

negativeKeywordListId - Required. The ID of the parent negative keyword list to which the negative keywords belong. Value must have pattern ^\[^/\]+$.

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

Completes with a BulkEditNegativeKeywordsResponse.

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<BulkEditNegativeKeywordsResponse> bulkEdit(
  BulkEditNegativeKeywordsRequest request,
  core.String advertiserId,
  core.String negativeKeywordListId, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v3/advertisers/' +
      commons.escapeVariable('$advertiserId') +
      '/negativeKeywordLists/' +
      core.Uri.encodeFull('$negativeKeywordListId') +
      '/negativeKeywords:bulkEdit';

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