Method: advertisers.negativeKeywordLists.negativeKeywords.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists negative keywords in a negative keyword list.
HTTP request
GET https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}/negativeKeywords
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 requested negative keywords belong.
|
Query parameters
| Parameters |
pageSize |
integer
Requested page size. Must be between 1 and 1000. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.
|
pageToken |
string
A token identifying a page of results the server should return. Typically, this is the value of nextPageToken returned from the previous call to negativeKeywords.list method. If not specified, the first page of results will be returned.
|
orderBy |
string
Field by which to sort the list. Acceptable values are:
The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: keywordValue desc.
|
filter |
string
Allows filtering by negative keyword fields. Supported syntax:
- Filter expressions for negative keyword currently can only contain at most one
- restriction.
- A restriction has the form of
{field} {operator} {value}.
- The operator must be
CONTAINS (:).
- Supported fields:
Examples:
- All negative keywords for which the keyword value contains "google":
keywordValue : "google"
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
Response message for NegativeKeywordService.ListNegativeKeywords.
| JSON representation |
{
"negativeKeywords": [
{
object (NegativeKeyword)
}
],
"nextPageToken": string
} |
| Fields |
negativeKeywords[] |
object (NegativeKeyword)
The list of negative keywords. This list will be absent if empty.
|
nextPageToken |
string
A token to retrieve the next page of results. Pass this value in the pageToken field in the subsequent call to negativeKeywords.list method to retrieve the next page of results.
|
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 2024-09-18 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eLists negative keywords associated with a specific advertiser and negative keyword list in Display & Video 360.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering and sorting of negative keywords by keyword value.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination to retrieve large lists of negative keywords.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/display-video\u003c/code\u003e scope.\u003c/p\u003e\n"]]],[],null,["# Method: advertisers.negativeKeywordLists.negativeKeywords.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListNegativeKeywordsResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n\nLists negative keywords in a negative keyword list.\n\n### HTTP request\n\n`GET https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}/negativeKeywords`\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 requested negative keywords belong. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Requested page size. Must be between `1` and `1000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |\n| `pageToken` | `string` A token identifying a page of results the server should return. Typically, this is the value of [nextPageToken](/display-video/api/v1beta2/reference/rest/v1beta2/advertisers.negativeKeywordLists.negativeKeywords/list#body.ListNegativeKeywordsResponse.FIELDS.next_page_token) returned from the previous call to `negativeKeywords.list` method. If not specified, the first page of results will be returned. |\n| `orderBy` | `string` Field by which to sort the list. Acceptable values are: - `keywordValue` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `keywordValue desc`. |\n| `filter` | `string` Allows filtering by negative keyword fields. Supported syntax: - Filter expressions for negative keyword currently can only contain at most one - restriction. - A restriction has the form of `{field} {operator} {value}`. - The operator must be `CONTAINS (:)`. - Supported fields: - `keywordValue` Examples: - All negative keywords for which the keyword value contains \"google\": `keywordValue : \"google\"` |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nResponse message for NegativeKeywordService.ListNegativeKeywords.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"negativeKeywords\": [ { object (/display-video/api/v1beta2/reference/rest/v1beta2/advertisers.negativeKeywordLists.negativeKeywords#NegativeKeyword) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `negativeKeywords[]` | `object (`[NegativeKeyword](/display-video/api/v1beta2/reference/rest/v1beta2/advertisers.negativeKeywordLists.negativeKeywords#NegativeKeyword)`)` The list of negative keywords. This list will be absent if empty. |\n| `nextPageToken` | `string` A token to retrieve the next page of results. Pass this value in the [pageToken](/display-video/api/v1beta2/reference/rest/v1beta2/advertisers.negativeKeywordLists.negativeKeywords/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to `negativeKeywords.list` method to retrieve the next page of results. |\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](https://developers.google.com/identity/protocols/OAuth2)."]]
