получить-расписание-предварительной-загрузки

Описание

Получает расписание предварительной загрузки для конфигурации воспроизведения. Расписание предварительной загрузки позволяет указать MediaTailor на загрузку и подготовку определенных рекламных объявлений перед перерывом на рекламу. Дополнительную информацию о предварительной загрузке рекламы см. в разделе «Использование предварительной загрузки рекламы» в Руководстве пользователя MediaTailor.

См. также: Документацию API AWS

Синтаксис

  get-prefetch-schedule
--name <value>
--playback-configuration-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--name (строка)

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

--playback-configuration-name (строка)

Возвращает информацию о расписании предварительной загрузки для определенной конфигурации воспроизведения. Если вы вызываете GetPrefetchSchedule для устаревшего расписания предварительной загрузки, MediaTailor возвращает код состояния HTTP 404.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного JSON-значения, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение без значения или значение input, выводит пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено значение yaml-input, оно выведет пример YAML-ввода, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверит входные данные команды и вернет пример JSON-вывода для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладку.

--endpoint-url (строка)

Переопределить адрес по умолчанию для команды указанным адресом.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

json
текст
таблица
yaml
yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из файла учетных данных.

--region (строка)

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

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включение/отключение цветного вывода.

включено
выключено
авто

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной в base64 строки. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, сопоставляющегося с двоичным блоком, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить пагинатор CLI для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматический запрос параметров ввода CLI.

Вывод

Arn -> (строка)

Идентификатор ресурса Amazon (ARN) расписания предварительной загрузки.

Потребление -> (структура)

Параметры конфигурации, определяющие, как и когда MediaTailor потребляет предварительно загруженные объявления с сервера принятия решений об объявлениях (ADS) для отдельных расписаний предварительной загрузки. Каждая конфигурация потребления содержит конечную дату и необязательную начальную дату, которые определяют окно потребления . Расписания предварительной загрузки автоматически истекают не ранее, чем через семь дней после конечной даты.

Критерии соответствия доступности -> (список)

Если вы хотите, чтобы MediaTailor вставлял предварительно загруженные объявления только в доступные слоты (блоки объявлений), которые соответствуют определенным динамическим переменным, например, scte.event_id, задайте критерии соответствия доступности.

(структура)

MediaTailor помещает (потребляет) предварительно загруженные объявления только в том случае, если рекламный блок соответствует критериям, определённым динамическими переменными. Это даёт вам точный контроль над тем, в какой рекламный блок вставлять предварительно загруженные объявления.

Например, предположим, что вы установили DynamicVariable на scte.event_id и Operator на EQUALS, а ваша конфигурация воспроизведения имеет URL-адрес ADS https://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs]. А запрос предварительной загрузки на ADS содержит эти значения https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30. MediaTailor вставит предварительно загруженные объявления в рекламный блок только в том случае, если в нём есть метка SCTE с идентификатором события my-awesome-event, так как он должен соответствовать идентификатору события, используемому MediaTailor для запроса к ADS.

Вы можете указать до пяти AvailMatchingCriteria. Если вы укажете несколько AvailMatchingCriteria, MediaTailor объединит их для соответствия, используя логическое AND. Логические OR комбинации можно смоделировать, создав несколько расписаний предварительной загрузки.

Динамическая переменная -> (строка)

Динамическая переменная(ые), которую(ые) MediaTailor должен использовать в качестве критериев соответствия доступности. MediaTailor помещает предварительно загруженные объявления в доступный слот только в том случае, если он соответствует критериям, определённым динамической переменной. Сведения о динамических переменных см. в разделе «Использование динамических переменных объявлений» в руководстве пользователя MediaTailor.

Вы можете включить до 100 динамических переменных.

Оператор -> (строка)

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

Конечная дата -> (метка времени)

