Esquema y propiedades del seguimiento de anuncios del lado del cliente

Con la función de seguimiento de anuncios MediaTailor del lado del cliente, puedes integrar datos detallados del seguimiento de anuncios del lado del cliente en tu entorno de jugador. En las siguientes secciones se describe el esquema general de seguimiento de anuncios, así como las propiedades y valores específicos que lo componen.

Esquema

La siguiente estructura de JSON muestra el esquema de seguimiento de anuncios del MediaTailor lado del cliente. Esta representación ilustra la estructura de anidación del esquema para ayudarte a entender las relaciones entre las distintas partes.

Para obtener información detallada sobre cada propiedad, consultePropiedades.


{
  "avails": [
    {
      "ads": [
        {
          "adID": "string",
          "adParameters": "string",
          "adSystem": "string",
          "adTitle": "string",
          "adVerifications": [
            {
              "executableResource": [
                {
                  "apiFramework": "string",
                  "type": "string",
                  "uri": "string",
                  "language": "string"
                }
              ],
              "javaScriptResource": [
                {
                  "apiFramework": "string",
                  "browserOptional": "string",
                  "uri": "string"
                }
              ],
              "trackingEvents": [
                {
                  "event": "string",
                  "uri": "string"
                }
              ],
              "vendor": "string",
              "verificationParameters": "string"
            }
          ],
          "companionAds": [
            {
              "adParameters": "string",
              "altText": "string",
              "attributes": {
                "adSlotId": "string",
                "apiFramework": "string",
                "assetHeight": "string",
                "assetWidth": "string",
                "expandedHeight": "string",
                "expandedWidth": "string",
                "height": "string",
                "id": "string",
                "pxratio": "string",
                "renderingMode": "string",
                "width": "string"
              },
              "companionClickThrough": "string",
              "companionClickTracking": "string",
              "htmlResource": "string",
              "iFrameResource": "string",
              "sequence": "string",
              "staticResource": "string",
              "trackingEvents": [
                {
                  "event": "string",
                  "uri": "string"
                }
              ]
            }
          ],
          "creativeId": "string",
          "creativeSequence": "string",
          "duration": "string",
          "durationInSeconds": number,
          "extensions": [
            {
              "type": "string",
              "content": "string"
            }
          ],
          "icons": [
            {
              "attributes": {
                "apiFramework": "string",
                "duration": "string",
                "height": "string",
                "offset": "string",
                "program": "string",
                "pxratio": "string",
                "width": "string",
                "xPosition": "string",
                "yPosition": "string"
              },
              "htmlResource": "string",
              "iconClicks": {
                "iconClickThrough": "string",
                "iconClickTracking": {
                  "id": "string"
                },
                "iconClickFallbackImages": [
                  {
                    "altText": "string",
                    "height": "string",
                    "width": "string",
                    "staticResource": {
                      "creativeType": "string",
                      "uri": "string"
                    }
                  }
                ]
              },
              "iconViewTracking": "string",
              "iFrameResource": "string",
              "staticResource": {
                "creativeType": "string",
                "uri": "string"
              }
            }
          ],
          "mediaFiles": {
            "adParameters": "string",
            "duration": "string",
            "durationInSeconds": number,
            "mediaFilesList": [
              {
                "apiFramework": "string",
                "delivery": "string",
                "height": "string",
                "maintainAspectRatio": "string",
                "mediaFileUri": "string",
                "mediaType": "string",
                "scalable": "string",
                "width": "string",
                "bitrate": "string"
              }
            ],
            "mezzanine": "string",
            "startTime": "string",
            "startTimeInSeconds": number,
            "trackingEvents": [
              {
                "beaconUrls": ["string"],
                "duration": "string",
                "durationInSeconds": number,
                "dateTime": "string",
                "eventId": "string",
                "eventType": "string",
                "startTime": "string",
                "startTimeInSeconds": number
              }
            ]
          },
          "startTime": "string",
          "startTimeInSeconds": number,
          "dateTime": "string",
          "adBreakTrackingEvents": [...],
          "vastAdId": "string"
        }
      ],
      "adType": "string",
      "availID": "string",
      "duration": "string",
      "durationInSeconds": number,
      "startTime": "string",
      "startTimeInSeconds": number,
      "dateTime": "string",
      "adMarkerDuration": "string",
      "adProgramDateTime": "string",
      "dashAvailabilityStartTime": "string",
      "hlsAnchorMediaSequenceNumber": "string"
    }
  ],
  "nonLinearAvails": [
    {
      "nonLinearAds": [...],
      "nonLinearAdsList": [...]
    }
  ],
  "nextToken": "string",
  "meta": {}
}

