API en vivo de publicación de grupos de inserción de anuncios dinámicos

La API de inserción de anuncios dinámicos te permite solicitar y hacer un seguimiento de las transmisiones en vivo de DAI.

Servicio: dai.google.com

Todos los URI son relativos a https://dai.google.com.

Método: stream

Métodos
stream POST /ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

Registra una sesión de transmisión en vivo de publicación de grupos de anuncios de DAI.

Solicitud HTTP

POST https://dai.google.com/ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

Parámetros de ruta

Parámetros
network_code string

Es el código de red de Google Ad Manager del publicador.

custom_asset_key string

Es el identificador personalizado asociado a este evento en Google Ad Manager.

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
Parámetros de segmentación de DFP Opcional Son parámetros de segmentación adicionales.
Anular los parámetros de transmisión Opcional Anula los valores predeterminados de un parámetro de creación de transmisiones.
Autenticación con HMAC Opcional Autentica con un token basado en HMAC.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta contiene un objeto Stream nuevo.

Open Measurement

La API de DAI contiene información para la verificación de Open Measurement en el campo Verifications. Este campo contiene uno o más elementos Verification que enumeran los recursos y los metadatos necesarios para ejecutar el código de medición de terceros y verificar la reproducción de la creatividad. Solo se admite JavaScriptResource. Para obtener más información, consulta IAB Tech Lab y la especificación de VAST 4.1.

Método: Segmento de podcast

Métodos
pod segment GET /linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

Crea una transmisión de DAI para el ID de evento determinado.

Solicitud HTTP

GET https://dai.google.com/linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

Parámetros de ruta

Parámetros
network_code string

Es el código de red de Google Ad Manager del publicador.

custom_asset_key string

Es el identificador personalizado asociado a este evento en Google Ad Manager.

pod_identifier

Se admiten los siguientes formatos:

pod/{integer}

Es el identificador numérico de la pausa publicitaria actual. Los IDs de los pods de anuncios se asignan de forma incremental para cada evento de pausa publicitaria, comenzando en 1.

ad_break_id/{string}

Es el identificador de cadena de la pausa publicitaria actual. Cualquier ID de pausa publicitaria desconocido que se proporcione a ese extremo crea una nueva pausa publicitaria para el evento de transmisión en vivo.

Se aplican las siguientes restricciones a los IDs de pausas publicitarias personalizadas:

  • Debe tener entre 1 y 63 caracteres.
  • Solo debe contener letras minúsculas, dígitos y guiones.
profile_name string

Es el nombre del perfil de codificación de la DAI de Google Ad Manager solicitado. El perfil de codificación debe ser uno de los perfiles de codificación configurados para el evento seleccionado.

segment_number integer

Índice del segmento solicitado dentro del grupo de anuncios actual, que comienza en cero.
segment_format string

Es la extensión de archivo asociada con el formato de segmento solicitado. Las extensiones aceptadas son: ts, mp4, vtt, aac, ac3 o eac3.

Parámetros de consulta

Parámetros
stream_id required string

Es el ID de transmisión de la sesión del usuario actual. Este valor se muestra en una solicitud exitosa al extremo stream.
sd required1 integer

Es la duración del segmento solicitado, en milisegundos.
so opcional

Es el desplazamiento del segmento solicitado dentro del grupo de anuncios, en milisegundos. Si omites el parámetro so, se calculará multiplicando la duración del segmento por el número de segmento.
pd required2 integer

Es la duración del grupo de anuncios, en milisegundos.
auth-token required string

El auth-token consta de un token de HMAC codificado con los siguientes datos:

  • pod_id o ad_break_id
  • network_code
  • custom_asset_key
  • cust_params
  • pd
  • scte35
  • exp
last opcional boolean

Indica el último segmento de la pausa publicitaria. Omite este parámetro para todos los demás segmentos.
scte35 opcional string

Es el indicador SCTE-35 codificado en Base64 para esta pausa publicitaria.
cust_params opcional string

Es un conjunto de pares clave-valor que se usa para la segmentación de campañas de Ad Manager. Estos pares se deben representar como una cadena de consulta codificada como URL.

Ejemplo:
Parámetros
  • section = sports
  • page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

Pies de página

  1. sd no es obligatorio para los segmentos de inicialización. ↩
  2. pd no es obligatorio para los eventos con pausas publicitarias sin duración habilitadas. ↩

