Method: advertisers.reachForecast.retrievePlannableUserLists

Получает списки пользователей от первого и третьего лица, доступные для прогнозирования.

HTTP-запрос

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/reachForecast:retrievePlannableUserLists

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

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

Параметры
advertiserId

string ( int64 format)

Обязательно. Идентификатор рекламодателя, для которого необходимо получить списки пользователей, подлежащих планированию.

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

Параметры
pageSize

integer

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

pageToken

string

Необязательный параметр. Токен, идентифицирующий страницу результатов, которую должен вернуть сервер. Как правило, это значение параметра nextPageToken , возвращенного предыдущим вызовом метода reachForecast.retrievePlannableUserLists . Если не указано, будет возвращена первая страница результатов.

filter

string

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

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

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

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

  • plannableStatus
  • displayName
  • userListType
  • name

Примеры:

  • Все списки пользователей, подлежащих планированию: plannableStatus="PLANNABLE"
  • Список пользователей, поддерживающих планирование, с отображаемым именем, содержащим "Shopping": plannableStatus="PLANNABLE" AND displayName:"Shopping"
  • Списки пользователей от первого лица: userListType="FIRST_PARTY"

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

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

Текст запроса

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

Ответный текст

Ответ на запрос reachForecast.retrievePlannableUserLists.

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

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

object ( PlannableUserList )

Только вывод. Список доступных для планирования списков пользователей.

nextPageToken

string

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

Области полномочий

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

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

Для получения более подробной информации см.OAuth 2.0 Overview .

PlannableUserList

Список пользователей, пригодный для планирования, используемый для прогнозирования охвата аудитории.

JSON-представление 
{
  "displayName": string,
  "userListType": enum (UserListType),
  "name": string,
  "plannableStatus": enum (PlannableStatus)
}
Поля
displayName

string

Только вывод. Отображаемое имя списка пользователей.

userListType

enum ( UserListType )

Только вывод. Тип списка пользователей.

name

string

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

Формат: advertisers/{advertiserId}/userLists/{user_list_id}

plannableStatus

enum ( PlannableStatus )

Только вывод. Статус планируемости списка пользователей.

UserListType

Типы списков пользователей.

Перечисления
USER_LIST_TYPE_UNSPECIFIED Тип списка пользователей не указан.
FIRST_PARTY Список пользователей от первого лица.
THIRD_PARTY Список сторонних пользователей.

Планируемый статус

Статус указывает, можно ли запланировать выполнение списка или нет.

Перечисления
PLANNABLE_STATUS_UNSPECIFIED Статус планируемости не указан.
PLANNABLE Список пользователей можно составить по плану.
UNPLANNABLE Составление списка пользователей невозможно спланировать.