Method: advertisers.negativeKeywordLists.negativeKeywords.bulkEdit

  • This page details the bulk editing of negative keywords within a single negative keyword list using the sunsetting Display & Video 360 API v3; it is recommended to use v4 instead.

  • The bulk edit operation is atomic, first deleting specified negative keywords and then creating new ones.

  • The request requires advertiser ID and negative keyword list ID as path parameters.

  • The request body contains arrays for negative keywords to be deleted (by value) and negative keywords to be created (as NegativeKeyword objects).

  • The response body lists the negative keywords that were successfully created.

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.

HTTP request

POST https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}/negativeKeywords:bulkEdit

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
advertiserId

string (int64 format)

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

string (int64 format)

Required. The ID of the parent negative keyword list to which the negative keywords belong.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "deletedNegativeKeywords": [
    string
  ],
  "createdNegativeKeywords": [
    {
      object (NegativeKeyword)
    }
  ]
}
Fields
deletedNegativeKeywords[]

string

The negative keywords to delete in batch, specified as a list of keyword_values.
createdNegativeKeywords[]

object (NegativeKeyword)

The negative keywords to create in batch, specified as a list of NegativeKeywords.

Response body

Response message for NegativeKeywordService.BulkEditNegativeKeywords.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "negativeKeywords": [
    {
      object (NegativeKeyword)
    }
  ]
}
Fields
negativeKeywords[]

object (NegativeKeyword)

The list of negative keywords that have been successfully created.

This list will be absent if empty.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/display-video

For more information, see the OAuth 2.0 Overview.