Ejemplo

GET https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/ad_break_id/adbreak-2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a674cb:TEST

GET https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/pod/2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a674cb:TEST

Cuerpo de la respuesta

Si la operación se realiza correctamente, el cuerpo de la respuesta será un segmento de transmisión reproducible que coincida con el formato y los parámetros especificados en la solicitud.

Método: Manifiesto de grupo de anuncios de HLS

Recupera un manifiesto de grupo de anuncios de HLS de una transmisión en vivo que está lista para que un reproductor de video del cliente la cargue y reproduzca.

Métodos
GET GET /linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset}/{pod_identifier}.m3u8;

API para recuperar una playlist de múltiples variantes de HLS para un grupo de anuncios.

Solicitud HTTP

GET https://dai.google.com/linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}.m3u8?stream_id={stream_id}&pd={pod_duration}

Parámetros de ruta

Parámetros
network_code string

Es el código de red de Google Ad Manager del publicador.
custom_asset_key string

Es el identificador personalizado asociado a este evento en Google Ad Manager.
pod_identifier

Se admiten los siguientes formatos:

pod/{integer}

Es el identificador numérico de la pausa publicitaria actual. Los IDs de los pods de anuncios se asignan de forma incremental para cada evento de pausa publicitaria, comenzando en 1.

ad_break_id/{string}

Es el identificador de cadena de la pausa publicitaria actual. Cualquier ID de pausa publicitaria desconocido que se proporcione a ese extremo crea una nueva pausa publicitaria para el evento de transmisión en vivo.

Se aplican las siguientes restricciones a los IDs de pausas publicitarias personalizadas:

  • Debe tener entre 1 y 63 caracteres.
  • Solo debe contener letras minúsculas, dígitos y guiones.

Parámetros de consulta

Parámetros
stream_id Obligatorio string

Es el ID de transmisión de la sesión del usuario actual. Este valor se muestra en una solicitud exitosa al extremo stream.
pd Obligatorio integer

Es la duración del grupo de anuncios, expresada en milisegundos.
scte35 opcional string

Es el indicador SCTE-35 codificado en Base64 para esta pausa publicitaria.
cust_params opcional string

Es un conjunto de pares clave-valor que se usa para la segmentación de campañas de Ad Manager. Estos pares se deben representar como una cadena de consulta codificada como URL.

Ejemplo:
Parámetros
  • section = sports
  • page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...
auth-token required string

El auth-token consta de un token de HMAC codificado con los siguientes datos:

  • pod_id o ad_break_id
  • network_code
  • custom_asset_key
  • cust_params
  • pd
  • scte35
  • exp

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta es una playlist de múltiples variantes de HLS.

Método: Manifiesto de grupo de anuncios de DASH

Recupera un manifiesto de grupo de anuncios de MPEG-DASH de una transmisión en vivo que está lista para que un reproductor de video del cliente la cargue y reproduzca.

Métodos
GET GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset}/stream/{stream_id}/{pod_identifier}/manifest.mpd

API para recuperar una playlist de MPD de MPEG-DASH para un grupo de anuncios.

Solicitud HTTP

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/stream/{stream_id}/pod/{pod_id}/manifest.mpd?pd={pod_duration}

Parámetros de ruta

Parámetros
network_code string

Es el código de red de Google Ad Manager del publicador.
custom_asset_key string

Es el identificador personalizado asociado a este evento en Google Ad Manager.
stream_id string

Es el ID de transmisión de la sesión del usuario actual. Este valor se muestra en una solicitud exitosa al extremo stream.
pod_identifier

Se admiten los siguientes formatos:

pod/{integer}

Es el identificador numérico de la pausa publicitaria actual. Los IDs de los pods de anuncios se asignan de forma incremental para cada evento de pausa publicitaria, comenzando en 1.

ad_break_id/{string}

Es el identificador de cadena de la pausa publicitaria actual. Cualquier ID de pausa publicitaria desconocido que se proporcione a ese extremo crea una nueva pausa publicitaria para el evento de transmisión en vivo.

Se aplican las siguientes restricciones a los IDs de pausas publicitarias personalizadas:

  • Debe tener entre 1 y 63 caracteres.
  • Solo debe contener letras minúsculas, dígitos y guiones.

