Schema e proprietà di tracciamento degli annunci sul lato client

Con la funzionalità di tracciamento degli annunci MediaTailor lato client, puoi integrare dati dettagliati di tracciamento degli annunci lato client nel tuo ambiente di gioco. Le sezioni seguenti trattano lo schema generale di tracciamento degli annunci, nonché le proprietà e i valori specifici che lo compongono.

Schema

La seguente struttura JSON mostra lo schema di tracciamento degli annunci sul lato client. MediaTailor Questa rappresentazione illustra la struttura di nidificazione dello schema per aiutarti a comprendere le relazioni tra le diverse parti.

Per informazioni dettagliate su ciascuna proprietà, vedere. Proprietà

{
  "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": {}
}

Proprietà

La tabella seguente elenca le proprietà dell'API di tracciamento lato client, le relative definizioni, i tipi di valore e gli esempi.

Proprietà	Definizione	Value type (Tipo di valore)	Esempio
adID	HLS: il numero di sequenza associato all'inizio dell'annuncio DASH: l'ID del periodo dell'annuncio Percorso: /avails/ads/adId Mappatura VAST: nessuna	Stringa	10
adBreakTrackingEvents	Un array che trasporta gli eventi di tracciamento VMAP dalla risposta VAST. Per ulteriori informazioni, vedere la sezione 2.3.3 della specifica VMAP 1.0. Percorso: /avails/ads/adBreakTrackingEvents	Array	[]
adMarkerDuration	La durata della disponibilità osservata dal marker dell'annuncio nel manifesto.	Stringa	30
adParameters	Una serie di parametri pubblicitari, provenienti da VAST VPAID, che vengono MediaTailor trasmessi al giocatore. Percorso: /avails/ads/adParameters Mappatura VAST: VAST/Ad/InLine/Creatives/Creative/Linear/AdParameters	Stringa
adProgramDateTime	HLS: la data, nel formato ISO/IEC 8601:2004, che rappresenta la prima sequenza multimediale dell'annuncio. DASH - [Non specificato]	Stringa
ads	Un array contenente gli oggetti pubblicitari che compongono l'avail. Gli annunci sono elencati nell'ordine in cui appaiono nel manifesto. Percorso: /avails/ads	Array	[]
adSystem	Il nome del sistema che pubblica l'annuncio. Importante Assicurati di fornire un valore. Se non fornisci un valore, possono sorgere problemi.	Stringa	myADS
adTitle	Il titolo dell'annuncio.	Stringa	ad1
adVerifications	Contiene le risorse e i metadati necessari per eseguire il codice di misurazione di terze parti al fine di verificare la riproduzione creativa. Per ulteriori informazioni su questa proprietà, vedere la sezione 3.16 della specifica VAST 4.2. MediaTailor supporta adVerifications come nodi di estensione VAST 3. Percorso: /avails/ads/adVerifications Mappatura VAST: VAST/Ad/InLine/AdVerifications	Array	[]
altText	Il testo alternativo per l'immagine di un annuncio complementare. Questo testo consente ai giocatori con supporto audio descrittivo per non vedenti di rileggere una descrizione dell'immagine. Percorso: /avails/ads/companionAds/altText	Stringa	video sequence advertising sneakers
apiFramework	Imposta su VPAID per dire al giocatore che questo annuncio è un annuncio VPAID. Può apparire in più posizioni dello schema.	Stringa	VPAID
availID	HLS: il numero di sequenza associato all'inizio della pubblicazione dell'annuncio. DASH: l'ID del periodo di pubblicazione dell'annuncio, che di solito è l'ID del periodo del contenuto che deve essere sostituito con un annuncio. Percorso: /avails/availID	Stringa	34 PT34S_1
avails	Un array contenente oggetti ad-break, o avail, che vengono presentati nella finestra del manifesto attiva. Gli avail sono elencati nell'ordine in cui appaiono nel manifesto. Percorso: /avails	Array	[]
adType	Il tipo di annuncio. Percorso: /avails/adType e /avails/ads/adType	Stringa
dateTime	Data e ora del programma, in formato ISO 8601 secondi, per l'inizio della pubblicazione o dell'annuncio. Percorso: e /avails/dateTime /avails/ads/dateTime	Stringa
duration	Lunghezza, in formato ISO 8601 secondi. La risposta include le durate per l'intero annuncio disponibile e per ogni annuncio e beacon, sebbene la durata del beacon sia sempre zero. /avails/durationPercorso: e /avails/ads/duration	Stringa	15.015
durationInSeconds	Lunghezza, in formato secondi. Percorso: /avails/durationInSeconds e /avails/ads/durationInSeconds	Numero
extensions	Estensioni personalizzate di VAST utilizzate dai server pubblicitari. Per ulteriori informazioni sulle estensioni, consulta la sezione 3.18 della specifica VAST 4.2. Percorso: /avails/ads/extensions Mappatura VAST: VAST/Ad/InLine/Extensions	Array	[]
icons	Elementi dell'icona per l'annuncio. Percorso: /avails/ads/icons Mappatura VAST: VAST/Ad/InLine/Creatives/Creative/Linear/Icons	Array
mediaFiles	Sono disponibili video e altre risorse di cui il giocatore ha bisogno per l'annuncio. Percorso: /avails/ads/mediaFiles	Oggetto
nonLinearAvails	Matrice di oggetti non lineari e disponibili. Percorso: /nonLinearAvails	Array
executableResource	Risorse eseguibili per la verifica. Percorso: /avails/ads/adVerifications/executableResource Mappatura VAST: VAST/Ad/InLine/AdVerifications/Verification/ExecutableResource	Array
javaScriptResource	JavaScript risorse per la verifica. Percorso: /avails/ads/adVerifications/javaScriptResource Mappatura VAST: VAST/Ad/InLine/AdVerifications/Verification/JavaScriptResource	Array
trackingEvents	Monitoraggio degli eventi per la verifica o gli annunci complementari. Percorso: /avails/ads/adVerifications/trackingEvents o /avails/ads/companionAds/trackingEvents	Array
vendor	Fornitore di verifica. Percorso: /avails/ads/adVerifications/vendor Mappatura VAST: VAST/Ad/InLine/AdVerifications/Verification/@vendor	Stringa
uri	URI che punta a una risorsa eseguibile, a una risorsa video o a un endpoint di tracciamento. Percorso: varie posizioni nello schema Mappatura VAST: vari elementi CDATA in VAST	Stringa	https://tracking.example.com/impression
verificationParameters	Parametri di verifica. Percorso: /avails/ads/adVerifications/verificationParameters Mappatura VAST: VAST/Ad/InLine/AdVerifications/Verification/VerificationParameters	Stringa
attributes	Attributi pubblicitari complementari come dimensioni e modalità di rendering. Percorso: /avails/ads/companionAds/attributes	Oggetto
companionClickThrough	Un URL della pagina dell'inserzionista che il lettore multimediale apre quando lo spettatore fa clic sull'annuncio complementare. Percorso: /avails/ads/companionAds/companionClickThrough Mappatura VAST: VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/CompanionClickThrough	Stringa	https://aws.amazon.com/
companionClickTracking	L'URL di tracciamento della companionClickThrough proprietà. Percorso: /avails/ads/companionAds/companionClickTracking Mappatura VAST: VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/CompanionClickTracking	Stringa	https://myads.com/beaconing/event=clicktracking
htmlResource	L'HTML con codifica CData inserito direttamente nella pagina HTML del provider di streaming. Percorso: /avails/ads/companionAds/htmlResource Mappatura VAST: VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/HTMLResource	Stringa	<![CDATA[<!doctype html><html><head><meta name=\"viewport\" content=\"width=1, initial-scale=1.0, minimum-scale=1.0,...]]>
iFrameResource	L'URL di un file di risorse HTML che il provider di streaming carica in un iframe. Percorso: /avails/ads/companionAds/iFrameResource Mappatura VAST: VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/iFrameResource	Stringa
sequence	Il valore della sequenza specificato per la creatività nella risposta VAST. Percorso: /avails/ads/companionAds/sequence	Stringa	1
startTime	La posizione temporale, nel formato ISO 8601 secondi. Per HLS, è relativa all'inizio della sessione di riproduzione. Per DASH, è relativo all'AST (Availability Start Time) del manifest. La risposta include gli orari di inizio per l'intero spazio pubblicitario e per ogni annuncio e beacon. Percorso: /avails/startTime e /avails/ads/startTime	Stringa	PT18.581355S
startTimeInSeconds	La posizione temporale, in formato secondi. Per HLS, si riferisce all'inizio della sessione di riproduzione. Per DASH, è relativo all'AST (Availability Start Time) del manifest. La risposta include gli orari di inizio per l'intero spazio pubblicitario e per ogni annuncio e beacon. Percorso: /avails/startTimeInSeconds e /avails/ads/startTimeInSeconds	Numero	18.581
eventId	HLS: il numero di sequenza associato al faro. DASH: l'inizio ptsTime dell'annuncio.	Stringa
event	Il nome dell'evento di tracciamento. Percorso: /avails/ads/adVerifications/trackingEvents/event o /avails/ads/companionAds/trackingEvents/event	Stringa	impression, start, firstQuartile, midpoint, thirdQuartile, complete
beaconUrls	L'URL a cui MediaTailor invia l'ad beacon. Percorso: /avails/ads/mediaFiles/trackingEvents/beaconUrls	Array
bitrate	Il bitrate della risorsa video. Questa proprietà non è in genere inclusa per una risorsa eseguibile.	Stringa	2048
companionAds	Una o più specifiche relative ai contenuti pubblicitari, ognuna delle quali specifica un file di risorse da utilizzare. Gli annunci complementari accompagnano l'annuncio e forniscono contenuti, come una cornice attorno all'annuncio o un banner, da visualizzare vicino al video. Percorso: /avails/ads/companionAds	Array	[]
creativeId	Il valore dell'Idattributo del Creative tag per l'annuncio.	Stringa	creative-1
creativeSequence	La sequenza in cui deve essere riprodotto un annuncio, in base al Ad@id valore della risposta VAST.	Stringa	1
dashAvailabilityStartTime	Per live/dynamic DASH, il manifesto MPD@availabilityStartTime di origine.	Stringa	2022-10-05T19:38:39.263Z
delivery	Indica se viene utilizzato un streaming protocollo progressive or.	Stringa	progressive
eventType	Il tipo di faro. Percorso: /avails/ads/mediaFiles/trackingEvents/eventType	Stringa	impression
height	L'altezza, in pixel, della risorsa video.	Stringa	360
hlsAnchorMediaSequenceNumber	Il numero della sequenza multimediale della sequenza first/oldest multimediale visualizzata nel manifesto di origine HLS.	Stringa	77
maintainAspectRatio	Indica se mantenere le proporzioni del video durante il ridimensionamento.	Booleano	true
mediaFilesList	Speciifica il video e le altre risorse di cui il giocatore ha bisogno per la pubblicazione dell'annuncio. Percorso: /avails/ads/mediaFiles/mediaFilesList	Array	[]
mediaFileUri	URI che punta a una risorsa eseguibile o a una risorsa video.	Stringa	https://myad.com/ad/ad134/vpaid.js
mediaType	Il tipo MIME della risorsa creativa o complementare.	Stringa	video/mp4
meta	Metadati aggiuntivi per l'annuncio.	Oggetto
mezzanine	L'URL della MP4 risorsa mezzanine, specificato se l'annuncio VPAID ne include uno. Percorso: /avails/ads/mediaFiles/mezzanine	Stringa	https://gcdn.2mdn.net/videoplayback/id/itag/ck2/file/file.mp4
nextToken	Il valore del token che punta alla pagina successiva dei risultati, quando tale valore esiste.	Stringa	UFQzOS44NzNTXzIwMjMtMDctMzFUMTY6NTA6MDYuMzUwNjI2ODQ1Wl8x
nonLinearAds	Annunci non lineari che vengono visualizzati accanto ai contenuti video.	Array	[]
nonLinearAdsList	Elenco di annunci non lineari.	Array	[]
scalable	Indica se ridimensionare il video in base ad altre dimensioni.	Booleano	true
skipOffset	Il valore temporale che identifica quando il giocatore mette a disposizione dell'utente i controlli di salto.	Stringa	00:00:05
staticResource	L'URL di un file creativo statico utilizzato per il componente pubblicitario. Percorso: /avails/ads/companionAds/staticResource	Stringa	https://very-interactive-ads.com/campaign1/file.json?c=1019113602
vastAdId	Il valore dell'Idattributo del Ad tag.	Stringa	ad1
width	La larghezza, in pixel, della risorsa video.	Stringa	640
xPosition	La posizione orizzontale di un'icona all'interno del lettore video. Può essere un valore di pixel specifico o una posizione come «sinistra» o «destra». Percorso: /avails/ads/icons/attributes/xPosition	Stringa	left o 10
yPosition	La posizione verticale di un'icona all'interno del lettore video. Può essere un valore di pixel specifico o una posizione come «in alto» o «in basso». Percorso: /avails/ads/icons/attributes/yPosition	Stringa	top o 10
iconClicks	Contiene informazioni relative ai clic e al tracciamento di un'icona. Percorso: /avails/ads/icons/iconClicks	Oggetto
iconClickThrough	Un URL della pagina dell'inserzionista che il lettore multimediale apre quando lo spettatore fa clic sull'icona. Percorso: /avails/ads/icons/iconClicks/iconClickThrough	Stringa	https://advertiser.com/landing-page
iconClickTracking	L'URL di tracciamento della iconClickThrough proprietà. Percorso: /avails/ads/icons/iconClicks/iconClickTracking	Oggetto
iconClickFallbackImages	Una serie di immagini di riserva da visualizzare se l'icona non può essere visualizzata. Percorso: /avails/ads/icons/iconClicks/iconClickFallbackImages	Array
iconViewTracking	L'URL per tracciare quando viene visualizzata un'icona. Percorso: /avails/ads/icons/iconViewTracking	Stringa	https://tracking.example.com/icon-view
offset	L'offset temporale relativo alla visualizzazione di un'icona durante la riproduzione di un annuncio. Percorso: /avails/ads/icons/attributes/offset	Stringa	00:00:05
program	Il programma o l'iniziativa associata all'icona, ad esempio "AdChoices». Percorso: /avails/ads/icons/attributes/program	Stringa	AdChoices
pxratio	Il rapporto dei pixel dell'icona o dell'annuncio complementare, utilizzato per schermi ad alto DPI. Percorso: o /avails/ads/icons/attributes/pxratio /avails/ads/companionAds/attributes/pxratio	Stringa	1 o 2
type	Il tipo di risorsa o estensione. Percorso: /avails/ads/extensions/type o /avails/ads/adVerifications/executableResource/type	Stringa	text/javascript
content	Il contenuto di un'estensione. Percorso: /avails/ads/extensions/content	Stringa
language	Il linguaggio di programmazione di una risorsa eseguibile. Percorso: /avails/ads/adVerifications/executableResource/language	Stringa	javascript
browserOptional	Indica se è richiesto il supporto del browser per la JavaScript risorsa. Percorso: /avails/ads/adVerifications/javaScriptResource/browserOptional	Stringa	true o false
id	Un identificatore per vari elementi dello schema. Percorso: /avails/ads/companionAds/attributes/id o /avails/ads/icons/iconClicks/iconClickTracking/id	Stringa	companion-1
assetHeight	L'altezza della risorsa complementare. Percorso: /avails/ads/companionAds/attributes/assetHeight	Stringa	250
assetWidth	La larghezza della risorsa pubblicitaria complementare. Percorso: /avails/ads/companionAds/attributes/assetWidth	Stringa	300
expandedHeight	L'altezza dell'annuncio complementare quando è espanso. Percorso: /avails/ads/companionAds/attributes/expandedHeight	Stringa	600
expandedWidth	La larghezza dell'annuncio complementare quando espanso. Percorso: /avails/ads/companionAds/attributes/expandedWidth	Stringa	600
renderingMode	La modalità di rendering per l'annuncio complementare. Percorso: /avails/ads/companionAds/attributes/renderingMode	Stringa	default o transparent
adSlotId	L'ID dello spazio pubblicitario in cui deve essere visualizzato l'annuncio complementare. Percorso: /avails/ads/companionAds/attributes/adSlotId	Stringa	banner-1
creativeType	Il tipo MIME della risorsa creativa. Percorso: /avails/ads/icons/staticResource/creativeType	Stringa	image/png