Method: advertisers.locationLists.list

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

HTTP-запрос

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

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

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

Параметры
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.