Parámetros de consulta

Parámetros
pd Obligatorio integer

Es la duración del grupo de anuncios, expresada en milisegundos.
scte35 opcional string

Es el indicador SCTE-35 codificado en Base64 para esta pausa publicitaria.
cust_params opcional string

Es un conjunto de pares clave-valor que se usa para la segmentación de campañas de Ad Manager. Estos pares se deben representar como una cadena de consulta codificada como URL.

Ejemplo:
Parámetros
  • section = sports
  • page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...
auth-token required string

El auth-token consta de un token de HMAC codificado con los siguientes datos:

  • pod_id o ad_break_id
  • network_code
  • custom_asset_key
  • cust_params
  • pd
  • scte35
  • exp

Cuerpo de la respuesta

Si la solicitud se ejecuta correctamente, el cuerpo de la respuesta es una playlist en formato mpd de MPEG-DASH.

Método: Plantilla de período de pod de DASH

Métodos
pods GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

Solicita una plantilla de período de DASH a Google Ad Manager. Esta plantilla contiene macros que debes completar con los parámetros de tu transmisión. Una vez que se propagan estas macros, la plantilla se convierte en tu pausa publicitaria y se puede unir a tu manifiesto de DASH.

Solicitud HTTP

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

Parámetros de ruta

Parámetros
network_code string

Es el código de red de Google Ad Manager del publicador.

custom_asset_key string

Es el identificador personalizado asociado a este evento en Google Ad Manager.

Parámetros de consulta

Parámetros
stream_id required string

Es el ID de transmisión de la sesión del usuario actual. Este valor se muestra en una solicitud exitosa al extremo stream.
tv opcional integer

Es la versión de la plantilla. La configuración predeterminada es 0. Especifica la versión de la plantilla de Pod que se devolverá.

  • 0: Solicita una plantilla que use el identificador de secuencia de Pod.
  • 1: Solicita una plantilla que admita tanto identificadores de secuencia de Pod como de pausa publicitaria.

Cuerpo de la respuesta

Si el proceso se realiza correctamente, el cuerpo de la respuesta contiene un objeto PodTemplateResponse nuevo.

Método: Metadatos de sincronización del grupo de anuncios

Métodos
ad pod timing metadata GET /linear/pods/v1/adv/network/{network_code}/custom_asset/{custom_asset_key}/pod.json

Recupera los metadatos de sincronización del pod de anuncios.

Solicitud HTTP

GET https://dai.google.com/linear/pods/v1/adv/network/{network_code}/custom_asset/{custom_asset_key}/pod.json

Parámetros de ruta

Parámetros
network_code string

Es el código de red de Google Ad Manager del publicador.

custom_asset_key string

Es el identificador personalizado asociado a esta transmisión en vivo en Google Ad Manager.

Parámetros de consulta

Parámetros
stream_id Obligatorio string

Es el ID de transmisión de Ad Manager de la app del reproductor de video del cliente.
ad_break_id required string

Es el ID de la próxima pausa publicitaria.

El servidor de unión o el VTP proporcionan los IDs de las pausas publicitarias, y estos deben coincidir en las notificaciones de pausas publicitarias anticipadas, las solicitudes de metadatos de sincronización de grupos de anuncios y las solicitudes de redireccionamiento de segmentos para la misma pausa publicitaria.

Se aplican las siguientes restricciones a los IDs de pausas publicitarias personalizadas:

  • Debe tener entre 1 y 63 caracteres.
  • Solo debe contener letras minúsculas, dígitos y guiones.
  • El ID de pausa publicitaria preroll está reservado para recuperar el grupo de anuncios previos al video. No se puede usar para identificar ningún otro grupo de anuncios.
auth-token required string

El auth-token consta de un token de HMAC codificado con los siguientes datos:

  • ad_break_id
  • network_code
  • custom_asset_key
  • cust_params
  • pd
  • scte35
  • exp
timeout opcional integer

Es la cantidad de milisegundos que la DAI puede bloquear esta solicitud para esperar la decisión sobre los anuncios. Utiliza este parámetro en las solicitudes que deben devolver anuncios completados en la primera solicitud, como las pausas publicitarias previas al video.

Si se supera el tiempo de espera, la solicitud devuelve el estado pendiente.

