La API de inserción de anuncios dinámicos te permite solicitar DAI y hacerle un seguimiento lineales (EN VIVO).
Servicio: dai.google.com
Todos los URI que aparecen a continuación están relacionados con https://dai.google.com
Método: stream
| Métodos | |
|---|---|
stream |
POST /linear/v1/hls/event/{assetKey}/stream
Crea una transmisión de DAI para el ID del evento determinado. |
Solicitud HTTP
POST https://dai.google.com/linear/v1/hls/event/{assetKey}/stream
Encabezado de la solicitud
| Parámetros | |
|---|---|
api‑key |
stringLa clave de API, que se proporciona cuando se crea una transmisión, debe ser válido para la red del publicador. En lugar de proporcionarla en el cuerpo de la solicitud, se puede pasar la clave de API en el encabezado de autorización HTTP con el siguiente formato: Authorization: DCLKDAI key="<api-key>" |
Parámetros de ruta
| Parámetros | |
|---|---|
assetKey |
stringEl ID del evento de la transmisión. |
Cuerpo de la solicitud
El cuerpo de la solicitud es de tipo application/x-www-form-urlencoded y contiene la siguiente información:
los siguientes parámetros:
| Parámetros | ||
|---|---|---|
dai-ssb |
Opcional | Configúralo en |
| Parámetros de segmentación de DFP | Opcional | Parámetros de segmentación adicionales. |
| Anular parámetros de transmisión | Opcional | Anula los valores predeterminados de un parámetro de creación de transmisión. |
| Autenticación HMAC | Opcional | Autentica con un token basado en HMAC. |
Cuerpo de la respuesta
Si el proceso es satisfactorio, el cuerpo de la respuesta contiene un nuevo
Stream Para las transmisiones de píxeles contadores del servidor, esta Stream
Contiene solo los campos stream_id y stream_manifest.
Open Measurement
La API de DAI contiene información para la verificación de Open Measurement en el
Verifications. Este campo contiene uno o más
Elementos Verification que enumeran los recursos y metadatos necesarios para la ejecución
código de medición de terceros para verificar la reproducción de creatividades. Solo
JavaScriptResource es compatible. Para obtener más información, consulta la
IAB Tech Lab y el
Especificaciones de VAST 4.1.
Método: verificación de contenido multimedia
Después de encontrar un identificador de contenido multimedia de anuncios durante la reproducción, crea una solicitud con la media_verification_url que se obtuvo de la transmisión extremo, como se muestra más arriba. Estas solicitudes no son necesarias para el contador de píxeles del servidor de transmisión, donde 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:
- Es
HTTP/1.1 204 No Contentsi la verificación de medios se realiza correctamente y se envían todos los pings. - Se utiliza
HTTP/1.1 404 Not Foundsi la solicitud no puede verificar el contenido multimedia debido a un vencimiento o formato de URL incorrectos. HTTP/1.1 404 Not Foundsi se realiza correctamente una solicitud de verificación anterior para este ID.- Es
HTTP/1.1 409 Conflictsi otra solicitud ya está enviando pings en este momento.
IDs de medios de anuncios (HLS)
Los identificadores multimedia de anuncios se codificarán en metadatos temporizados de HLS usando la clave
TXXX, reservado para "información de texto definida por el usuario" o los fotogramas. El
el contenido del marco no se encriptará y siempre comenzará con el texto
"google_"
Todo el contenido de texto del marco se debe agregar a la verificación de anuncios URL antes de realizar cada solicitud de verificación de anuncio.
Método: metadata
El extremo de metadatos en metadata_url muestra información usada para crear un anuncio
de la IU de Google. El extremo de metadatos no está disponible para transmisiones
de balizas del servidor
en el que el servidor es responsable de iniciar la verificación de medios del anuncio.
| Métodos | |
|---|---|
metadata |
GET /{metadata_url}/{ad-media-id}GET /{metadata_url}
Recupera información de los metadatos de los anuncios. |
Solicitud HTTP
GET https://{metadata_url}/{ad-media-id}
GET https://{metadata_url}
Cuerpo de la respuesta
Si no hay errores, la respuesta muestra una instancia de
PodMetadata
Trabaja con metadatos
Los metadatos tienen tres secciones discretas: tags, ads y el anuncio breaks. Entrada
los datos es la sección tags. A partir de ahí, itera las etiquetas.
y busca 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 Internet. Por ejemplo,
podría tener un ID de medios de anuncios similar a este:
google_1234567890
Luego, encuentras un objeto de etiqueta llamado google_12345. En este caso, coincide con tu
ID de medios de anuncios Una vez que encuentres el objeto del prefijo de medios de anuncios correcto, podrás buscar
los IDs de anuncios, los 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
Transmitir
La transmisión se usa para renderizar una lista de recursos para una transmisión recién creada en JSON.| Representación JSON |
|---|
{
"stream_id": string,
"stream_manifest": string,
"hls_master_playlist": string,
"media_verification_url": string,
"metadata_url": string,
"session_update_url": string,
"polling_frequency": number,
} |
| Campos | |
|---|---|
stream_id |
stringEl identificador de transmisión de GAM. |
stream_manifest |
stringLa URL del manifiesto de la transmisión, que se usa para recuperar la playlist de múltiples variantes en HLS o MPD en DASH |
hls_master_playlist |
string(OBSOLETO) URL de playlist de múltiples variantes de HLS. Cómo usar "stream_manifest" en su lugar. |
media_verification_url |
stringEs 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 |
stringURL de metadatos que se usa para consultar información periódica sobre los próximos eventos de anuncios de transmisión. |
session_update_url |
stringEs la URL de actualización de la sesión que se utiliza 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 transmisión. |
polling_frequency |
numberLa frecuencia de sondeo, en segundos, cuando se solicita metadata_url o Heartbeat_url. |
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)],
} |
| 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. TagSegment con type="progress" No se debe hacer ping al contenido multimedia del anuncio. extremo de verificación.| Representación JSON |
|---|
{ "ad": string, "ad_break_id": string, "type": string, } |
| Campos | |
|---|---|
ad |
stringEl ID del anuncio de esta etiqueta. |
ad_break_id |
stringEl ID de la pausa publicitaria de esta etiqueta |
type |
stringEs el tipo de evento de esta etiqueta. |
AdBreak
La pausa publicitaria describe una sola pausa publicitaria en la transmisión. Contiene una duración, un tipo (medio/previo/posterior) y la cantidad de anuncios.| Representación JSON |
|---|
{ "type": string, "duration": number, "expected_duration": number, "ads": number, } |
| Campos | |
|---|---|
type |
stringLos tipos de pausa válidos son los siguientes: antes, durante y después. |
duration |
numberEs la duración total del anuncio para esta pausa publicitaria, en segundos. |
expected_duration |
numberDuración esperada de la pausa publicitaria (en segundos), incluidos todos los anuncios y cualquier cortinilla de video. |
ads |
numberEs la cantidad de anuncios en la pausa publicitaria. |
Anuncio
Un 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 |
stringEl ID de la pausa publicitaria de este anuncio. |
position |
numberLa posición de este anuncio en la pausa publicitaria, a partir de 1 |
duration |
numberDuración del anuncio, en segundos. |
title |
stringTítulo opcional del anuncio. |
description |
stringDescripción opcional del anuncio. |
advertiser |
stringIdentificador de anunciante opcional. |
ad_system |
stringSistema de anuncios opcional. |
ad_id |
stringID del anuncio opcional. |
creative_id |
stringID de la creatividad opcional. |
creative_ad_id |
stringID del anuncio con creatividad opcional. |
deal_id |
stringID del acuerdo opcional. |
clickthrough_url |
stringURL de clic opcional. |
click_tracking_urls |
stringURL de seguimiento de clics opcionales. |
verifications |
[object(Verification)]Entradas opcionales de verificación de Open Measurement que enumeran los recursos y los metadatos necesarios para ejecutar el código de medición de terceros para verificar la reproducción de creatividades. |
slate |
booleanBool opcional que indica que la entrada actual es de cortinilla de video. |
icons |
[object(Icon)]Una lista de íconos, que se omite si está vacía. |
wrappers |
[object(Wrapper)]Una lista de wrappers, que se omite si está vacía. |
universal_ad_id |
object(UniversalAdID)ID del anuncio universal opcional. |
extensions |
stringLista opcional de todas las extensiones de <Extension> nodos en VAST. |
companions |
[object(Companion)]Complementos 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 |
Í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 de 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 Es el 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 |
stringEs el identificador del sistema del anuncio. |
ad_id |
stringEs el ID que se usa para el anuncio envolvente. |
creative_id |
stringEs el ID de la creatividad que se usa para el anuncio envolvente. |
creative_ad_id |
stringEs el ID de anuncio de la creatividad que se usa para el anuncio envolvente. |
deal_id |
stringEs el ID del acuerdo opcional para el anuncio wrapper. |
Verificación
La verificación contiene información de Open Measurement, lo 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 |
stringEl 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 |
stringUna cadena opaca que se pasa al código de verificación de arranque. |
JavaScriptResource
JavaScriptResource contiene información para la verificación mediante JavaScript.| Representación JSON |
|---|
{
"script_url": string,
"api_framework": string,
"browser_optional": boolean,
} |
| Campos | |
|---|---|
script_url |
stringURI a carga útil de JavaScript. |
api_framework |
stringAPIFramework es el nombre del framework de video que ejecuta el código de verificación. |
browser_optional |
booleanSi esta secuencia de comandos puede ejecutarse navegador. |
TrackingEvent
TrackingEvent contiene URLs a las que el cliente debe hacer ping en ciertos situaciones.| Representación JSON |
|---|
{
"event": string,
"uri": string,
} |
| Campos | |
|---|---|
event |
stringEl tipo del evento de seguimiento. |
uri |
stringEl evento de seguimiento al que se debe hacer ping |
UniversalAdID
UniversalAdID se usa para proporcionar un identificador de creatividad único en los sistemas de anuncios.| Representación JSON |
|---|
{ "id_value": string, "id_registry": string, } |
| Campos | |
|---|---|
id_value |
stringEs el ID del anuncio universal de la creatividad seleccionada para el anuncio. |
id_registry |
stringUna cadena que se usa para identificar la URL del sitio web de registro en la que se cataloga el ID de anuncio universal de la creatividad seleccionada. |
Companion
El anuncio complementario contiene información de 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)Datos de clics de este anuncio complementario. |
creative_type |
stringEl atributo CreativeType de la carpeta <StaticResource> en el anuncio de VAST Este es un anuncio complementario de tipo estático. |
height |
int32Es la altura en píxeles de este anuncio complementario. |
width |
int32Es el ancho en píxeles de este anuncio complementario. |
resource |
stringPara los anuncios complementarios iframe y estáticos, esta será la URL que se cargará y que se muestra. Para los anuncios complementarios HTML, este será el fragmento HTML que se debe se mostrará como complementario. |
type |
stringTipo de este anuncio complementario. Puede ser estático, iframe o HTML. |
ad_slot_id |
stringEs el ID del espacio de este anuncio complementario. |
api_framework |
stringEl framework de API para este complemento. |
tracking_events |
[object(TrackingEvent)]Es la lista de eventos de seguimiento de este complemento. |
InteractiveFile
InteractiveFile contiene información para creatividades interactivas (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 |
stringLa URL de la creatividad interactiva. |
type |
stringEs el tipo de MIME del archivo proporcionado como recurso. |
variable_duration |
booleanDetermina si esta creatividad puede solicitar una extensión de la duración. |
ad_parameters |
stringEl valor de <AdParameters> en VAST. |