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

La API de Dynamic Ad Insertion te permite solicitar y hacer un seguimiento de las transmisiones en vivo de DAI.

Servicio: dai.google.com

Todos los URI están relacionados con https://dai.google.com.

Método: transmisión

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 la 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 que asoció 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 Parámetros de segmentación adicionales.
Cómo anular los parámetros de transmisión Opcional Anula los valores predeterminados de un parámetro de creación de transmisiones.
Autenticación HMAC Opcional Autentícate con un token basado en HMAC.

Cuerpo de la respuesta

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

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 metadatos necesarios para ejecutar el código de medición de terceros y verificar la reproducción de las creatividades. 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 pod

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 un flujo 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 que asoció 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 grupo de anuncios se asignan de forma incremental para cada evento de pausa publicitaria, a partir de 1.

ad_break_id/{string}

Es el identificador de cadena de la pausa publicitaria actual.

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

Es el í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 correcta al extremo stream.

sd required1 integer

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

so opcional

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

pd obligatorio2 integer

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

auth-token required string

Un token HMAC firmado y codificado en URL para el grupo de anuncios actual

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 la señal SCTE-35 codificada 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 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 HLS

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

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

Es una 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/{pod_id}.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

El identificador personalizado que asoció este evento en Google Ad Manager

pod_id integer

Es el identificador numérico de la pausa publicitaria actual. Los IDs de grupo de anuncios se asignan de forma incremental para cada evento de pausa publicitaria, a partir de 1.

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 a través de una solicitud correcta al extremo stream.

pd Obligatorio integer

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

scte35 opcional string

Es la señal SCTE-35 codificada 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...

Cuerpo de la respuesta

Si se ejecuta de forma correcta, 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 MPEG-DASH de una transmisión en vivo que está listo para que un reproductor de video cliente lo cargue y reproduzca.

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

Es una API para recuperar una playlist MPD 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

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 a través de una solicitud correcta al extremo stream.

pod_id integer

Es el identificador numérico de la pausa publicitaria actual. Los IDs de grupo de anuncios se asignan de forma incremental para cada evento de pausa publicitaria, a partir de 1.

Parámetros de consulta

Parámetros
pd Obligatorio integer

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

scte35 opcional string

Es la señal SCTE-35 codificada 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...

Cuerpo de la respuesta

Si se ejecuta de manera correcta, el cuerpo de la respuesta es una playlist mpd 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 propagar con tus parámetros de transmisión. Una vez que se propaguen estas macros, la plantilla se convertirá en tu período de pausa publicitaria y se podrá unir a tu manifiesto 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 que asoció 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 correcta al extremo stream.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene un objeto PodTemplateResponse nuevo.

Método: verificación de contenido multimedia

Después de encontrar un identificador de medios del anuncio durante la reproducción, realiza una solicitud de inmediato con la media_verification_url que se obtuvo del extremo de stream anterior. Estas solicitudes no son necesarias para las transmisiones de píxeles contadores del servidor, en las que el servidor inicia la verificación de contenido multimedia.

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 contenido multimedia.

Solicitud HTTP

GET https://{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 contenido multimedia 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 incorrecto de la URL o a su 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 medios de anuncios

Los identificadores de contenido multimedia del anuncio se codificarán en una pista de metadatos independiente: metadatos sincronizados para la transmisión de transporte HLS o emsg para 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 adjuntar a la URL de verificación de anuncios antes de realizar cada solicitud de verificación de anuncios.

Método: metadata

El extremo de metadatos en metadata_url muestra la información que se usa para compilar una IU de anuncios. El extremo de metadatos no está disponible para las transmisiones de píxeles contadores del servidor, en las que el servidor es responsable de iniciar la verificación de material multimedia del anuncio.

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

GET /{metadata_url}

Recupera información de metadatos de anuncios.

Solicitud HTTP

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

GET https://{metadata_url}

Cuerpo de la respuesta

Si se ejecuta de forma correcta, la respuesta muestra una instancia de PodMetadata.

Cómo analizar metadatos

Los metadatos tienen tres secciones discretas: tags, ads y breaks del anuncio. El punto de entrada a los datos es la sección tags. A partir de ahí, itera por las etiquetas y encuentra la primera entrada cuyo nombre sea un prefijo para el ID de contenido multimedia del anuncio que se encuentra en la transmisión de video. Por ejemplo, es posible que tengas un ID de contenido multimedia de 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 tu material de anuncio. Una vez que encuentres el objeto de prefijo de contenido multimedia 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.

Datos de respuesta

Transmisión

Se usa para renderizar una lista de recursos para una transmisión recién creada 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

El identificador de flujo de GAM.
media_verification_url string

La URL de verificación de contenido multimedia que se usa como extremo base para hacer un seguimiento de los eventos de reproducción.
metadata_url string

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

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 flujo.
heartbeat_url string