Si se incluye, el valor del tiempo de espera debe estar entre 1,000 y 15,000 milisegundos. Si se omite, las respuestas no se retrasan para esperar la toma de decisiones sobre los anuncios.
final opcional boolean

Se establece en true para indicarle a la DAI que esta es la última solicitud que el VTP está dispuesto a realizar para este grupo de anuncios. Si aún no hay disponible una decisión sobre el anuncio (antes del tiempo de espera opcional), la DAI devolverá la pizarra de forma permanente para esta solicitud.

La configuración predeterminada es false.

Parámetros de la decisión publicitaria
pd opcional integer

Es la duración de la pausa publicitaria (en milisegundos). También se conoce como duración del grupo de anuncios.

Si se usa EABN, el valor de pd debe coincidir con la duración proporcionada en la notificación de pausa publicitaria. Si las duraciones no coinciden, se le dará prioridad al valor del EABN.

cust_params opcional string

Parámetros personalizados para la segmentación de pausas publicitarias, como se describe en el Centro de ayuda de Ad Manager.
scte35 opcional string

Es un indicador SCTE-35 codificado en base64.

Si el indicador no es válido, se enviará un mensaje en el encabezado HTTP X-Ad-Manager-Dai-Warning de la respuesta y la solicitud se enviará sin el valor scte35 no válido.

Cuerpo de la respuesta

Si el proceso se realiza correctamente, el cuerpo de la respuesta contiene un objeto AdPodTimingMetadataResponse nuevo.

Método: Verificación de medios

Después de encontrar un identificador de medios del anuncio durante la reproducción, realiza de inmediato una solicitud con la media_verification_url obtenida del extremo stream anterior. Estas solicitudes no son necesarias para las transmisiones de balizas 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 sobre un evento de verificación de medios.

Solicitud HTTP

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

Cuerpo de la respuesta

media verification devuelve 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 de URL incorrecto o al vencimiento.
  • HTTP/1.1 404 Not Found si se aprobó 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 los recursos multimedia del anuncio

Los identificadores de medios de los anuncios se codificarán en una pista de metadatos independiente: metadatos cronometrados para la transmisión de transporte de HLS o emsg para los archivos mp4. Los identificadores de medios de anuncios siempre comenzarán con la cadena google_.

Todo el contenido de texto de la entrada de metadatos se debe agregar a la URL de verificación del anuncio antes de realizar cada solicitud de verificación del anuncio.

Método: metadata

El extremo de metadatos en metadata_url devuelve información que se usa para compilar una IU de anuncios. El extremo de metadatos no está disponible para las transmisiones de balizas del servidor, en las que el servidor es responsable de iniciar la verificación de medios publicitarios.

Métodos
metadata GET /{metadata_url}/{ad-media-id}

GET /{metadata_url}

Recupera información de metadatos del anuncio.

Solicitud HTTP

GET https://{metadata_url}/{ad-media-id}

GET https://{metadata_url}

Parámetros de consulta

Parámetros
delta_token opcional string

Es un token opaco que representa el estado de sincronización actual del cliente. Si se proporciona, el servidor solo devuelve los metadatos que cambiaron desde que se generó el token, junto con un nuevo next_delta_token en la respuesta. Si se omite, el servidor devuelve los metadatos completos de toda la ventana del DVR.

Cuerpo de la respuesta

Si se ejecuta correctamente, la respuesta devuelve una instancia de PodMetadata.

Análisis de metadatos

Los metadatos tienen tres secciones discretas: tags, ads y breaks. El punto de entrada a los datos es la sección tags. A partir de ahí, itera por las etiquetas y busca la primera entrada cuyo nombre sea un prefijo para el ID de medios del anuncio que se encuentra en la transmisión de video. Por ejemplo, podrías tener un ID de medios del anuncio que se vea de la siguiente manera:

google_1234567890

Luego, encontrarás un objeto de etiqueta llamado google_12345. En este caso, coincide con el ID de los medios de tu anuncio. Una vez que encuentres el objeto de prefijo de medios del anuncio correcto, podrás buscar los IDs de anuncios, los IDs de pausas publicitarias y el tipo de evento. Luego, los IDs de anuncios se usan para indexar los objetos ads y los IDs de pausas publicitarias se usan para indexar los objetos breaks.

Objetos de la API

Transmisión

