REST Resource: adBreak.networks.assets.adBreaks

Источник: AdBreak

Метаданные рекламной паузы используются для принятия решения о показе рекламы в рекламной паузе во время прямой видеотрансляции.

JSON-представление 
{
  "name": string,
  "createTime": string,
  "expectedDuration": string,
  "customParams": string,
  "scte35CueOut": string,
  "podTemplateName": string,
  "breakState": enum (BreakState),
  "expectedStartTime": string,
  "expireDuration": string,
  "breakSequence": string,
  "breakParams": {
    object (BreakParams)
  },
  "matchParams": {
    object (MatchParams)
  },
  "servedBreak": {
    object (ServedBreak)
  }
}
Поля
name

string

Только для вывода. Название ресурса рекламной паузы. Это поле будет иметь формат "сети/ /ресурсы/ /adBreaks/ «.

network_code — это сетевой код в Google Ad Manager, к которому относится данный контент.

asset_key — это ключ события прямой трансляции в Google Ad Manage, под которым был создан рекламный блок.

adBreakId — это ключ рекламной паузы. Только для вывода.

createTime

string ( Timestamp format)

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

Используется RFC 3339, согласно которому генерируемый вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

expectedDuration

string ( Duration format)

Обязательно. Предполагаемая продолжительность перерыва.

Длительность в секундах, содержащая до девяти знаков после запятой, заканчивающаяся на « s ». Пример: "3.5s" .

customParams
(deprecated)

string

Необязательно. Пары ключ-значение, которые будут включены в запросы объявлений для этой временной паузы для таргетинга по пользовательским критериям в Ad Manager. Пример: 'key1=value&key2=value2,value22'. Устарело: Пожалуйста, задавайте параметры cust_params в breakParams.ad_tag_params, используя ключ "cust_params".

scte35CueOut

string

Необязательно. Данные, закодированные в Base64, из выходного сигнала scte35. Может включать команду splice_insert() или time_signal(). Примеры: - с time_signal(): “/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==” - с splice_insert(): "/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo="

podTemplateName
(deprecated)

string

Необязательно. Имя шаблона пода Google Ad Manager. Устарело: пожалуйста, задайте cust_params в breakParams.ad_tag_params, используя ключ "ptpln".

breakState

enum ( BreakState )

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

expectedStartTime

string ( Timestamp format)

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

Используется RFC 3339, согласно которому генерируемый вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

expireDuration

string ( Duration format)

Необязательно. Рекламная пауза заканчивается через expectedStartTime + expireDuration. Если expectedStartTime не задано, рекламная пауза закончится через expireDuration после начала принятия решения. По умолчанию: 30 мин. Минимум: 5 мин. Максимум: 6 ч.

Длительность в секундах, содержащая до девяти знаков после запятой, заканчивающаяся на « s ». Пример: "3.5s" .

breakSequence

string ( int64 format)

Только для вывода. Идентификатор последовательности промежуточного ролика рекламной паузы. Несколько рекламных пауз могут иметь одинаковую последовательность breakSequence, если это явно указано в breakParams.ad_tag_params с ключом mridx. Это фактически связывает две рекламные паузы GAM.

breakParams

object ( BreakParams )

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

matchParams

object ( MatchParams )

Необязательно. Используется для Stitched DAI, чтобы определить, как рекламная пауза, созданная через API, сопоставляется с рекламной паузой в манифесте. При обнаружении новой паузы функция сопоставления будет запущена для всех рекламных пауз события, у которых breakState равно SCHEDULED или DECISIONED чтобы проверить, соответствуют ли все заданные параметры в matchParams рекламной паузы обнаруженной паузе. Совпадение происходит, если выполняется одно из следующих условий: 1. Рекламная пауза имеет поле matchParams, и все заданные в нем параметры соответствуют новой паузе. 2. Рекламная пауза имеет DECISIONED и не имеет поля matchParams.

Чтобы предотвратить случайное срабатывание функции «соответствует всем» (которое произойдет при пустом, но присутствующем значении matchParams), значение matchParams не может быть пустым, если оно задано. Если поле присутствует в запросе, должно быть задано хотя бы одно из его собственных полей.

Проверка рекламных пауз производится в следующем порядке: 1. с параметром matchParams, упорядоченные по возрастанию expectedStartTime и createTime, при этом рекламные паузы без expectedStartTime имеют приоритет при сортировке; 2. без параметра matchParams, упорядоченные по возрастанию expectedStartTime и createTime, при этом рекламные паузы без expectedStartTime имеют приоритет при сортировке.

Если все ожидающие подтверждения EABN не совпадут, DAI вернется к принятию решений точно в срок, используя следующий доступный индекс середины срока.

servedBreak

object ( ServedBreak )

Только для вывода. Отражает фактическую информацию о показанном рекламном блоке. Устанавливается только для рекламных блоков с состоянием breakState, COMPLETE .

BreakState

Состояние рекламной паузы.

