Method: advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.list

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

HTTP-запрос

GET https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}/insertionOrders/{insertionOrderId}/targetingTypes/{targetingType}/assignedTargetingOptions

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

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

Параметры
advertiserId

string ( int64 format)

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

insertionOrderId

string ( int64 format)

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

targetingType

enum ( TargetingType )

Необходимый. Определяет тип назначенных параметров таргетинга для перечисления.

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

Параметры
pageSize

integer

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

pageToken

string

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

orderBy

string

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

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

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

filter

string

Позволяет фильтровать по назначенным свойствам параметров таргетинга.

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

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

Примеры:

  • AssignedTargetingOptions с идентификатором 1 или 2 assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"
  • AssignedTargetingOptions со статусом наследования NOT_INHERITED или INHERITED_FROM_PARTNER inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"

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

Тело запроса

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

Тело ответа

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

Ответное сообщение для assignedTargetingOptions.list .

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

object ( AssignedTargetingOption )

Список назначенных параметров таргетинга.

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

nextPageToken

string

Токен, идентифицирующий следующую страницу результатов. Это значение должно быть указано как pageToken в последующем ListInsertionOrderAssignedTargetingOptionsRequest для получения следующей страницы результатов. Этот токен будет отсутствовать, если больше не будет возвращаемых assignedTargetingOptions .

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

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

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

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