Stream se usa para renderizar una lista de recursos para una transmisión creada recientemente en formato JSON.
Representación JSON
{
  "stream_id": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "heartbeat_url": string,
  "polling_frequency": number,
  "pod_manifest_url": string,
  "manifest_format": string,
}
Campos
stream_id string

Es el identificador del flujo de GAM.
media_verification_url string

Es la URL de verificación de medios que se usa como endpoint base para hacer un seguimiento de los eventos de reproducción.
metadata_url string

Es la URL de metadatos que se usa para sondear información periódica sobre los próximos eventos de anuncios de transmisión.
session_update_url string

Es la URL de actualización de la sesión que se usa para actualizar los parámetros de segmentación de esta transmisión. Los valores originales de los parámetros de segmentación se capturan durante la solicitud inicial de creación de la transmisión.
heartbeat_url string

Es la URL de latido, que se usa para mantener activa la transmisión de conteo de píxeles del servidor. Se debe hacer ping cada {PollingFrequency} segundos. Se completa para los flujos de píxeles contadores del servidor.
polling_frequency number

Es la frecuencia de sondeo, en segundos, cuando se solicita metadata_url o heartbeat_url.
pod_manifest_url string

La plantilla de URL del manifiesto del grupo de anuncios se usa para generar la URL que permite recuperar el manifiesto del grupo de anuncios de una transmisión, que corresponde a la URL de la playlist multivariante en HLS o al MPD en DASH. Se propaga para los eventos de transmisión en vivo del tipo de inserción de anuncios dinámicos POD_SERVING_MANIFEST. https://developers.google.com/ad-manager/api/reference/v202305/LiveStreamEventService.DynamicAdInsertionType
manifest_format string

El formato del manifiesto es el formato del manifiesto recuperado de pod_manifest_url, ya sea dash o hls.

PodMetadata

PodMetadata contiene información de metadatos sobre anuncios, pausas publicitarias y etiquetas de ID de medios.
Representación JSON
{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
  "next_delta_token": string,
  "obsolete_ad_break_ids": [],
}
Campos
tags map[string, object(TagSegment)]

Mapa de segmentos de etiquetas indexados por prefijo de etiqueta.
ads map[string, object(Ad)]

Mapa de anuncios indexados por ID de anuncio.
ad_breaks map[string, object(AdBreak)]

Mapa de las pausas publicitarias indexadas por ID de pausa publicitaria.
next_delta_token string

Es un token opaco que el cliente puede usar en la próxima votación.
obsolete_ad_break_ids string

Es una lista de IDs de pausas publicitarias que están obsoletos y se deben quitar de la caché del cliente.

TagSegment

TagSegment contiene una referencia a un anuncio, su pausa publicitaria y el tipo de evento. No se debe enviar un ping de TagSegment con type="progress" al extremo de verificación de medios del anuncio.
Representación JSON
{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}
Campos
ad string

ID del anuncio de esta etiqueta.
ad_break_id string

ID de la pausa publicitaria de esta etiqueta.
type string

Es el tipo de evento de esta etiqueta.

AdBreak

AdBreak describe una sola pausa publicitaria en la transmisión. Contiene una duración, un tipo (mid/pre/post) y la cantidad de anuncios.
Representación JSON
{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}
Campos
type string

Los tipos de interrupción válidos son pre, mid y post.
duration number

Duración total del anuncio para esta pausa publicitaria, en segundos.
expected_duration number

Duración esperada de la pausa publicitaria (en segundos), incluidos todos los anuncios y las cortinillas de video.
ads number

Cantidad de anuncios en la pausa publicitaria.
El anuncio describe un anuncio en la transmisión.
Representación JSON
{
  "ad_break_id": string,
  "position": 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,
  "click_tracking_urls": [],
  "verifications": [object(Verification)],
  "slate": boolean,
  "icons": [object(Icon)],
  "wrappers": [object(Wrapper)],
  "universal_ad_id": object(UniversalAdID),
  "extensions": [],
  "companions": [object(Companion)],
  "interactive_file": object(InteractiveFile),
}
Campos
ad_break_id string

ID de la pausa publicitaria de este anuncio.
position number

Posición de este anuncio en la pausa publicitaria, a partir de 1.
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 del anunciante opcional.
ad_system string

Sistema de anuncios opcional.
ad_id string

