API Dynamic Ad Insert VOD

A API Dynamic ad insertion permite solicitar e acompanhar streams de vídeo on demand (VOD) da DAI. Os fluxos HLS e DASH são aceitos.

Serviço: dai.google.com

O caminho do método stream é relativo a https://dai.google.com

Método: stream

Solicitação 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

Cabeçalho da solicitação

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

Parâmetros de caminho

Corpo da solicitação

O corpo da solicitação é do tipo application/x-www-form-urlencoded e contém os seguintes parâmetros:

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá um novo Stream. Para transmissões de beacons do lado do servidor, esse Stream contém apenas os campos stream_id e stream_manifest.

Open Measurement

O campo Verifications contém informações para a verificação do Open Measurement para streams sem beacons do lado do servidor. O Verifications contém um ou mais elementos Verification que listam os recursos e metadados necessários para verificar a reprodução do criativo com o código de medição de terceiros. Somente JavaScriptResource é aceito. Para mais informações, consulte o IAB Tech Lab e a especificação VAST 4.1.

Método: verificação de mídia

Depois de encontrar um identificador de mídia de anúncio durante a reprodução, faça uma solicitação imediatamente usando o media_verification_url do endpoint stream. O media_verification_url é um caminho absoluto. As solicitações de verificação de mídia não são necessárias para transmissões de beacon no servidor, em que o servidor inicia a verificação de mídia.

As solicitações para o endpoint media verification são idempotentes.

Solicitação HTTP

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

Corpo da resposta

media verification retorna as seguintes respostas:

• HTTP/1.1 204 No Content se a verificação de mídia for bem-sucedida e todos os pings forem enviados.
• HTTP/1.1 404 Not Found se a solicitação não puder verificar a mídia devido à formatação ou expiração incorreta do URL.
• HTTP/1.1 404 Not Found se uma solicitação de verificação anterior para esse documento de identidade foi bem-sucedida.
• HTTP/1.1 409 Conflict se outra solicitação já estiver enviando pings no momento.

IDs de mídia de anúncios (HLS)

Os identificadores de mídia de anúncios serão codificados em metadados temporizados do HLS usando a chave TXXX, reservada para frames de "informações de texto definidas pelo usuário". O conteúdo do frame não será criptografado e sempre vai começar com o texto "google_".

Todo o conteúdo de texto do frame precisa ser anexado a media_verification_url para cada solicitação de verificação de anúncio.

IDs de mídia de anúncios (DASH)

Os identificadores de mídia de anúncios são inseridos no manifesto usando o elemento EventStream do DASH.

Cada EventStream terá um URI de ID do esquema de urn:google:dai:2018. Eles vão conter eventos com o atributo messageData que contém um ID de mídia do anúncio que começa com “google_”. Todo o conteúdo do atributo messageData precisa ser anexado ao media_verification_url para cada solicitação de verificação de anúncio.

Dados de resposta

Stream

{
  "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)],
}

Anúncio

{
  "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": [],
}

Evento

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

Legenda

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

SkipMetadata

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

Ícone

{
  "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,
}

Verificação

{
  "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,
}