Время, когда MediaTailor больше не рассматривает предварительно загруженные объявления для использования в рекламном блоке. MediaTailor автоматически удаляет расписания предварительной загрузки не ранее, чем через семь дней после конечной даты. Если вы хотите вручную удалить расписание предварительной загрузки, вы можете вызвать DeletePrefetchSchedule.

Начальная дата -> (метка времени)

Время, когда предварительно загруженные объявления рассматриваются для использования в рекламном блоке. Если вы не укажете StartTime, предварительно загруженные объявления доступны после извлечения их MediaTailor с сервера принятия решений об объявлениях.

Имя -> (строка)

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

Имя конфигурации воспроизведения -> (строка)

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

Получение -> (структура)

Сложный тип, содержащий параметры для получения предварительно загруженных данных с сервера принятия решений об объявлениях (ADS).

Динамические переменные -> (карта)

Динамические переменные, используемые для подстановки во время запросов предварительной загрузки на сервер принятия решений об объявлениях (ADS).

Изначально вы настраиваете динамические переменные для URL-адреса ADS при настройке конфигурации воспроизведения. Когда вы указываете DynamicVariables для получения предварительной загрузки, MediaTailor включает динамические переменные в запрос к ADS.

ключ -> (строка)

значение -> (строка)

Конечная дата -> (метка времени)

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

Начальная дата -> (метка времени)

Время, когда могут начаться запросы предварительной загрузки для данного блока. Попытка предварительной загрузки объявлений будет предпринята для запросов манифеста, которые произойдут после или в это время. По умолчанию устанавливается текущее время. Если не указано, загрузка предварительно загруженных данных начинается как можно скорее.

Тип формирования трафика -> (строка)

Указывает, использует ли эта конфигурация окно получения для формирования трафика и ограничения количества запросов к ADS одновременно.

Окно получения формирования трафика -> (структура)

Конфигурация для распределения трафика ADS по определённому окну вместо отправки запросов ADS для всех сеансов одновременно.

Продолжительность окна получения -> (целое число)

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

Тип расписания -> (строка)

Частота, с которой MediaTailor создаёт расписания предварительной загрузки. SINGLE указывает, что это расписание относится к одному рекламному блоку. RECURRING указывает, что MediaTailor автоматически создаёт расписание для каждого рекламного слота в прямом событии.

Конфигурация повторяющейся предварительной загрузки -> (структура)

Конфигурация, определяющая, как и когда MediaTailor выполняет предварительную загрузку объявлений в прямом событии.

Начальная дата -> (метка времени)

Начальное время окна, в котором MediaTailor предварительно загружает и вставляет объявления в прямом событии.

Конечная дата -> (метка времени)

Конечное время окна, в котором MediaTailor предварительно загружает и вставляет объявления в прямом событии.

Повторное потребление -> (структура)

Параметры, определяющие, как и когда MediaTailor помещает предварительно загруженные объявления в будущие рекламные блоки для расписаний повторной предварительной загрузки.

Время истечения предварительно загруженного объявления (в секундах) -> (целое число)

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

Критерии соответствия доступности -> (список)

Конфигурация для динамических переменных, которые определяют, в какие рекламные блоки MediaTailor вставляет предварительно загруженные объявления.

(структура)

Динамическая переменная -> (строка)

Вы можете включить до 100 динамических переменных.

Оператор -> (строка)

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

Повторное получение -> (структура)

Конфигурация для получения предварительно загруженных объявлений с сервера ADS.

Динамические переменные -> (карта)

ключ -> (строка)

значение -> (строка)

Задержка после окончания слота (в секундах) -> (целое число)

Количество секунд, которое MediaTailor ожидает после окончания рекламного слота, прежде чем начать предварительную загрузку объявлений для следующего слота. Если не задано, по умолчанию значение 0 (без задержки).

Тип формирования трафика -> (строка)

Окно получения формирования трафика -> (структура)

Продолжительность окна получения -> (целое число)

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

Идентификатор потока -> (строка)

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