La URL de verificación de estado, que se usa para mantener activa la transmisión de píxeles contadores del servidor, debe recibir un ping cada {PollingFrequency} segundos. Se propagan para las transmisiones de píxeles contadores del servidor.
polling_frequency number

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

La plantilla de URL del manifiesto de grupo de anuncios se usa para generar la URL que recupera el manifiesto de grupo de anuncios de una transmisión, que corresponde a la URL de la playlist multivariante en HLS o el 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 de manifiesto es el formato del manifiesto recuperado de pod_manifest_url, ya sea dash o hls.

PodMetadata

PodMetadata contiene información de metadatos sobre los anuncios, las pausas publicitarias y las etiquetas de ID de contenido multimedia.
Representación JSON
{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
}
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 pausas publicitarias indexadas por ID de pausa publicitaria.

TagSegment

TagSegment contiene una referencia a un anuncio, su pausa publicitaria y el tipo de evento. No se debe enviar un ping a 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

El ID del anuncio de esta etiqueta.
ad_break_id string

Es el 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 (medio, previo o posterior) y la cantidad de anuncios.
Representación JSON
{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}
Campos
type string

Los tipos de pausa válidos son: pre, medio y post.
duration number

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

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

Cantidad de anuncios en la pausa publicitaria.
Ad describe un anuncio en el flujo.
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

Es el ID de la pausa publicitaria de este anuncio.
position number

Es la posición de este anuncio en la pausa publicitaria, que comienza en 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 de 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 creatividad opcional.
deal_id string

ID de oferta opcional.
clickthrough_url string

URL de clic opcional.
click_tracking_urls string

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

Son entradas de verificación de medición abierta 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 las creatividades.
slate boolean

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

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

Es una lista de wrappers, que 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 el VAST.
companions [object(Companion)]

Son los anuncios complementarios opcionales que pueden mostrarse 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 muestra 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 para el período que se completará con los datos adecuados antes de unirlos.
segment_duration_ms int64

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

AdpodTimingMetadataResponse

AdpodTimingMetadataResponse contiene información sobre el grupo de anuncios y cómo crear 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 de anuncio que describen cómo renderizar las URLs del segmento de anuncios, indexadas a partir de 0.
slate object(SlateRendering)

Lámina que describe cómo renderizar las URLs de los segmentos de la pizarra.
dash_representations map[string, object(DASHRepresentation)]

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

Es la lista de conjuntos de adaptación de DASH para que ese grupo de anuncios se renderice en los manifiestos de DASH.

AdRendering

En AdRendering, se describe cómo renderizar un anuncio con decisión tomada.
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)]

Diccionario de objetos de variante (consulta a continuación), indexados por el ID de la variante o el perfil, según se configuró desde 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, indexados por ID de variante o perfil. Las duraciones de la cortinilla deben repetirse hasta alcanzar la longitud requerida, insertar discontinuidades de HLS entre iteraciones o repetir períodos nuevos 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

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

SegmentDurations. Cada duración de segmento se puede traducir a 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

La escala de tiempo es la cantidad de unidades por segundo (int). Se espera que sea: 1,000 para HLS (milisegundos) 90,000 para video DASH (PTS) La tasa 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 representación 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

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 de 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 adaptaciones.
mime_type string

Es el tipo MIME del conjunto de adaptación.
role object(SchemeIDURIAndValue)

Rol del conjunto de adaptación.
inband_event_stream object(SchemeIDURIAndValue)

Transmisión de eventos en banda del conjunto de adaptación.
min_frame_rate string

Velocidad de fotogramas mínima del conjunto de adaptación.
max_frame_rate string

Es la 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

URI de ID de esquema del valor.
value string

Es el valor del URI del ID del esquema.

Ícono

El ícono contiene información sobre un ícono 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 en un ícono.
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 de oferta si no existe.
Representación JSON
{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}
Campos
system string

Es el identificador del sistema de anuncios.
ad_id string

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

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

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

ID de acuerdo opcional para el anuncio de 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 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

Es una 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 a 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 ciertas 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 le enviará un 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 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 del anuncio universal de la creatividad seleccionada.

Companion

El elemento complementario contiene información para 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 elemento complementario.
creative_type string

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

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

Es el ancho en píxeles de este anuncio complementario.
resource string

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

Es el tipo de este elemento complementario. Puede ser estático, iframe o HTML.
ad_slot_id string

El ID del espacio para este elemento complementario.
api_framework string

El framework de la API para este dispositivo complementario.
tracking_events [object(TrackingEvent)]

Lista de eventos de seguimiento de este dispositivo complementario.

InteractiveFile

InteractiveFile contiene información para la creatividad interactiva (es decir, el 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

Es la URL de la creatividad interactiva.
type string

Es 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

Es el valor del nodo <AdParameters> en el archivo VAST.