API de VOD 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 a pedido de DAI.

Servicio: dai.google.com

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

Método: create stream

Este método crea una transmisión directamente desde el dispositivo y devuelve todos los recursos necesarios para que la aplicación cliente reproduzca y haga un seguimiento de los anuncios, y muestre los elementos de la IU.

Métodos
create stream POST: /ondemand/pods/api/v1/network/{network_code}/stream

Crea una sesión de VOD de publicación de grupos de anuncios de DAI.

Solicitud HTTP

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

Parámetros de ruta

Parámetros
network_code string

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

Cuerpo de la solicitud

El cuerpo de la solicitud es de tipo application/json y debe contener un objeto CreateStreamRequest.

Cuerpo de la respuesta

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

Método: register stream

Este método registra una transmisión en el backend de la DAI de Google desde el dispositivo y devuelve todos los recursos que necesita la aplicación cliente para hacer un seguimiento de los anuncios y mostrar elementos de la IU. A diferencia del método create stream, este método no devuelve un manifiesto de anuncios aptos para reproducción. En cambio, esta acción se logra en una llamada al servidor independiente: decision ad pods.

Métodos
register stream POST: /ondemand/pods/api/v1/network/{network_code}/stream_registration

Registra una sesión de VOD de publicación de grupos de anuncios de DAI.

Solicitud HTTP

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/stream_registration

Parámetros de ruta

Parámetros
network_code string

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

Cuerpo de la solicitud

El cuerpo de la solicitud es de tipo application/json y debe contener un objeto StreamRegistrationRequest.

Cuerpo de la respuesta

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

Método: Recupera grupos de anuncios

Este método sigue una llamada a register stream desde un dispositivo y es necesario para recuperar manifiestos de anuncios aptos para reproducción y unirlos en manifiestos de contenido.

Métodos
decision ad pods POST: /ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods

Son grupos de anuncios de decisión para una sesión de VOD de DAI Pod Serving.

Solicitud HTTP

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods

Parámetros de ruta

Parámetros
network_code string

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

stream_id string

Es el stream_id que se recibió de una llamada a stream_registration.

Cuerpo de la solicitud

El cuerpo de la solicitud es de tipo application/json y debe contener un objeto AdPodDecisionRequest.

Cuerpo de la respuesta

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

Método: Metadatos de los pods de anuncios

Este método devuelve toda la información que necesita la app cliente para hacer un seguimiento de los anuncios y renderizar con precisión los elementos de la IU adecuados.

Métodos
ad pods metadata GET: /ondemand/pods/api/v1/network/.../metadata

Recupera los metadatos de los grupos de anuncios para una sesión específica. Esta URL se devuelve en el atributo metadata_url de StreamRegistrationResponse.

Solicitud HTTP

GET: /ondemand/pods/api/v1/network/.../metadata

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta contiene un objeto Ad pods metadata.

Objetos de la API

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)],
  "polling_frequency": number,
}
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.
polling_frequency number