Перечисления
BREAK_STATE_UNSPECIFIED Состояние рекламной паузы неизвестно.
BREAK_STATE_DECISIONED Процесс принятия решения о начале рекламной паузы начался, но информация о ней пока не доведена до пользователей.
BREAK_STATE_COMPLETE Пользователям была показана рекламная пауза.
BREAK_STATE_SCHEDULED Решение о проведении рекламной паузы будет принято после её окончания.
BREAK_STATE_EXPIRED Рекламная пауза истекла и недоступна. По умолчанию рекламные паузы истекают через 30 минут после expectedStartTime или через 30 минут после начала принятия решения о начале рекламной паузы, если expectedStartTime не задано. Срок действия можно установить явно с помощью поля expireDuration.

BreakParams

Параметры, связанные с рекламной паузой.

JSON-представление 
{
  "macros": [
    {
      object (KeyValue)
    }
  ],
  "adTagParams": [
    {
      object (KeyValue)
    }
  ]
}
Поля
macros[]

object ( KeyValue )

Необязательно. Пользовательские значения макросов, заменяющие произвольный заполнитель в теге объявления. Во время запроса объявления DAI развернет макросы тега объявления в формате %%DAI_PATTERN:[MACRO_KEY]%% , где MACRO_KEY — это ключ.

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

adTagParams[]

object ( KeyValue )

Необязательно. Переопределяет параметры тега объявления в основном запросе объявления.

Эти параметры используются для принятия решения о том, срабатывает ли сигнал до запросов Pod Serving с установленным параметром cust_params.

Как правило, параметры переопределяют параметр строки запроса в основном запросе объявления для рекламной паузы. Для некоторых рекламных серверов с пользовательскими форматами URL-адресов параметры могут переопределять определенные места в теге объявления для соответствия требованиям рекламного сервера. Установка значения "mridx" в AdBreak переопределит поле breakSequence предоставленным значением, если оно является допустимым положительным целым числом. Это справедливо даже для рекламных серверов, не относящихся к GAM.

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

KeyValue

Представляет собой пару ключ-значение.

JSON-представление 
{
  "key": string,
  "value": string
}
Поля
key

string

Обязательно. Ключ данной пары ключ-значение.

value

string

Обязательно. Значение этой пары ключ-значение.

MatchParams

Параметры для сопоставления с обнаруженным рекламным блоком Stitched DAI.

JSON-представление 
{
  "scte35Binary": string,
  "scte35Upid": string,
  "scte35EventId": integer,
  "breakDuration": boolean
}
Поля
scte35Binary

string

Необязательно. Двоичный код SCTE-35. Для соответствия этому полю, рекламный блок в манифесте должен содержать ту же двоичную строку SCTE-35 (закодированную в base64). Если поле пустое, оно пропускается.

scte35Upid

string

Необязательно. SCTE-35 UPID (уникальный идентификатор программы). Для сопоставления с этим полем, рекламный блок в манифесте должен иметь тот же SCTE-35 UPID. UPID — это значение, которое извлекается из двоичного файла SCTE-35. Если поле пустое, оно пропускается.

scte35EventId

integer ( uint32 format)

Необязательно. Идентификатор события SCTE-35. Для сопоставления с этим полем, рекламный блок в манифесте должен иметь тот же идентификатор события (идентификатор события объединения/идентификатор события сегментации). Идентификатор события — это значение, которое анализируется из двоичного файла SCTE-35. Если поле пустое, оно пропускается.

breakDuration

boolean

Необязательно. Длительность паузы. Чтобы соответствовать этому полю, длительность рекламной паузы в манифесте должна совпадать с ожидаемой длительностью рекламной паузы (edectedDuration) с допуском в 1 мс. Если значение равно false, этот параметр пропускается.

ServedBreak

Отражает фактическую информацию о показанной рекламной паузе.

JSON-представление 
{
  "breakDetectTime": string,
  "detectedDuration": string,
  "scte35CueOut": string
}
Поля
breakDetectTime

string ( Timestamp format)

Только для вывода. Время обнаружения соответствующей рекламной паузы. Для Pod Serving это время запроса первого сегмента/манифеста рекламного блока. Для Stitched DAI это время первого обнаружения рекламной паузы в манифесте.

Используется RFC 3339, согласно которому генерируемый вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

detectedDuration

string ( Duration format)

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

Длительность в секундах, содержащая до девяти знаков после запятой, заканчивающаяся на « s ». Пример: "3.5s" .

scte35CueOut

string

Только вывод. Обнаруженное сообщение SCTE-35, закодированное в base64, прошло проверку в соответствующей рекламной паузе.

Методы

create

 API для создания рекламной паузы в прямом эфире.

delete

 API для удаления рекламной паузы в прямом эфире.

get

 API для создания рекламной паузы в прямом эфире.

list

 API для отображения рекламных пауз в прямом эфире.

patch

 API для обновления рекламной паузы в прямом эфире.