ID de anuncio opcional.
creative_id string

ID de creatividad opcional.
creative_ad_id string

ID de anuncio de la creatividad opcional.
deal_id string

ID del acuerdo opcional.
clickthrough_url string

URL de clic opcional.
click_tracking_urls string

URLs de seguimiento de clics opcionales.
verifications [object(Verification)]

Entradas de verificación de Open Measurement opcionales que enumeran los recursos y los metadatos necesarios para ejecutar el código de medición de terceros y verificar la reproducción de la creatividad.
slate boolean

Es un valor booleano opcional que indica que la entrada actual es una pizarra.
icons [object(Icon)]

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

Lista de Wrappers, se omite si está vacía.
universal_ad_id object(UniversalAdID)

ID de anuncio universal opcional.
extensions string

Lista opcional de todos los nodos <Extension> en VAST.
companions [object(Companion)]

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

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

PodTemplateResponse

PodTemplateResponse representa la carga útil de JSON que se devuelve a un VTP para la unión de pods.
Representación JSON
{
  "dash_period_template": string,
  "segment_duration_ms": int64,
}
Campos
dash_period_template string

DashPeriodTemplate es la plantilla XML del período que se completará con los datos adecuados antes de la unión.
segment_duration_ms int64

SegmentDurationMS es la duración de los segmentos del período en milisegundos.

AdpodTimingMetadataResponse

AdpodTimingMetadataResponse contiene información sobre el Ad Pod y cómo compilar URLs de segmentos para él.
Representación JSON
{
  "status": string,
  "ads": [object(AdRendering)],
  "slate": object(SlateRendering),
  "dash_representations": map[string, object(DASHRepresentation)],
  "dash_adaptation_sets": map[string, object(DASHAdaptationSet)],
}
Campos
status string

Estado de la decisión para el grupo de anuncios.
ads [object(AdRendering)]

Es un array de objetos Ad que describe cómo renderizar las URLs de los segmentos de anuncios, indexado a partir de 0.
slate object(SlateRendering)

Pizarra que describe cómo renderizar las URLs de segmentos de pizarra.
dash_representations map[string, object(DASHRepresentation)]

Lista de representaciones de DASH para que se renderice ese grupo de anuncios en los manifiestos de DASH.
dash_adaptation_sets map[string, object(DASHAdaptationSet)]

Lista de grupos de adaptación de DASH para que se renderice ese grupo de anuncios en los manifiestos de DASH.

AdRendering

AdRendering describe cómo renderizar un anuncio con una decisión.
Representación JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
Campos
duration_ms number

Duración del anuncio, en milisegundos (int).
variants map[string, object(VariantRendering)]

Es un diccionario de objetos Variant (consulta a continuación), indexado por el ID de variante o perfil, según se configuró en la IU.

SlateRendering

SlateRendering describe cómo renderizar contenido de pizarra.
Representación JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
Campos
duration_ms number

Duración de la pizarra, en milisegundos (int).
variants map[string, object(VariantRendering)]

Diccionario de objetos Variant, indexado por ID de variante o perfil. Las duraciones de las pizarras deben repetirse hasta que se alcance la longitud requerida, insertando discontinuidades de HLS entre las iteraciones o repitiendo nuevos períodos para MPEG-DASH.

VariantRendering

VariantRendering describe una variante o un perfil dentro del anuncio o la pizarra.
Representación JSON
{
  "segment_extension": string,
  "segment_durations": object(SegmentDurations),
}
Campos
segment_extension string

String, uno de los siguientes: ts, mp4, aac, ac3, ec3, m4a, m4v. Es la parte de la extensión del nombre de archivo de las URLs de segmentos.
segment_durations object(SegmentDurations)

Objetos SegmentDurations. Cada duración de segmento se puede traducir en una URL de segmento.

SegmentDurations

SegmentDurations describe la duración de una secuencia de segmentos en una unidad de tiempo especificada.
Representación JSON
{
  "timescale": number,
  "values": [],
}
Campos
timescale number

Timescale es la cantidad de unidades por segundo (int) Se espera que sea: 1000 para HLS (milisegundos) 90000 para video DASH (PTS) Frecuencia de muestreo de audio para audio DASH.
values number

Es un array de duraciones de segmentos int, en unidades de escala de tiempo.

DASHRepresentation

