Method: advertisers.locationLists.list

Содержит списки местоположений на основе заданного идентификатора рекламодателя.

HTTP-запрос

GET https://displayvideo.googleapis.com/v1/advertisers/{advertiserId}/locationLists

URL-адрес использует синтаксис транскодирования gRPC .

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

Параметры
advertiserId

string ( int64 format)

Необходимый. Идентификатор рекламодателя DV360, которому принадлежат полученные списки местоположений.

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

Параметры
pageSize

integer

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

pageToken

string

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

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

orderBy

string

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

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

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

filter

string

Позволяет фильтровать по полям списка местоположений.

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

  • Выражения фильтра состоят из одного или нескольких ограничений.
  • Ограничения могут объединяться логическими операторами AND или OR . Последовательность ограничений неявно использует AND .
  • Ограничение имеет форму {field} {operator} {value} .
  • Во всех полях должен использоваться оператор EQUALS (=) .

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

  • locationType

Примеры:

  • Список всех региональных местоположений: locationType="TARGETING_LOCATION_TYPE_REGIONAL"
  • Список всех ближайших местоположений: locationType="TARGETING_LOCATION_TYPE_PROXIMITY"

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

Дополнительную информацию можно найти в нашем руководстве по запросам фильтров LIST .

Тело запроса

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

Тело ответа

В случае успеха тело ответа содержит данные следующей структуры:

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

object ( LocationList )

Список списков местоположений.

Этот список будет отсутствовать, если он пуст.

nextPageToken

string

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

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

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

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

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

Дополнительную информацию см. в обзоре OAuth 2.0 .