Method: advertisers.locationLists.list

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

HTTP-запрос

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