Method: advertisers.negativeKeywordLists.negativeKeywords.replace

  • Display & Video 360 API v3 has sunset, and users should use v4 instead.

  • This document outlines how to replace all negative keywords in a single negative keyword list using a POST request.

  • The operation requires specifying the advertiser ID and negative keyword list ID in the path parameters and providing the new negative keywords in the request body.

  • The response body confirms the replacement by returning the full list of negative keywords now in the list.

  • The operation requires the https://www.googleapis.com/auth/display-video OAuth scope for authorization.

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/v3/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

Response message for NegativeKeywordService.ReplaceNegativeKeywords.

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

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.