DASHRepresentation describe los nodos de Representation que se renderizarán en los manifiestos de DASH.
Representación JSON
{
  "codecs": string,
  "bandwidth": number,
  "width": number,
  "height": number,
  "frame_rate": string,
  "audio_sampling_rate": number,
  "audio_channel_config": object(SchemeIDURIAndValue),
}
Campos
codecs string

Códecs de la representación.
bandwidth number

Ancho de banda de la representación.
width number

Ancho de la representación.
height number

Altura de la representación.
frame_rate string

Velocidad de fotogramas de la representación.
audio_sampling_rate number

Es la tasa de muestreo de audio de la representación.
audio_channel_config object(SchemeIDURIAndValue)

Configuración del canal de audio de la representación.

DASHAdaptationSet

DASHAdaptationSet describe los nodos AdaptationSet que se renderizarán en los manifiestos de DASH.
Representación JSON
{
  "content_type": string,
  "mime_type": string,
  "role": object(SchemeIDURIAndValue),
  "inband_event_stream": object(SchemeIDURIAndValue),
  "min_frame_rate": string,
  "max_frame_rate": string,
  "scan_type": string,
  "start_with_sap": string,
  "segment_alignment": boolean,
  "representations": [],
}
Campos
content_type string

Tipo de contenido del conjunto de adaptación.
mime_type string

Tipo de MIME del conjunto de adaptación.
role object(SchemeIDURIAndValue)

Es el rol del conjunto de adaptación.
inband_event_stream object(SchemeIDURIAndValue)

Es la transmisión de eventos dentro de la banda del conjunto de adaptación.
min_frame_rate string

Es la velocidad de fotogramas mínima del conjunto de adaptación.
max_frame_rate string

Velocidad de fotogramas máxima del conjunto de adaptación.
scan_type string

Tipo de análisis del conjunto de adaptación.
start_with_sap string

Comienza con el SAP del conjunto de adaptación.
segment_alignment boolean

Alineación de segmentos del conjunto de adaptación.
representations string

Representaciones del conjunto de adaptación.

SchemeIDURIAndValue

SchemeIDURIAndValue es un par de un ID de esquema y su valor.
Representación JSON
{
  "scheme_id_uri": string,
  "value": string,
}
Campos
scheme_id_uri string

Es el URI del ID del esquema del valor.
value string

Valor del URI del ID del esquema.

Í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 sobre un clic de redireccionamiento de ícono.
Representación JSON
{
  "url": string,
}
Campos
url string

FallbackImage

FallbackImage contiene información sobre una imagen de respaldo 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 de 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

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

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

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

ID de acuerdo opcional para el anuncio wrapper.

Verificación

La verificación contiene información para Open Measurement, lo que facilita la medición de la visibilidad y la verificación de terceros. Actualmente, solo se admiten recursos de 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 eventos de seguimiento para la verificación.
parameters string

Cadena opaca que se pasa al código de verificación de arranque.

JavaScriptResource

JavaScriptResource 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 de la carga útil de JavaScript.
api_framework string

APIFramework es el nombre del framework de 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 URLs a las que el cliente debe enviar un ping en determinadas situaciones.
Representación JSON
{
  "event": string,
  "uri": string,
}
Campos
event string

Es el tipo de evento de seguimiento.
uri string

Es el evento de seguimiento al que se enviará un ping.

UniversalAdID

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

Es el ID de 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 del registro en el que se cataloga el ID de anuncio universal de la creatividad seleccionada.

Companion

Companion contiene información sobre los 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)

Son los datos de clics de este complemento.
creative_type string

El atributo CreativeType en el nodo <StaticResource> en VAST si se trata de un elemento complementario de tipo estático.
height int32

Altura en píxeles de este anuncio complementario.
width int32

Ancho en píxeles de este anuncio complementario.
resource string

En el caso de los complementos estáticos y de iframe, esta será la URL que se cargará y mostrará. En el caso de los anuncios complementarios en HTML, será el fragmento de HTML que se debe mostrar como anuncio complementario.
type string

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

Es el ID del espacio de este compañero.
api_framework string

Es el framework de la API para este complemento.
tracking_events [object(TrackingEvent)]

Lista de eventos de seguimiento para este compañero.

InteractiveFile

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

URL de la creatividad interactiva.
type string

Tipo de 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 VAST.