API de VOD de inserción de anuncios dinámicos

La API de inserción de anuncios dinámicos te permite solicitar transmisiones de video on demand (VOD) de DAI y hacerles un seguimiento. Se admiten las transmisiones HLS y DASH.

Servicio: dai.google.com

La ruta de acceso del método stream está relacionada con https://dai.google.com

Método: stream

Métodos
stream POST /ondemand/v1/hls/content/{content-source}/vid/{video-id}/stream

Crea una transmisión HLS DAI para la fuente del contenido y el ID de video especificados.

POST /ondemand/v1/dash/content/{content-source}/vid/{video-id}/stream

Crea una transmisión de DASH DAI para la fuente del contenido y el ID de video especificados.

Solicitud 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

Encabezado de la solicitud

Parámetros
api‑key string

La clave de API, que se proporciona cuando se crea una transmisión, debe ser válida para la red del publicador.

En lugar de proporcionarla en el cuerpo de la solicitud, la clave de API se puede pasar en el encabezado de autorización HTTP con el siguiente formato:

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

Parámetros de ruta

Parámetros
content-source string

El ID de CMS de la transmisión.

video-id string

El ID de video de la transmisión continua.

Cuerpo de la solicitud

El cuerpo de la solicitud es de tipo application/x-www-form-urlencoded y contiene los siguientes parámetros:

Parámetros
dai-ssb Opcional

Configúralo en true para crear una transmisión de balizas del servidor. La configuración predeterminada es false. El seguimiento de la transmisión predeterminada lo inicia el cliente y se hace ping desde el servidor.
Parámetros de segmentación de DoubleClick Opcional Parámetros de segmentación adicionales.
Cómo anular parámetros de transmisión Opcional Anula los valores predeterminados de un parámetro de creación de transmisión.
Autenticación de HMAC Opcional Autentica con un token basado en HMAC.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá una Stream nueva. En el caso de las transmisiones de píxeles contadores del servidor, este Stream contiene solo los campos stream_id y stream_manifest.

Open Measurement

El campo Verifications contiene información para la verificación de Open Measurement para flujos de balizas que no son del servidor. Verifications contiene uno o más elementos Verification que enumeran los recursos y metadatos que necesitas para verificar la reproducción de creatividades con el código de medición de terceros. Solo se admite JavaScriptResource. Para obtener más información, consulta IAB Tech Lab y las especificaciones de VAST 4.1.

Método: verificación de medios

Después de encontrar un identificador multimedia de anuncios durante la reproducción, realiza una solicitud de inmediato mediante media_verification_url desde el extremo stream. media_verification_url es una ruta de acceso absoluta. Las solicitudes de verificación de medios no son necesarias para las transmisiones de píxeles contadores del servidor, en las que el servidor inicia la verificación de medios.

Las solicitudes al extremo media verification son idempotentes.

Métodos
media verification GET {media_verification_url}/{ad_media_id}

Notifica a la API un evento de verificación de contenido multimedia.

Solicitud HTTP

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

Cuerpo de la respuesta

media verification muestra las siguientes respuestas:

  • HTTP/1.1 204 No Content si la verificación de medios se realiza correctamente y se envían todos los pings.
  • HTTP/1.1 404 Not Found si la solicitud no puede verificar el contenido multimedia debido a un formato o vencimiento de la URL incorrectos
  • HTTP/1.1 404 Not Found si se procesó correctamente una solicitud de verificación anterior para este ID.
  • HTTP/1.1 409 Conflict si otra solicitud ya está enviando pings en este momento.

IDs de medios de anuncios (HLS)

Los identificadores de medios de anuncios se codificarán en metadatos temporizados HLS con la clave TXXX, reservada para los marcos de "información de texto definida por el usuario". El contenido del marco no estará encriptado y siempre comenzará con el texto "google_".

Se debe agregar todo el contenido de texto del marco a la media_verification_url para cada solicitud de verificación de anuncio.

IDs de medios de anuncios (DASH)

Los identificadores de contenido multimedia de anuncios se insertarán en el manifiesto mediante el uso del elemento EventStream de DASH.

Cada EventStream tendrá un URI de ID de esquema de urn:google:dai:2018. Contendrán eventos con el atributo messageData que contiene un ID de contenido multimedia del anuncio que comienza con “google_”. Se debe agregar todo el contenido del atributo messageData a la media_verification_url para cada solicitud de verificación de anuncios.

