Method: advertisers.negativeKeywordLists.negativeKeywords.replace

  • Display & Video 360 API v1 has been sunset.

  • This operation replaces all negative keywords in a single negative keyword list using the keywords provided in the request body.

  • The HTTP request method is POST with a specific URL structure that includes advertiserId and negativeKeywordListId as path parameters.

  • The request body contains an array of new negative keywords to be used for replacement.

  • The response body returns the full list of negative keywords currently in the negative keyword list after the replacement.

Replaces all negative keywords in a single negative keyword list.

The operation will replace the keywords in a negative keyword list with keywords provided in ReplaceNegativeKeywordsRequest.new_negative_keywords.

HTTP request

POST https://displayvideo.googleapis.com/v1/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}/negativeKeywords:replace

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 
{
  "newNegativeKeywords": [
    {
      object (NegativeKeyword)
    }
  ]
}
Fields
newNegativeKeywords[]

object (NegativeKeyword)

The negative keywords that will replace the existing keywords in the negative keyword list, specified as a list of NegativeKeywords.

Response body

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

Response message for NegativeKeywordService.ReplaceNegativeKeywords.

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

object (NegativeKeyword)

The full list of negative keywords now present in the negative keyword list.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.