Starting
September 8, 2025, every new line item will need to declare whether or not they will serve Eurpoean Union (EU) political ads. Display & Video 360 API and SDF uploads that don't provide declarations will fail. See our
deprecations page for more details on how to update your integration to make this declaration.
Method: advertisers.negativeKeywordLists.negativeKeywords.replace
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
POST https://displayvideo.googleapis.com/v4/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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-27 UTC.
[null,null,["Last updated 2025-03-27 UTC."],[],["The Display & Video 360 API v4 allows replacing all negative keywords in a list using a POST request to a specific URL. This action requires the `advertiserId` and `negativeKeywordListId` as path parameters. The request body should include a JSON array of `newNegativeKeywords`, which will replace the existing ones. Upon successful execution, the response body returns a JSON array containing the complete, updated list of `negativeKeywords`. Authorization requires the `https://www.googleapis.com/auth/display-video` OAuth scope.\n"],null,["# Method: advertisers.negativeKeywordLists.negativeKeywords.replace\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ReplaceNegativeKeywordsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReplaces all negative keywords in a single negative keyword list.\n\nThe operation will replace the keywords in a negative keyword list with keywords provided in [ReplaceNegativeKeywordsRequest.new_negative_keywords](/display-video/api/reference/rest/v4/advertisers.negativeKeywordLists.negativeKeywords/replace#body.request_body.FIELDS.new_negative_keywords).\n\n### HTTP request\n\n`POST https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}/negativeKeywords:replace`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `advertiserId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. |\n| `negativeKeywordListId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The ID of the parent negative keyword list to which the negative keywords belong. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"newNegativeKeywords\": [ { object (/display-video/api/reference/rest/v4/advertisers.negativeKeywordLists.negativeKeywords#NegativeKeyword) } ] } ``` |\n\n| Fields ||\n|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `newNegativeKeywords[]` | `object (`[NegativeKeyword](/display-video/api/reference/rest/v4/advertisers.negativeKeywordLists.negativeKeywords#NegativeKeyword)`)` The negative keywords that will replace the existing keywords in the negative keyword list, specified as a list of [NegativeKeywords](/display-video/api/reference/rest/v4/advertisers.negativeKeywordLists.negativeKeywords#NegativeKeyword). |\n\n### Response body\n\nResponse message for NegativeKeywordService.ReplaceNegativeKeywords.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"negativeKeywords\": [ { object (/display-video/api/reference/rest/v4/advertisers.negativeKeywordLists.negativeKeywords#NegativeKeyword) } ] } ``` |\n\n| Fields ||\n|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `negativeKeywords[]` | `object (`[NegativeKeyword](/display-video/api/reference/rest/v4/advertisers.negativeKeywordLists.negativeKeywords#NegativeKeyword)`)` The full list of negative keywords now present in the negative keyword list. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/display-video`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]