Datos de respuesta

Transmisión

La transmisión se usa para procesar una lista de todos los recursos de una transmisión nueva en formato JSON .
Representación JSON
{
  "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)],
}
Campos
stream_id string

Identificador de transmisión.
total_duration number

Duración de la transmisión en segundos.
content_duration number

Duración del contenido, sin anuncios, en segundos.
valid_for string

La duración de la transmisión es válida en formato "00h00m00s".
valid_until string

Fecha durante la cual la transmisión es válida, en formato RFC 3339
subtitles [object(Subtitle)]

Una lista de subtítulos. Se omite si está vacío. Solo para HLS
hls_master_playlist string

URL de la playlist principal de HLS(OBSOLETO). Usa stream_manifest. Solo para HLS
stream_manifest string

El manifiesto de la transmisión. Corresponde a la playlist principal en HLS y a la MPD en DASH. Este es el único campo aparte de "stream_id" que está presente en la respuesta cuando se crea una transmisión con balizas del servidor.
media_verification_url string

URL de verificación de medios.
apple_tv object(AppleTV)

Información opcional específica de los dispositivos AppleTV. Solo para HLS
ad_breaks [object(AdBreak)]

Una lista de pausas publicitarias. Se omite si está vacío.

AppleTV

AppleTV contiene información específica de los dispositivos Apple TV.
Representación JSON
{
  "interstitials_url": string,
}
Campos
interstitials_url string

URL de anuncios intersticiales.

AdBreak

La pausa publicitaria describe una sola pausa publicitaria en la transmisión. Contiene una posición, una duración, un tipo (medio/pre/publicación) y una lista de anuncios.
Representación JSON
{
  "type": string,
  "start": number,
  "duration": number,
  "ads": [object(Ad)],
}
Campos
type string

Los tipos de pausa válidos son los siguientes: durante el período, previo y posterior.
start number

Posición en la transmisión en la que comienza la pausa (en segundos).
duration number

Duración de la pausa publicitaria, en segundos.
ads [object(Ad)]

Una lista de anuncios. Se omite si está vacío.
El anuncio describe un anuncio en la transmisión. Contiene la posición del anuncio en la pausa, la duración del anuncio y algunos metadatos opcionales.
Representación JSON
{
  "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),
}
Campos
seq number

Posición del anuncio en la pausa.
start number

Indica la posición en las novedades en las que comienza el anuncio, en segundos.
duration number

Duración del anuncio, en segundos.
title string

Título opcional del anuncio.
description string

Descripción opcional del anuncio.
advertiser string

Identificador de anunciante opcional.
ad_system string

Sistema de anuncios opcional.
ad_id string

ID del anuncio opcional.
creative_id string

ID opcional de la creatividad.
creative_ad_id string

ID opcional del anuncio de la creatividad.
deal_id string

ID opcional del acuerdo.
clickthrough_url string

URL de clic opcional.
icons [object(Icon)]

Una lista de íconos, que se omiten si están vacíos.
wrappers [object(Wrapper)]

Una lista de wrappers. Se omite si está vacío.
events [object(Event)]

Una lista de los eventos en el anuncio.
verifications [object(Verification)]

Entradas opcionales de verificación de Open Measurement que enumeran los recursos y metadatos necesarios para ejecutar el código de medición de terceros y verificar la reproducción de creatividades.
universal_ad_id object(UniversalAdID)

ID de anuncio universal opcional.
companions [object(Companion)]

Anuncios complementarios opcionales que se pueden mostrar con este anuncio.
interactive_file object(InteractiveFile)

Creatividad interactiva opcional (SIMID) que se debe mostrar durante la reproducción del anuncio

Evento

El evento contiene un tipo de evento y la hora de presentación del evento.
Representación JSON
{
  "time": number,
  "type": string,
}
Campos
time number

Hora de presentación de este evento
type string

Este es el tipo de evento.

Subtítulo

El subtítulo describe una pista de subtítulo del archivo adicional para la transmisión de video por Internet. Almacena dos formatos de subtítulos: TTML y WebVTT. El atributo TTMLPath contiene la URL que dirige al archivo adicional de TTML y el atributo WebVTTPath, de manera similar, contiene una URL que dirige al archivo de archivo adicional de WebVTT.
Representación JSON
{
  "language": string,
  "language_name": string,
  "ttml": string,
  "webvtt": string,
}
Campos
language string

