Method: advertisers.negativeKeywordLists.negativeKeywords.list

Возвращает список минус-слов из списка минус-слов.

HTTP-запрос

GET https://displayvideo.googleapis.com/v5/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}/negativeKeywords

URL имеет синтаксис gRPC Transcoding.

Параметры пути

Параметры
advertiserId

string (int64 format)

Обязательно. Идентификатор рекламодателя DV360, которому принадлежит родительский список минус-слов.

negativeKeywordListId

string (int64 format)

Обязательно. Идентификатор родительского списка минус-слов, к которому относятся запрашиваемые минус-слова.

Параметры запроса

Параметры
pageSize

integer

Запрошенный размер страницы. Значение должно быть в диапазоне от 1 до 1000. Если не указано, по умолчанию будет использоваться 100. Если указано недопустимое значение, возвращается код ошибки INVALID_ARGUMENT.

pageToken

string

Токен, идентифицирующий страницу результатов, которую должен вернуть сервер.

Обычно это значение nextPageToken, возвращенное предыдущим вызовом метода negativeKeywords.list. Если значение не указано, будет возвращена первая страница результатов.

orderBy

string

Поле, по которому нужно отсортировать список. Допустимые значения:

  • keywordValue (по умолчанию)

По умолчанию используется порядок сортировки по возрастанию. Чтобы указать порядок по убыванию, добавьте к названию поля суффикс " desc". Пример: keywordValue desc.

filter

string

Позволяет фильтровать по полям минус-слов.

Поддерживаемый синтаксис:

  • Выражения фильтров для минус-слов могут содержать не более одного ограничения.
  • Ограничение имеет следующий формат: {field} {operator} {value}.
  • Во всех полях должен использоваться оператор HAS (:).

Поддерживаемые поля:

  • keywordValue

Примеры:

  • Все минус-слова, содержащие "google": keywordValue : "google"

Длина этого поля не должна превышать 500 символов.

Подробную информацию вы найдете в руководстве по фильтрации запросов LIST.

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

Ответ для NegativeKeywordService.ListNegativeKeywords.

Ниже приведена структура данных в ответе, полученном на запрос.

JSON-представление
{
  "negativeKeywords": [
    {
      object (NegativeKeyword)
    }
  ],
  "nextPageToken": string
}
Поля
negativeKeywords[]

object (NegativeKeyword)

Список минус-слов.

Если список пуст, он не будет показан.

nextPageToken

string

Токен для загрузки следующей страницы результатов.

Передайте это значение в поле pageToken в последующем вызове метода negativeKeywords.list, чтобы получить следующую страницу результатов.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию вы найдете в OAuth 2.0 Overview.