Method: advertisers.negativeKeywordLists.negativeKeywords.list

Lists negative keywords in a negative keyword list.

HTTP request

GET https://displayvideo.googleapis.com/v3/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:

  • 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.
filter

string

Allows filtering by negative keyword fields.

Supported syntax:

  • Filter expressions for negative keywords can only contain at most one restriction.
  • A restriction has the form of {field} {operator} {value}.
  • All fields must use the HAS (:) operator.

Supported fields:

  • keywordValue

Examples:

  • All negative keywords for which the keyword value contains "google": keywordValue : "google"

The length of this field should be no more than 500 characters.

Reference our filter LIST requests guide for more information.

Request body

The request body must be empty.

Response body

Response message for NegativeKeywordService.ListNegativeKeywords.

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

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.