Propiedades

En la siguiente tabla se enumeran las propiedades de la API de seguimiento del lado del cliente, sus definiciones, tipos de valores y ejemplos.

Propiedad	Definición	Tipo de valor	Ejemplo
`adID`	HLS: el número de secuencia asociado al principio del anuncio DASH: el identificador de período del anuncio Ruta: `/avails/ads/adId` Mapeo VAST: ninguno	Cadena	`10`
`adBreakTrackingEvents`	Matriz que contiene los eventos de seguimiento de VMAP de la respuesta VAST. Para obtener más información, consulte la sección 2.3.3 de la especificación VMAP 1.0. Ruta: `/avails/ads/adBreakTrackingEvents`	Matriz	`[]`
`adMarkerDuration`	El tiempo de disponibilidad observado a partir del marcador publicitario del manifiesto.	Cadena	`30`
`adParameters`	Cadena de parámetros del anuncio, del VAST VPAID, que se MediaTailor transfiere al reproductor. Ruta: `/avails/ads/adParameters` Mapeo VAST: `VAST/Ad/InLine/Creatives/Creative/Linear/AdParameters`	Cadena
`adProgramDateTime`	HLS: fecha, en formato ISO/IEC 8601:2004, que representa la primera secuencia multimedia del anuncio. DASH: [Sin especificar]	Cadena
`ads`	Una matriz que contiene los objetos de anuncios que componen la oferta. Los anuncios se muestran en el orden en que aparecen en el manifiesto. Ruta: `/avails/ads`	Matriz	`[]`
`adSystem`	El nombre del sistema que publica el anuncio. importante Asegúrese de proporcionar un valor. Si no proporciona un valor, pueden surgir problemas.	Cadena	`myADS`
`adTitle`	El título del anuncio.	Cadena	`ad1`
`adVerifications`	Contiene los recursos y los metadatos necesarios para ejecutar el código de medición de terceros a fin de verificar la reproducción creativa. Para obtener más información sobre esta propiedad, consulte la sección 3.16 de la especificación VAST 4.2. MediaTailor admite `adVerifications` como nodos de extensión VAST 3. Ruta: `/avails/ads/adVerifications` Mapeo VAST: `VAST/Ad/InLine/AdVerifications`	Matriz	`[]`
`altText`	El texto alternativo de una imagen de un anuncio complementario. Este texto permite a los jugadores con soporte de audio descriptivo para personas con discapacidad visual leer una descripción de la imagen. Ruta: `/avails/ads/companionAds/altText`	Cadena	`video sequence advertising sneakers`
`apiFramework`	Se configura para indicar `VPAID` al jugador que este anuncio es un anuncio VPAID. Puede aparecer en varias ubicaciones del esquema.	Cadena	`VPAID`
`availID`	HLS: el número de secuencia asociado al inicio del anuncio está disponible. DASH: el identificador de período del anuncio disponible, que suele ser el identificador de período del contenido que se va a sustituir por un anuncio. Ruta: `/avails/availID`	Cadena	`34` `PT34S_1`
`avails`	Matriz que contiene objetos publicitarios, o paquetes, que aparecen en la ventana del manifiesto activa. Los artículos disponibles se muestran en el orden en que aparecen en el manifiesto. Ruta: `/avails`	Matriz	`[]`
`adType`	El tipo de anuncio. Ruta: `/avails/adType` y `/avails/ads/adType`	Cadena
`dateTime`	Programe la fecha y hora, en formato ISO 8601 segundos, para el inicio del anuncio o anuncio. Ruta: y `/avails/dateTime` `/avails/ads/dateTime`	Cadena
`duration`	Longitud, en formato ISO 8601 segundos. La respuesta incluye la duración de todo el anuncio disponible y de cada anuncio y baliza, aunque la duración de las balizas siempre es cero. Ruta: y `/avails/duration` `/avails/ads/duration`	Cadena	`15.015`
`durationInSeconds`	Longitud, en formato de segundos. Ruta: `/avails/durationInSeconds` y `/avails/ads/durationInSeconds`	Número
`extensions`	Extensiones personalizadas de VAST que utilizan los servidores de anuncios. Para obtener más información sobre las extensiones, consulta la sección 3.18 de la especificación VAST 4.2. Ruta: `/avails/ads/extensions` Mapeo VAST: `VAST/Ad/InLine/Extensions`	Matriz	`[]`
`icons`	Elementos de icono para el anuncio. Ruta: `/avails/ads/icons` Mapeo VAST: `VAST/Ad/InLine/Creatives/Creative/Linear/Icons`	Matriz
`mediaFiles`	El vídeo y otros recursos que el jugador necesita para el anuncio están disponibles. Ruta: `/avails/ads/mediaFiles`	Objeto
`nonLinearAvails`	Conjunto de objetos no lineales y disponibles. Ruta: `/nonLinearAvails`	Matriz
`executableResource`	Recursos ejecutables para la verificación. Ruta: `/avails/ads/adVerifications/executableResource` Mapeo VAST: `VAST/Ad/InLine/AdVerifications/Verification/ExecutableResource`	Matriz
`javaScriptResource`	JavaScript recursos para la verificación. Ruta: `/avails/ads/adVerifications/javaScriptResource` Mapeo VAST: `VAST/Ad/InLine/AdVerifications/Verification/JavaScriptResource`	Matriz
`trackingEvents`	Seguimiento de eventos para su verificación o anuncios complementarios. Ruta: `/avails/ads/adVerifications/trackingEvents` o `/avails/ads/companionAds/trackingEvents`	Matriz
`vendor`	Proveedor de verificación. Ruta: `/avails/ads/adVerifications/vendor` Mapeo VAST: `VAST/Ad/InLine/AdVerifications/Verification/@vendor`	Cadena
`uri`	URI que apunta a un activo ejecutable, a un activo de vídeo o a un punto final de seguimiento. Ruta: varias ubicaciones del esquema Mapeo VAST: varios elementos de CDATA en VAST	Cadena	`https://tracking.example.com/impression`
`verificationParameters`	Parámetros de verificación. Ruta: `/avails/ads/adVerifications/verificationParameters` Mapeo VAST: `VAST/Ad/InLine/AdVerifications/Verification/VerificationParameters`	Cadena
`attributes`	Atributos de anuncios complementarios, como las dimensiones y el modo de renderizado. Ruta: `/avails/ads/companionAds/attributes`	Objeto
`companionClickThrough`	URL de la página del anunciante que el reproductor multimedia abre cuando el espectador hace clic en el anuncio complementario. Ruta: `/avails/ads/companionAds/companionClickThrough` Amplio mapeo: `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/CompanionClickThrough`	Cadena	`https://aws.amazon.com/`
`companionClickTracking`	La URL de seguimiento de la `companionClickThrough` propiedad. Ruta: `/avails/ads/companionAds/companionClickTracking` Mapeo VAST: `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/CompanionClickTracking`	Cadena	`https://myads.com/beaconing/event=clicktracking`
`htmlResource`	El HTML codificado en CDATA que se inserta directamente en la página HTML del proveedor de streaming. Ruta: `/avails/ads/companionAds/htmlResource` Mapeo VAST: `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/HTMLResource`	Cadena	`<![CDATA[<!doctype html><html><head><meta name=\"viewport\" content=\"width=1, initial-scale=1.0, minimum-scale=1.0,...]]>`
`iFrameResource`	La URL de un archivo de recursos HTML que el proveedor de streaming carga en un iframe. Ruta: `/avails/ads/companionAds/iFrameResource` Mapeo VAST: `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/iFrameResource`	Cadena
`sequence`	El valor de secuencia especificado para la creatividad en la respuesta VAST. Ruta: `/avails/ads/companionAds/sequence`	Cadena	`1`
`startTime`	La posición temporal, en formato ISO 8601 segundos. En el caso del HLS, es relativa al inicio de la sesión de reproducción. En el caso de DASH, esto es relativo a la AST (hora de inicio de disponibilidad) del manifiesto. La respuesta incluye las horas de inicio de todo el espacio publicitario y de cada anuncio y baliza. Ruta: `/avails/startTime` y `/avails/ads/startTime`	Cadena	`PT18.581355S`
`startTimeInSeconds`	La posición temporal, en formato de segundos. En el caso del HLS, es relativa al inicio de la sesión de reproducción. En el caso de DASH, esto es relativo a la AST (hora de inicio de disponibilidad) del manifiesto. La respuesta incluye las horas de inicio de todo el espacio publicitario y de cada anuncio y baliza. Ruta: `/avails/startTimeInSeconds` y `/avails/ads/startTimeInSeconds`	Número	`18.581`
`eventId`	HLS: el número de secuencia asociado a la baliza. DASH: `ptsTime` fecha de inicio del anuncio.	Cadena
`event`	El nombre del evento de seguimiento. Ruta: `/avails/ads/adVerifications/trackingEvents/event` o `/avails/ads/companionAds/trackingEvents/event`	Cadena	`impression`, `start`, `firstQuartile`, `midpoint`, `thirdQuartile`, `complete`
`beaconUrls`	La URL a la que se MediaTailor envía la baliza publicitaria. Ruta: `/avails/ads/mediaFiles/trackingEvents/beaconUrls`	Matriz
`bitrate`	La velocidad de bits del recurso de vídeo. Esta propiedad no suele incluirse en los activos ejecutables.	Cadena	`2048`
`companionAds`	Una o varias especificaciones complementarias de contenido publicitario, cada una de las cuales especifica el archivo de recursos que se va a utilizar. Los anuncios complementarios acompañan al anuncio y proporcionan contenido, como un marco alrededor del anuncio o un banner, para mostrarlo cerca del vídeo. Ruta: `/avails/ads/companionAds`	Matriz	`[]`
`creativeId`	El valor del `Id` atributo de la `Creative` etiqueta del anuncio.	Cadena	`creative-1`
`creativeSequence`	La secuencia en la que debe reproducirse un anuncio, según el `Ad@id` valor de la respuesta de VAST.	Cadena	`1`
`dashAvailabilityStartTime`	En el caso `MPD@availabilityStartTime` de live/dynamic DASH, el manifiesto de origen.	Cadena	`2022-10-05T19:38:39.263Z`
`delivery`	Indica si se está utilizando un `streaming` protocolo `progressive` o.	Cadena	`progressive`
`eventType`	El tipo de baliza. Ruta: `/avails/ads/mediaFiles/trackingEvents/eventType`	Cadena	`impression`
`height`	La altura, en píxeles, del recurso de vídeo.	Cadena	`360`
`hlsAnchorMediaSequenceNumber`	El número de secuencia multimedia de la secuencia first/oldest multimedia que aparece en el manifiesto de origen del HLS.	Cadena	`77`
`maintainAspectRatio`	Indica si se debe mantener la relación de aspecto del vídeo mientras se escala.	Booleano	`true`
`mediaFilesList`	Especifica el vídeo y otros recursos que el reproductor necesita para que el anuncio esté disponible. Ruta: `/avails/ads/mediaFiles/mediaFilesList`	Matriz	`[]`
`mediaFileUri`	URI que apunta a un recurso ejecutable o a un recurso de vídeo.	Cadena	`https://myad.com/ad/ad134/vpaid.js`
`mediaType`	El tipo MIME del activo creativo o complementario.	Cadena	`video/mp4`
`meta`	Metadatos adicionales para el anuncio.	Objeto
`mezzanine`	La URL del MP4 recurso intermedio, que se especifica si el anuncio VPAID incluye uno. Ruta: `/avails/ads/mediaFiles/mezzanine`	Cadena	`https://gcdn.2mdn.net/videoplayback/id/itag/ck2/file/file.mp4`
`nextToken`	El valor del token que apunta a la siguiente página de resultados, cuando ese valor existe.	Cadena	`UFQzOS44NzNTXzIwMjMtMDctMzFUMTY6NTA6MDYuMzUwNjI2ODQ1Wl8x`
`nonLinearAds`	Anuncios no lineales que aparecen junto al contenido del vídeo.	Matriz	`[]`
`nonLinearAdsList`	Lista de anuncios no lineales.	Matriz	`[]`
`scalable`	Indica si se debe escalar el vídeo a otras dimensiones.	Booleano	`true`
`skipOffset`	El valor de tiempo que identifica cuándo el reproductor pone los controles de salto a disposición del usuario.	Cadena	`00:00:05`
`staticResource`	La URL de un archivo creativo estático que se utiliza para el componente publicitario. Ruta: `/avails/ads/companionAds/staticResource`	Cadena	`https://very-interactive-ads.com/campaign1/file.json?c=1019113602`
`vastAdId`	El valor del `Id` atributo de la `Ad` etiqueta.	Cadena	`ad1`
`width`	El ancho, en píxeles, del recurso de vídeo.	Cadena	`640`
`xPosition`	La posición horizontal de un icono dentro del reproductor de vídeo. Puede ser un valor de píxel específico o una posición como «izquierda» o «derecha». Ruta: `/avails/ads/icons/attributes/xPosition`	Cadena	`left` o `10`
`yPosition`	La posición vertical de un icono en el reproductor de vídeo. Puede ser un valor de píxel específico o una posición como «arriba» o «abajo». Ruta: `/avails/ads/icons/attributes/yPosition`	Cadena	`top` o `10`
`iconClicks`	Contiene información sobre los clics y el seguimiento de un icono. Ruta: `/avails/ads/icons/iconClicks`	Objeto
`iconClickThrough`	Una URL de la página del anunciante que el reproductor multimedia abre cuando el espectador hace clic en el icono. Ruta: `/avails/ads/icons/iconClicks/iconClickThrough`	Cadena	`https://advertiser.com/landing-page`
`iconClickTracking`	La URL de seguimiento de la `iconClickThrough` propiedad. Ruta: `/avails/ads/icons/iconClicks/iconClickTracking`	Objeto
`iconClickFallbackImages`	Conjunto de imágenes alternativas que se mostrarán si no se puede mostrar el icono. Ruta: `/avails/ads/icons/iconClicks/iconClickFallbackImages`	Matriz
`iconViewTracking`	La URL para rastrear cuándo se ve un icono. Ruta: `/avails/ads/icons/iconViewTracking`	Cadena	`https://tracking.example.com/icon-view`
`offset`	El intervalo de tiempo durante el que debe aparecer un icono durante la reproducción de un anuncio. Ruta: `/avails/ads/icons/attributes/offset`	Cadena	`00:00:05`
`program`	El programa o la iniciativa asociados al icono, como "AdChoices». Ruta: `/avails/ads/icons/attributes/program`	Cadena	`AdChoices`
`pxratio`	La proporción de píxeles del icono o del anuncio complementario, que se utiliza en pantallas con un DPI alto. Ruta: `/avails/ads/icons/attributes/pxratio` o `/avails/ads/companionAds/attributes/pxratio`	Cadena	`1` o `2`
`type`	El tipo de recurso o extensión. Ruta: `/avails/ads/extensions/type` o `/avails/ads/adVerifications/executableResource/type`	Cadena	`text/javascript`
`content`	El contenido de una extensión. Ruta: `/avails/ads/extensions/content`	Cadena
`language`	El lenguaje de programación de un recurso ejecutable. Ruta: `/avails/ads/adVerifications/executableResource/language`	Cadena	`javascript`
`browserOptional`	Indica si se requiere la compatibilidad con el navegador para el JavaScript recurso. Ruta: `/avails/ads/adVerifications/javaScriptResource/browserOptional`	Cadena	`true` o `false`
`id`	Un identificador de varios elementos del esquema. Ruta: `/avails/ads/companionAds/attributes/id` o `/avails/ads/icons/iconClicks/iconClickTracking/id`	Cadena	`companion-1`
`assetHeight`	La altura del elemento publicitario complementario. Ruta: `/avails/ads/companionAds/attributes/assetHeight`	Cadena	`250`
`assetWidth`	El ancho del activo publicitario complementario. Ruta: `/avails/ads/companionAds/attributes/assetWidth`	Cadena	`300`
`expandedHeight`	La altura del anuncio complementario cuando se expande. Ruta: `/avails/ads/companionAds/attributes/expandedHeight`	Cadena	`600`
`expandedWidth`	El ancho del anuncio complementario cuando está expandido. Ruta: `/avails/ads/companionAds/attributes/expandedWidth`	Cadena	`600`
`renderingMode`	El modo de renderización del anuncio complementario. Ruta: `/avails/ads/companionAds/attributes/renderingMode`	Cadena	`default` o `transparent`
`adSlotId`	El ID del espacio publicitario en el que debe mostrarse el anuncio complementario. Ruta: `/avails/ads/companionAds/attributes/adSlotId`	Cadena	`banner-1`
`creativeType`	El tipo MIME del recurso creativo. Ruta: `/avails/ads/icons/staticResource/creativeType`	Cadena	`image/png`

Aviso JavaScript está desactivado o no está disponible en su navegador.

Para utilizar la documentación de AWS, debe estar habilitado JavaScript. Para obtener más información, consulte las páginas de ayuda de su navegador.

Convenciones del documento

Seguimiento del lado del cliente

Cronología de la actividad

Esquema y propiedades del seguimiento de anuncios del lado del cliente

Esquema

Propiedades

importante