Dynamic Ad Insertion VOD API

Dynamic Ad Insertion API позволяет запрашивать и отслеживать потоки видео по запросу с динамической вставкой объявлений. Поддерживаются потоки HLS и DASH.

Сервис: dai.google.com

Путь метода stream указан относительно https://dai.google.com.

Метод: stream

HTTP-запрос

POST https://dai.google.com/ondemand/v1/hls/content/{content-source}/vid/{video-id}/stream

POST https://dai.google.com/ondemand/v1/dash/content/{content-source}/vid/{video-id}/stream

Заголовок запроса

Authorization: DCLKDAI key="<api-key>"

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

Тело запроса

Тело запроса имеет тип application/x-www-form-urlencoded и содержит следующие параметры:

Тело ответа

Если запрос выполнен успешно, то тело ответа содержит новый экземпляр Stream. Для потоков с маяками на стороне сервера этот объект Stream содержит только поля stream_id и stream_manifest.

Open Measurement

Поле Verifications содержит информацию для проверки Open Measurement в потоках, где не используются веб-маяки на стороне сервера. Verifications содержит один или несколько элементов Verification, в которых перечислены ресурсы и метаданные, необходимые для проверки воспроизведения креатива с помощью стороннего кода отслеживания. Поддерживается только JavaScriptResource. Дополнительную информацию можно найти на сайте IAB Tech Lab и в спецификации VAST 4.1.

Метод: проверка медиаконтента

Обнаружив идентификатор медиафайла объявления во время воспроизведения, сразу же отправьте запрос, используя media_verification_url из конечной точки stream. media_verification_url – абсолютный путь. Запросы на проверку медиаконтента не требуются для потоков с маяками на стороне сервера, где сервер инициирует проверку медиаконтента.

Запросы к конечной точке media verification идемпотентны.

HTTP-запрос

GET {media-verification-url}/{ad-media-id}

Тело ответа

media verification возвращает следующие ответы:

• HTTP/1.1 204 No Content, если проверка медиаконтента прошла успешно и все пинги отправлены.
• HTTP/1.1 404 Not Found, если запрос не может проверить медиаконтент из-за неправильного форматирования URL или истечения срока действия.
• HTTP/1.1 404 Not Found, если предыдущий запрос на подтверждение для этого идентификатора был выполнен успешно.
• HTTP/1.1 409 Conflict, если в это время пинги отправляются по другому запросу.

Идентификаторы мультимедийных объектов объявлений (HLS)

Идентификаторы рекламных медиафайлов будут закодированы в метаданных HLS с метками времени с помощью ключа TXXX, зарезервированного для фреймов с текстовой информацией, заданной пользователем. Содержимое фрейма не будет зашифровано и всегда будет начинаться с текста "google_".

Весь текстовый контент фрейма должен быть добавлен к media_verification_url для каждого запроса на проверку объявления.

Идентификаторы мультимедийных объектов объявлений (DASH)

Идентификаторы рекламных медиафайлов будут вставляться в манифест с помощью элемента EventStream DASH.

Каждый элемент EventStream будет иметь идентификатор схемы URI urn:google:dai:2018. Они будут содержать события с атрибутом messageData, содержащим идентификатор мультимедийного объекта объявления, начинающийся с "google_". Все содержимое атрибута messageData должно быть добавлено к media_verification_url для каждого запроса проверки объявления.

Данные ответа

Поток

{
  "stream_id": string,
  "total_duration": number,
  "content_duration": number,
  "valid_for": string,
  "valid_until": string,
  "subtitles": [object(Subtitle)],
  "hls_master_playlist": string,
  "stream_manifest": string,
  "media_verification_url": string,
  "apple_tv": object(AppleTV),
  "ad_breaks": [object(AdBreak)],
}

AppleTV

{
  "interstitials_url": string,
}

AdBreak

{
  "type": string,
  "start": number,
  "duration": number,
  "ads": [object(Ad)],
}

Объявление

{
  "seq": number,
  "start": number,
  "duration": number,
  "title": string,
  "description": string,
  "advertiser": string,
  "ad_system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
  "clickthrough_url": string,
  "icons": [object(Icon)],
  "wrappers": [object(Wrapper)],
  "events": [object(Event)],
  "verifications": [object(Verification)],
  "universal_ad_id": object(UniversalAdID),
  "companions": [object(Companion)],
  "interactive_file": object(InteractiveFile),
  "skip_metadata": object(SkipMetadata),
  "extensions": [],
}

Событие

{
  "time": number,
  "type": string,
}

Подзаголовок

{
  "language": string,
  "language_name": string,
  "ttml": string,
  "webvtt": string,
}

SkipMetadata

{
  "offset": number,
  "tracking_url": string,
}

Значок

{
  "click_data": object(ClickData),
  "creative_type": string,
  "click_fallback_images": [object(FallbackImage)],
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "x_position": string,
  "y_position": string,
  "program": string,
  "alt_text": string,
}

ClickData

{
  "url": string,
}

FallbackImage

{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}

Wrapper

{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}

Проверка

{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}

JavaScriptResource

{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}

TrackingEvent

{
  "event": string,
  "uri": string,
}

UniversalAdID

{
  "id_value": string,
  "id_registry": string,
}

Companion

{
  "click_data": object(ClickData),
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "ad_slot_id": string,
  "api_framework": string,
  "tracking_events": [object(TrackingEvent)],
}

InteractiveFile

{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}