Un código de idioma, como "en" o "de".
language_name string

Nombre descriptivo del idioma. Diferencia el conjunto específico de subtítulos si existen varios conjuntos para el mismo idioma.
ttml string

URL opcional al archivo adicional de TTML.
webvtt string

URL opcional del archivo adicional de WebVTT.

Ícono

El ícono contiene información sobre un ícono de VAST.
Representación JSON
{
  "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,
}
Campos
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

ClickData contiene información acerca de un ícono de clic.
Representación JSON
{
  "url": string,
}
Campos
url string

FallbackImage

FallbackImage contiene información sobre una imagen de resguardo de VAST.
Representación JSON
{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}
Campos
creative_type string

height int32

width int32

resource string

alt_text string

Wrapper

El wrapper contiene información sobre un anuncio wrapper. No incluye un ID del acuerdo si no existe.
Representación JSON
{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}
Campos
system string

Identificador del sistema de anuncios.
ad_id string

Es el ID del anuncio que se usa para el anuncio wrapper.
creative_id string

Es el ID de la creatividad que se usa para el anuncio envoltorio.
creative_ad_id string

Es el ID del anuncio de la creatividad que se usa para el anuncio envoltorio.
deal_id string

ID del acuerdo opcional para el anuncio wrapper.

Verificación

La verificación contiene información para Open Measurement, que facilita la medición de visibilidad y verificación de terceros. Actualmente, solo se admiten recursos JavaScript. Consulta https://iabtechlab.com/standards/open-measurement-sdk/
Representación JSON
{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}
Campos
vendor string

El proveedor de verificación.
java_script_resources [object(JavaScriptResource)]

Lista de recursos de JavaScript para la verificación.
tracking_events [object(TrackingEvent)]

Lista de los eventos de seguimiento para la verificación.
parameters string

Es una cadena opaca que se pasa al código de verificación de arranque.

JavaScriptResource

El recurso JavaScript contiene información para la verificación a través de JavaScript.
Representación JSON
{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}
Campos
script_url string

URI a la carga útil de JavaScript.
api_framework string

APIFramework es el nombre del framework del video que ejecuta el código de verificación.
browser_optional boolean

Indica si esta secuencia de comandos se puede ejecutar fuera de un navegador.

TrackingEvent

TrackingEvent contiene las URLs a las que el cliente debe hacer ping en determinadas situaciones.
Representación JSON
{
  "event": string,
  "uri": string,
}
Campos
event string

El tipo del evento de seguimiento.
uri string

El evento de seguimiento al que se hará ping.

UniversalAdID

UniversalAdID se usa para proporcionar un identificador de creatividad único que se mantiene en todos los sistemas de anuncios.
Representación JSON
{
  "id_value": string,
  "id_registry": string,
}
Campos
id_value string

El ID del anuncio universal de la creatividad seleccionada para el anuncio.
id_registry string

Es una cadena que se usa para identificar la URL del sitio web de registro en la que se cataloga el ID del anuncio universal de la creatividad seleccionada.

Anuncio complementario

El anuncio complementario contiene información de anuncios complementarios que se pueden mostrar junto con el anuncio.
Representación JSON
{
  "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)],
}
Campos
click_data object(ClickData)

Los datos de clics para este anuncio complementario.
creative_type string

El atributo CreativeType en el nodo <StaticResource> de VAST si es un complemento de tipo estático.
height int32

La altura en píxeles de este anuncio complementario.
width int32

El ancho en píxeles de este complementario.
resource string

Para los complementos estáticos y de iframe, esta será la URL que se cargará y mostrará. En el caso de los complementarios de HTML, este será el fragmento HTML que se debería mostrar como complementario.
type string

Tipo de este complementario. Puede ser estático, iframe o HTML.
ad_slot_id string

El ID de ranura de este complemento.
api_framework string

Marco de trabajo de la API para este complemento.
tracking_events [object(TrackingEvent)]

Lista de eventos de seguimiento para este complemento.

InteractiveFile

InteractiveFile contiene información para la creatividad interactiva (es decir, SIMID) que debe mostrarse durante la reproducción del anuncio.
Representación JSON
{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}
Campos
resource string

La URL de la creatividad interactiva.
type string

El tipo MIME del archivo proporcionado como recurso.
variable_duration boolean

Indica si esta creatividad puede solicitar que se extienda la duración.
ad_parameters string

El valor del nodo <AdParameters> en la VAST.