Frecuencia de sondeo de URL de metadatos recomendada, en segundos. Se propaga para las transmisiones de VOD que usan la toma de decisiones On-Demand.

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 (intermedio, 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 interrupción válidos son: pre, mid y post.
duration number

Duración total de los anuncios de 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 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 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 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 la creatividad.
slate boolean

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

Lista de íconos, 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.

MatchOpts

Los MatchOpts especifican requisitos estrictos de coincidencia de medios para una transmisión.
Representación JSON
{
  "audio_channels": boolean,
  "audio_sample_rate": boolean,
}
Campos
audio_channels boolean

Haz coincidir los canales de audio entre el contenido y los anuncios.
audio_sample_rate boolean

Haz coincidir la tasa de muestreo de audio entre el contenido y los anuncios.

CreateStreamRequest

CreateStreamRequest describe la información que se encuentra en las solicitudes HTTP a la API de entrega del pod de VOD. El VTP (socio tecnológico de video) inicia la creación de la transmisión en nombre del SDK y del publicador para cada usuario. La transmisión creada genera grupos de anuncios determinados para que el VTP los una. Esto contrasta con el flujo StreamRegistrationRequest+AdPodDecisionRequest, que registra una transmisión y decide los adpods en varias solicitudes.
Representación JSON
{
  "encoding_profiles": [object(EncodingProfile)],
  "ad_tag": string,
  "cuepoints": [],
  "manifest_type": string,
  "enable_hls_asset_list": boolean,
  "targeting_parameters": map[string, string],
  "content_duration_seconds": number,
  "decision_timing_options": object(DecisionTimingOptions),
  "enable_inline_manifests": boolean,
  "dai_options": object(CreateStreamOptions),
}
Campos
encoding_profiles [object(EncodingProfile)]

Es una lista de perfiles de codificación. Obligatorio.
ad_tag string

Es la etiqueta de anuncio base para la toma de decisiones. Obligatorio.
cuepoints number

Una lista de marcas, en segundos. Se requiere cuando la respuesta de la etiqueta del anuncio usa compensaciones de tiempo posicionales.
manifest_type string

Los tipos de manifiesto válidos son hls y dash. Valor predeterminado: hls. Opcional.
enable_hls_asset_list boolean

Indica si están habilitados los anuncios intersticiales de la lista de recursos de HLS. Cuando se habilita, la DAI devuelve URLs de listas de recursos para cada corte publicitario, que se pueden usar para los intersticiales de HLS.
targeting_parameters string

Parámetros de segmentación adicionales de Ad Manager. Opcional.
content_duration_seconds number

ContentDurationSeconds es la duración del contenido en segundos. Obligatorio cuando la respuesta de la etiqueta del anuncio usa desplazamientos temporales en porcentaje.
decision_timing_options object(DecisionTimingOptions)

Indica cuándo se deben tomar decisiones sobre los adpods.
enable_inline_manifests boolean

Indica si los manifiestos de interrupciones deben insertarse en la respuesta JSON.
dai_options object(CreateStreamOptions)

DAIOptions para la creación de transmisiones.

CreateStreamOptions

CreateStreamOptions representa las opciones disponibles en el flujo de trabajo de creación de transmisión de un solo paso.
Representación JSON
{
  "dash_profile": string,
  "match_options": object(MatchOpts),
  "data_sharing_policy_code": string,
  "sam_id": string,
  "session_title": string,
  "dash_inband_event_stream": boolean,
  "distinct_ad_profiles": boolean,
  "tracking_mode": string,
  "emsg_version": uint32,
}
Campos
dash_profile string

Perfil de MPEG-DASH que se usará: "live" o "on-demand".
match_options object(MatchOpts)

data_sharing_policy_code string

Permite que los editores anulen la política predeterminada de uso compartido de datos de la red.
sam_id string

sam_id es la clave de depuración de SAM para la sesión (opcional).
session_title string

session_title es el título de la sesión de SAM para la transmisión, opcional.
dash_inband_event_stream boolean

dash_inband_event_stream indica que la DAI inserta mensajes ID3 como eventos dentro de la banda (en los medios) con el elemento InbandEventStream, en lugar de como elementos EventStream (en el manifiesto).
distinct_ad_profiles boolean

Si se establece como verdadero, indica que el servidor usará cualquier perfil de anuncio disponible como máximo una vez cuando coincidan los perfiles de codificación solicitados.
tracking_mode string

tracking_mode es el tipo de seguimiento de anuncios que se usará para la transmisión. Es opcional. Los valores válidos son "ad_media", "server" y "client".
emsg_version uint32

emsg_version fuerza el uso de una versión específica de emsg para los ID3 dentro del contenido multimedia. Solo se admite cuando dash_inband_event_stream es verdadero.

StreamRegistrationRequest

StreamRegistrationRequest registra una transmisión desde el dispositivo para la toma de decisiones futuras sobre los adpods. Esto contrasta con un CreateStreamRequest, que crea una transmisión y adpods de decisiones en una sola solicitud.
Representación JSON
{
  "targeting_parameters": map[string, string],
  "dai_options": object(StreamRegistrationOptions),
}
Campos
targeting_parameters string

Parámetros de segmentación adicionales de Ad Manager. Opcional.
dai_options object(StreamRegistrationOptions)

DAIOptions para el registro de transmisiones.

StreamRegistrationOptions

StreamRegistrationOptions enumera las opciones disponibles para la creación de transmisiones.
Representación JSON
{
  "sam_id": string,
  "tracking_mode": string,
  "emsg_version": uint32,
  "skippable_ads_supported": boolean,
}
Campos
sam_id string

sam_id es la clave de depuración de SAM para la sesión (opcional).
tracking_mode string

tracking_mode es el tipo de seguimiento de anuncios que se usará para la transmisión. Es opcional. Los valores válidos son "ad_media", "server" y "client".
emsg_version uint32

emsg_version fuerza el uso de una versión específica de emsg para los ID3 dentro del contenido multimedia. Solo se admite cuando dash_inband_event_stream es verdadero.
skippable_ads_supported boolean

Indica si se admiten los anuncios que se pueden omitir.

StreamRegistrationResponse

StreamRegistrationResponse representa la respuesta json que se envía al cliente en respuesta a un StreamRegistrationRequest. Incluye el ID de transmisión y todas las URLs que necesitará el dispositivo. Se puede hacer referencia al ID de transmisión en una solicitud de decisión de adpod posterior. Esto contrasta con un CreateStreamResponse, que representa una respuesta para crear una transmisión y tomar decisiones sobre los bloques de anuncios al mismo tiempo.
Representación JSON
{
  "stream_id": string,
  "media_verification_url": string,
  "valid_for": string,
  "valid_until": string,
  "metadata_url": string,
}
Campos
stream_id string

StreamID es el identificador único de la transmisión actual de este usuario.
media_verification_url string

MediaVerificationURL es el prefijo de URL que se usará en las solicitudes de verificación de medios de anuncios que se describen a continuación. No está presente en las transmisiones con píxeles contadores del cliente.
valid_for string

ValidFor es la duración durante la cual este flujo es válido, en formato "00h00m00s".
valid_until string

ValidUntil es la fecha y hora hasta las que esta transmisión es válida.
metadata_url string

MetadataURL es la URL de metadatos que se usará para solicitar metadatos de adpod.

DecisionTimingOptions

DecisionTimingOptions describe las opciones de sincronización para las pausas publicitarias de toma de decisiones del flujo.
Representación JSON
{
  "type": string,
  "on_create_breaks": [],
}
Campos
type string

El tipo describe cuándo se toman decisiones sobre los adpods para la transmisión. Los tipos válidos son on_create (predeterminado) y on_demand. Cuando el tipo es on_demand, los anuncios se deciden de forma diferida cuando se solicita el manifiesto para una pausa en particular. Cuando el tipo es on_create, todos los anuncios se deciden cuando se crea la transmisión.
on_create_breaks string

OnCreateBreaks es una lista de breakIDs de VMAP que distinguen mayúsculas de minúsculas y que se deben utilizar para tomar decisiones sobre la creación de transmisiones. Este campo solo se permite si el tipo es on_demand. Los identificadores especiales de pausas publicitarias "preroll" y "postroll" se pueden usar para indicar que la pausa previa al video o posterior al video se debe decidir en el momento de la creación de la transmisión.

EncodingProfile

EncodingProfile describe la codificación de una sola variante de contenido. Puede contener solo parámetros de configuración de video, solo parámetros de configuración de audio (en el caso del tipo de medio), parámetros de configuración de video y audio, o ninguno en el caso de los subtítulos.
Representación JSON
{
  "profile_name": string,
  "type": string,
  "container_type": string,
  "video_settings": object(VideoSettings),
  "audio_settings": object(AudioSettings),
  "subtitle_settings": object(SubtitleSettings),
}
Campos
profile_name string

Nombre que proporcionó el editor para el perfil. Es único por transmisión. Obligatorio.
type string

Los tipos válidos son: media, iframe y subtitles. Obligatorio.
container_type string

Los tipos válidos son: mpeg2ts, fmp4cmaf y hls_packed_audio. Se requiere para los tipos de medios y los iframes.
video_settings object(VideoSettings)

Se requiere la configuración de video si el tipo de contenedor es iframe. De lo contrario, solo están presentes si el perfil contiene videos.
audio_settings object(AudioSettings)

La configuración de audio está presente si el perfil contiene audio. Los parámetros de configuración de audio solo se permiten si el tipo de contenedor es multimedia.
subtitle_settings object(SubtitleSettings)

Se requiere la configuración de subtítulos para el tipo de subtítulos.

VideoSettings

VideoSettings describe el video de un perfil de codificación. Si se incluye un parámetro de configuración de video, se deben incluir todos.
Representación JSON
{
  "codec": string,
  "bitrate": int32,
  "frames_per_second": number,
  "resolution": object(Resolution),
}
Campos
codec string

Es la cadena de códec RFC6381 del video.
bitrate int32

Es la tasa de bits máxima del video del perfil de codificación.
frames_per_second number

Fotogramas por segundo del video.
resolution object(Resolution)

Resolución de ancho por alto del video.

AudioSettings

AudioSettings describe el audio de un perfil de codificación. Si hay un parámetro de configuración de audio, deben estar todos.
Representación JSON
{
  "codec": string,
  "bitrate": int32,
  "channels": int32,
  "sample_rate": int64,
}
Campos
codec string

Es la cadena de códec RFC6381 del audio.
bitrate int32

Es la tasa de bits de audio máxima del perfil de codificación.
channels int32

Es la cantidad de canales de audio (incluidos los canales de baja frecuencia).
sample_rate int64

La tasa de muestreo del audio, en hercios.

SubtitleSettings

SubtitleSettings describe los subtítulos de un perfil de codificación.
Representación JSON
{
  "format": string,
  "language": string,
}
Campos
format string

El formato de los subtítulos: webvtt para hls, webvtt o ttml para dash.
language string

Idioma que se insertará en el manifiesto.

Solución

La resolución describe el ancho por la altura de un video.
Representación JSON
{
  "width": int32,
  "height": int32,
}
Campos
width int32

Ancho del video en píxeles. Obligatorio.
height int32

Altura del video, en píxeles. Obligatorio.

AdPodDecisionRequest

AdPodDecisionRequest representa una solicitud para tomar decisiones sobre los grupos de anuncios para una transmisión registrada previamente.
Representación JSON
{
  "encoding_profiles": [object(EncodingProfile)],
  "ad_tag": string,
  "cuepoints": [],
  "manifest_type": string,
  "enable_hls_asset_list": boolean,
  "targeting_parameters": map[string, string],
  "content_duration_seconds": number,
  "decision_timing_options": object(DecisionTimingOptions),
  "enable_inline_manifests": boolean,
  "dai_options": object(AdPodDecisionOptions),
}
Campos
encoding_profiles [object(EncodingProfile)]

Es una lista de perfiles de codificación. Obligatorio.
ad_tag string

Es la etiqueta de anuncio base para la toma de decisiones. Obligatorio.
cuepoints number

Una lista de marcas, en segundos. Se requiere cuando la respuesta de la etiqueta del anuncio usa compensaciones de tiempo posicionales.
manifest_type string

Los tipos de manifiesto válidos son hls y dash. Valor predeterminado: hls. Opcional.
enable_hls_asset_list boolean

Indica si están habilitados los anuncios intersticiales de la lista de recursos de HLS. Cuando se habilita, la DAI devuelve URLs de listas de recursos para cada corte publicitario, que se pueden usar para los intersticiales de HLS.
targeting_parameters string

Parámetros de segmentación adicionales de Ad Manager. Opcional.
content_duration_seconds number

ContentDurationSeconds es la duración del contenido en segundos. Obligatorio cuando la respuesta de la etiqueta del anuncio usa desplazamientos temporales en porcentaje.
decision_timing_options object(DecisionTimingOptions)

Indica cuándo se deben tomar decisiones sobre los adpods.
enable_inline_manifests boolean

Indica si los manifiestos de interrupciones deben insertarse en la respuesta JSON.
dai_options object(AdPodDecisionOptions)

DAIOptions para la decisión del grupo de anuncios.

AdPodDecisionResponse

AdPodDecisionResponse representa una respuesta a los grupos de anuncios de decisión para una transmisión registrada previamente. Contiene una lista de los grupos de anuncios para los que se tomó una decisión en esa transmisión.
Representación JSON
{
  "valid_for": string,
  "valid_until": string,
  "ad_pods": [object(AdPod)],
}
Campos
valid_for string

ValidFor es la duración durante la cual este flujo es válido, en formato "00h00m00s".
valid_until string

ValidUntil es la fecha y hora hasta las que esta transmisión es válida.
ad_pods [object(AdPod)]

Lista de grupos de anuncios ordenados por orden de inserción.

CreateStreamResponse

CreateStreamResponse representa la respuesta JSON que se envía al cliente en respuesta a una CreateStreamRequest.
Representación JSON
{
  "valid_for": string,
  "valid_until": string,
  "ad_pods": [object(AdPod)],
  "stream_id": string,
  "media_verification_url": string,
  "pod_metadata": object(PodMetadata),
  "metadata_url": string,
}
Campos
valid_for string

ValidFor es la duración durante la cual este flujo es válido, en formato "00h00m00s".
valid_until string

ValidUntil es la fecha y hora hasta las que esta transmisión es válida.
ad_pods [object(AdPod)]

Lista de grupos de anuncios ordenados por orden de inserción.
stream_id string

StreamID es el identificador único de la transmisión actual de este usuario.
media_verification_url string

MediaVerificationURL es el prefijo de URL que se usará en las solicitudes de verificación de medios de anuncios que se describen a continuación. No está presente en las transmisiones con píxeles contadores del cliente.
pod_metadata object(PodMetadata)

PodMetadata contiene la información adicional necesaria para renderizar el pod en el dispositivo y activar la verificación. Como se describe en la documentación de la API lineal de Inserción de anuncios dinámicos. Solo se incluye para las transmisiones con balizas del cliente.
metadata_url string

MetadataURL es la URL de metadatos que se usará para solicitar metadatos de adpod.

AdPod

AdPod representa una pausa publicitaria determinada y lista para reproducirse.
Representación JSON
{
  "manifest_uris": map[string, string],
  "multivariant_uri": string,
  "mpd_uri": string,
  "manifests": map[string, string],
  "multivariant_manifest": string,
  "mpd_manifest": string,
  "asset_list_uri": string,
  "start": number,
  "duration": number,
  "type": string,
  "midroll_index": number,
}
Campos
manifest_uris string

ManifestURIs es un mapa del nombre del perfil de codificación a los manifest_uris de la variante de HLS para el contenido de HLS.
multivariant_uri string

MultivariantURI es el URI del manifiesto de múltiples variantes para el contenido de HLS.
mpd_uri string

MPDURI es el URI del MPD para el contenido de DASH.
manifests string

Manifests es un mapa del nombre del perfil de codificación al manifiesto de la variante de HLS. Se propaga solo si el parámetro enable_inline_manifests de la transmisión se establece como verdadero.
multivariant_manifest string

MultivariantManifest es el manifiesto de múltiples variantes para el contenido de HLS. Se propaga solo si el parámetro enable_inline_manifests de la transmisión se establece como verdadero.
mpd_manifest string

MPDManifest es el manifiesto de MPD para el contenido de DASH. Se propaga solo si el parámetro enable_inline_manifests de la transmisión se establece como verdadero.
asset_list_uri string

AssetListURI es el URI de la lista de recursos de los anuncios intersticiales de HLS para el contenido de HLS. Se propaga solo si la transmisión tiene habilitados los intersticiales de la lista de activos de HLS.
start number

Hora de inicio del grupo de anuncios en la línea de tiempo del recurso (sin incluir los grupos de anuncios precedentes) en segundos de punto flotante.
duration number

Duración del grupo de anuncios en segundos de punto flotante.
type string

Tipo de pausa publicitaria.
midroll_index number

Índice basado en 1 de los anuncios durante el video en una transmisión, según el ID de pausa de VMAP. Se omite para los anuncios previos al video y los anuncios posteriores al video.

AdPodDecisionOptions

AdPodDecisionOptions representa opciones adicionales para la transmisión.
Representación JSON
{
  "dash_profile": string,
  "match_options": object(MatchOpts),
  "data_sharing_policy_code": string,
  "sam_id": string,
  "session_title": string,
  "dash_inband_event_stream": boolean,
  "distinct_ad_profiles": boolean,
}
Campos
dash_profile string

Perfil de MPEG-DASH que se usará: "live" o "on-demand".
match_options object(MatchOpts)

data_sharing_policy_code string

Permite que los editores anulen la política predeterminada de uso compartido de datos de la red.
sam_id string

sam_id es la clave de depuración de SAM para la sesión (opcional).
session_title string

session_title es el título de la sesión de SAM para la transmisión, opcional.
dash_inband_event_stream boolean

dash_inband_event_stream indica que la DAI inserta mensajes ID3 como eventos dentro de la banda (en los medios) con el elemento InbandEventStream, en lugar de como elementos EventStream (en el manifiesto).
distinct_ad_profiles boolean

Si se establece como verdadero, indica que el servidor usará cualquier perfil de anuncio disponible como máximo una vez cuando coincidan los perfiles de codificación solicitados.

Transmisión

Stream se usa para renderizar una lista de todos los recursos de una transmisión recién creada en formato JSON .
Representación JSON
{
  "stream_id": string,
  "valid_for": string,
  "valid_until": string,
  "media_verification_url": string,
}
Campos
stream_id string

Identificador de transmisión.
valid_for string

Duración para la que es válido el flujo, en formato "00h00m00s".
valid_until string

Fecha hasta la que el flujo es válido, en formato RFC 3339.
media_verification_url string

URL de verificación de medios.

Í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 el clic en un ícono que generó una redirección.
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

Identificador del sistema de anuncios.
ad_id string

Es el 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 de 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

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 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 universal del anuncio 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 esta creatividad complementaria.
creative_type string

El atributo CreativeType en el nodo <StaticResource> en VAST si se trata de un complemento 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, este será el fragmento de HTML que se debe mostrar como anuncio complementario.
type string

Es el tipo de este compañero. Puede ser estático, iframe o HTML.
ad_slot_id string

ID de la ranura de este compañero.
api_framework string

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

Lista de eventos de seguimiento para este complemento.

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

Es la URL de la creatividad interactiva.
type string

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