Method: advertisers.reachForecast.retrievePlannableUserLists

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

HTTP-запрос

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

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

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

Параметры
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"
  • Планируемые списки пользователей с отображаемым названием, содержащим "Покупки": 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 Сторонний список пользователей.

PlannableStatus

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

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