Schema und Eigenschaften für das clientseitige Ad-Tracking

Mit der MediaTailor clientseitigen Ad-Tracking-Funktion können Sie detaillierte clientseitige Ad-Tracking-Daten in Ihre Player-Umgebung integrieren. In den folgenden Abschnitten werden das allgemeine Ad-Tracking-Schema sowie die spezifischen Eigenschaften und Werte behandelt, aus denen sich das Schema zusammensetzt.

Schema

Die folgende JSON-Struktur zeigt das MediaTailor clientseitige Ad-Tracking-Schema. Diese Darstellung veranschaulicht die Verschachtelungsstruktur des Schemas, um Ihnen das Verständnis der Beziehungen zwischen den verschiedenen Teilen zu erleichtern.

Ausführliche Informationen zu den einzelnen Eigenschaften finden Sie unterEigenschaften.


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

Eigenschaften

In der folgenden Tabelle sind die Eigenschaften in der clientseitigen Tracking-API, ihre Definitionen, Wertetypen und Beispiele aufgeführt.

Eigenschaft	Definition	Werttyp	Beispiel
`adID`	HLS — die Sequenznummer, die dem Anfang der Anzeige zugeordnet ist DASH — die Perioden-ID der Anzeige Pfad: `/avails/ads/adId` VAST-Zuordnung: Keine	Zeichenfolge	`10`
`adBreakTrackingEvents`	Ein Array, das VMAP-Tracking-Ereignisse aus der VAST-Antwort enthält. Weitere Informationen finden Sie in Abschnitt 2.3.3 der VMAP 1.0-Spezifikation. Pfad: `/avails/ads/adBreakTrackingEvents`	Array	`[]`
`adMarkerDuration`	Die anhand der Anzeigenmarkierung im Manifest beobachtete Nutzungsdauer.	Zeichenfolge	`30`
`adParameters`	Eine Reihe von Anzeigenparametern aus dem VAST VPAID, die an den MediaTailor Player weitergegeben wird. Pfad: `/avails/ads/adParameters` VAST-Zuordnung: `VAST/Ad/InLine/Creatives/Creative/Linear/AdParameters`	Zeichenfolge
`adProgramDateTime`	HLS — das Datum im Format ISO/IEC 8601:2004, das die erste Mediensequenz der Anzeige darstellt. DASH — [Nicht spezifiziert]	Zeichenfolge
`ads`	Ein Array, das die Werbeobjekte enthält, aus denen sich der Avail zusammensetzt. Die Anzeigen werden in der Reihenfolge aufgeführt, in der sie im Manifest erscheinen. Pfad: `/avails/ads`	Array	`[]`
`adSystem`	Der Name des Systems, das die Anzeige bereitstellt. Wichtig Stellen Sie sicher, dass Sie einen Wert angeben. Wenn Sie keinen Wert angeben, können Probleme auftreten.	Zeichenfolge	`myADS`
`adTitle`	Der Titel der Anzeige.	Zeichenfolge	`ad1`
`adVerifications`	Enthält die Ressourcen und Metadaten, die für die Ausführung von Messcode von Drittanbietern erforderlich sind, um die kreative Wiedergabe zu überprüfen. Weitere Informationen zu dieser Eigenschaft finden Sie in Abschnitt 3.16 der VAST 4.2-Spezifikation. MediaTailor unterstützt `adVerifications` als VAST 3 Erweiterungsknoten. Pfad: `/avails/ads/adVerifications` VAST-Zuordnung: `VAST/Ad/InLine/AdVerifications`	Array	`[]`
`altText`	Der alternative Text für ein Bild einer Begleitanzeige. Dieser Text ermöglicht es Spielern mit beschreibender Audiounterstützung für sehbehinderte Personen, eine Beschreibung des Bildes vorzulesen. Pfad: `/avails/ads/companionAds/altText`	Zeichenfolge	`video sequence advertising sneakers`
`apiFramework`	Stellen Sie auf ein`VPAID`, um dem Player mitzuteilen, dass es sich bei dieser Anzeige um eine VPAID-Anzeige handelt. Kann an mehreren Stellen im Schema erscheinen.	Zeichenfolge	`VPAID`
`availID`	HLS — die Sequenznummer, die mit dem Start der verfügbaren Anzeige verknüpft ist. DASH — die Perioden-ID der Werbeanzeige, bei der es sich in der Regel um die Perioden-ID des Inhalts handelt, der durch eine Anzeige ersetzt werden soll. Pfad: `/avails/availID`	Zeichenfolge	`34` `PT34S_1`
`avails`	Ein Array, das Ad-Break-Objekte oder Avails enthält, die im aktiven Manifestfenster angezeigt werden. Die Avails werden in der Reihenfolge aufgeführt, in der sie im Manifest erscheinen. Pfad: `/avails`	Array	`[]`
`adType`	Der Typ der Anzeige. Pfad: `/avails/adType` und `/avails/ads/adType`	Zeichenfolge
`dateTime`	Programmdatum und Uhrzeit im Format ISO 8601 Sekunden für den Start der Anzeige Avail oder Anzeige. Pfad: und `/avails/dateTime` `/avails/ads/dateTime`	Zeichenfolge
`duration`	Länge im ISO-8601-Sekunden-Format. Die Antwort umfasst die Dauer für die gesamte Anzeigenverfügbarkeit sowie für jede Anzeige und jedes Beacon, obwohl die Dauer der Beacons immer Null ist. Pfad: und `/avails/duration` `/avails/ads/duration`	Zeichenfolge	`15.015`
`durationInSeconds`	Länge im Sekundenformat. Pfad: `/avails/durationInSeconds` und `/avails/ads/durationInSeconds`	Zahl
`extensions`	Benutzerdefinierte Erweiterungen von VAST, die Werbeserver verwenden. Weitere Informationen zu Erweiterungen finden Sie in Abschnitt 3.18 der VAST 4.2-Spezifikation. Pfad: `/avails/ads/extensions` VAST-Zuordnung: `VAST/Ad/InLine/Extensions`	Array	`[]`
`icons`	Symbolelemente für die Anzeige. Pfad: `/avails/ads/icons` VAST-Zuordnung: `VAST/Ad/InLine/Creatives/Creative/Linear/Icons`	Array
`mediaFiles`	Video und andere Inhalte, die der Spieler für die Anzeige benötigt, stehen zur Verfügung. Pfad: `/avails/ads/mediaFiles`	Objekt
`nonLinearAvails`	Eine Reihe nichtlinearer und verfügbarer Objekte. Pfad: `/nonLinearAvails`	Array
`executableResource`	Ausführbare Ressourcen zur Überprüfung. Pfad: `/avails/ads/adVerifications/executableResource` VAST-Zuordnung: `VAST/Ad/InLine/AdVerifications/Verification/ExecutableResource`	Array
`javaScriptResource`	JavaScript Ressourcen zur Überprüfung. Pfad: `/avails/ads/adVerifications/javaScriptResource` VAST-Zuordnung: `VAST/Ad/InLine/AdVerifications/Verification/JavaScriptResource`	Array
`trackingEvents`	Erfassung von Ereignissen zur Verifizierung oder als Begleitwerbung Pfad: `/avails/ads/adVerifications/trackingEvents` oder `/avails/ads/companionAds/trackingEvents`	Array
`vendor`	Anbieter der Verifizierung. Pfad: `/avails/ads/adVerifications/vendor` VAST-Zuordnung: `VAST/Ad/InLine/AdVerifications/Verification/@vendor`	Zeichenfolge
`uri`	URI, die entweder auf ein ausführbares Asset, ein Video-Asset oder einen Tracking-Endpunkt verweist. Pfad: Verschiedene Speicherorte im Schema VAST-Zuordnung: Verschiedene CDATA-Elemente in VAST	Zeichenfolge	`https://tracking.example.com/impression`
`verificationParameters`	Überprüfungsparameter. Pfad: `/avails/ads/adVerifications/verificationParameters` VAST-Zuordnung: `VAST/Ad/InLine/AdVerifications/Verification/VerificationParameters`	Zeichenfolge
`attributes`	Begleitende Anzeigenattribute wie Abmessungen und Rendermodus. Pfad: `/avails/ads/companionAds/attributes`	Objekt
`companionClickThrough`	Eine URL zur Seite des Werbetreibenden, die der Media Player öffnet, wenn der Zuschauer auf die Begleitanzeige klickt. Pfad: `/avails/ads/companionAds/companionClickThrough` VAST-Zuordnung: `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/CompanionClickThrough`	Zeichenfolge	`https://aws.amazon.com/`
`companionClickTracking`	Die Tracking-URL für die `companionClickThrough` Immobilie. Pfad: `/avails/ads/companionAds/companionClickTracking` VAST-Zuordnung: `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/CompanionClickTracking`	Zeichenfolge	`https://myads.com/beaconing/event=clicktracking`
`htmlResource`	Der CDATA-kodierte HTML-Code, der direkt in die HTML-Seite des Streaming-Anbieters eingefügt wird. Pfad: `/avails/ads/companionAds/htmlResource` VAST-Zuordnung: `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/HTMLResource`	Zeichenfolge	`<![CDATA[<!doctype html><html><head><meta name=\"viewport\" content=\"width=1, initial-scale=1.0, minimum-scale=1.0,...]]>`
`iFrameResource`	Die URL zu einer HTML-Ressourcendatei, die der Streaming-Anbieter in einen Iframe lädt. Pfad: `/avails/ads/companionAds/iFrameResource` VAST-Zuordnung: `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/iFrameResource`	Zeichenfolge
`sequence`	Der Sequenzwert, der für das Creative in der VAST-Antwort angegeben wurde. Pfad: `/avails/ads/companionAds/sequence`	Zeichenfolge	`1`
`startTime`	Die Zeitposition im ISO-8601-Sekundenformat. Bei HLS bezieht sich dies auf den Beginn der Wiedergabesitzung. Für DASH ist dies relativ zur AST (Availability Start Time) des Manifests. Die Antwort enthält Startzeiten für den gesamten Ad-Avail und für jede Werbung und jedes Beacon. Pfad: `/avails/startTime` und `/avails/ads/startTime`	Zeichenfolge	`PT18.581355S`
`startTimeInSeconds`	Die Zeitposition im Sekundenformat. Bei HLS bezieht sich dies auf den Beginn der Wiedergabesitzung. Für DASH ist dies relativ zur AST (Availability Start Time) des Manifests. Die Antwort enthält Startzeiten für den gesamten Ad-Avail und für jede Werbung und jedes Beacon. Pfad: `/avails/startTimeInSeconds` und `/avails/ads/startTimeInSeconds`	Zahl	`18.581`
`eventId`	HLS — die dem Beacon zugeordnete Sequenznummer. DASH — der `ptsTime` Zeitpunkt des Starts der Anzeige.	Zeichenfolge
`event`	Der Name des Tracking-Ereignisses. Pfad: `/avails/ads/adVerifications/trackingEvents/event` oder `/avails/ads/companionAds/trackingEvents/event`	Zeichenfolge	`impression`, `start`, `firstQuartile`, `midpoint`, `thirdQuartile`, `complete`
`beaconUrls`	Die URL, an die der Ad Beacon MediaTailor gesendet wird. Pfad: `/avails/ads/mediaFiles/trackingEvents/beaconUrls`	Array
`bitrate`	Die Bitrate des Video-Assets. Diese Eigenschaft ist in der Regel nicht für ein ausführbares Asset enthalten.	Zeichenfolge	`2048`
`companionAds`	Eine oder mehrere Spezifikationen für begleitende Anzeigeninhalte, von denen jede eine zu verwendende Ressourcendatei spezifiziert. Begleitanzeigen begleiten die Werbeanzeige und bieten Inhalte, wie z. B. einen Rahmen um die Anzeige oder ein Banner, der in der Nähe des Videos eingeblendet wird. Pfad: `/avails/ads/companionAds`	Array	`[]`
`creativeId`	Der `Id` Attributwert des `Creative` Tags für die Anzeige.	Zeichenfolge	`creative-1`
`creativeSequence`	Die Reihenfolge, in der eine Anzeige abgespielt werden soll, entsprechend dem `Ad@id` Wert in der VAST-Antwort.	Zeichenfolge	`1`
`dashAvailabilityStartTime`	Bei live/dynamic DASH ist es das `MPD@availabilityStartTime` Ursprungs-Manifest.	Zeichenfolge	`2022-10-05T19:38:39.263Z`
`delivery`	Gibt an, ob ein `progressive` `streaming` OR-Protokoll verwendet wird.	Zeichenfolge	`progressive`
`eventType`	Der Typ des Beacons. Pfad: `/avails/ads/mediaFiles/trackingEvents/eventType`	Zeichenfolge	`impression`
`height`	Die Höhe des Video-Assets in Pixeln.	Zeichenfolge	`360`
`hlsAnchorMediaSequenceNumber`	Die Mediensequenznummer der first/oldest Mediensequenz, die im HLS-Ursprungsmanifest zu sehen ist.	Zeichenfolge	`77`
`maintainAspectRatio`	Gibt an, ob das Seitenverhältnis des Videos bei der Skalierung beibehalten werden soll.	Boolesch	`true`
`mediaFilesList`	Gibt das Video und andere Elemente an, die der Player für die Anzeigenbereitstellung benötigt. Pfad: `/avails/ads/mediaFiles/mediaFilesList`	Array	`[]`
`mediaFileUri`	URI, die entweder auf ein ausführbares Asset oder ein Video-Asset verweist.	Zeichenfolge	`https://myad.com/ad/ad134/vpaid.js`
`mediaType`	Der MIME-Typ des kreativen Elements oder des Begleitelements.	Zeichenfolge	`video/mp4`
`meta`	Zusätzliche Metadaten für die Anzeige.	Objekt
`mezzanine`	Die URL des MP4 Mezzanine-Assets, angegeben, falls die VPAID-Anzeige eines enthält. Pfad: `/avails/ads/mediaFiles/mezzanine`	Zeichenfolge	`https://gcdn.2mdn.net/videoplayback/id/itag/ck2/file/file.mp4`
`nextToken`	Der Wert des Tokens, das auf die nächste Ergebnisseite verweist, sofern ein solcher Wert vorhanden ist.	Zeichenfolge	`UFQzOS44NzNTXzIwMjMtMDctMzFUMTY6NTA6MDYuMzUwNjI2ODQ1Wl8x`
`nonLinearAds`	Nichtlineare Anzeigen, die neben dem Videoinhalt erscheinen.	Array	`[]`
`nonLinearAdsList`	Liste der nichtlinearen Anzeigen.	Array	`[]`
`scalable`	Gibt an, ob das Video auf andere Dimensionen skaliert werden soll.	Boolesch	`true`
`skipOffset`	Der Zeitwert, der angibt, wann der Player dem Benutzer Steuerelemente zum Überspringen zur Verfügung stellt.	Zeichenfolge	`00:00:05`
`staticResource`	Die URL zu einer statischen kreativen Datei, die für die Anzeigenkomponente verwendet wird. Pfad: `/avails/ads/companionAds/staticResource`	Zeichenfolge	`https://very-interactive-ads.com/campaign1/file.json?c=1019113602`
`vastAdId`	Der `Id` Attributwert des `Ad` Tags.	Zeichenfolge	`ad1`
`width`	Die Breite des Video-Assets in Pixeln.	Zeichenfolge	`640`
`xPosition`	Die horizontale Position eines Symbols im Videoplayer. Dies kann ein bestimmter Pixelwert oder eine Position wie „links“ oder „rechts“ sein. Pfad: `/avails/ads/icons/attributes/xPosition`	Zeichenfolge	`left` oder `10`
`yPosition`	Die vertikale Position eines Symbols im Videoplayer. Dies kann ein bestimmter Pixelwert oder eine Position wie „oben“ oder „unten“ sein. Pfad: `/avails/ads/icons/attributes/yPosition`	Zeichenfolge	`top` oder `10`
`iconClicks`	Enthält Informationen zum Durchklicken und zur Nachverfolgung eines Symbols. Pfad: `/avails/ads/icons/iconClicks`	Objekt
`iconClickThrough`	Eine URL zur Seite des Werbetreibenden, die der Media Player öffnet, wenn der Zuschauer auf das Symbol klickt. Pfad: `/avails/ads/icons/iconClicks/iconClickThrough`	Zeichenfolge	`https://advertiser.com/landing-page`
`iconClickTracking`	Die Tracking-URL für die `iconClickThrough` Immobilie. Pfad: `/avails/ads/icons/iconClicks/iconClickTracking`	Objekt
`iconClickFallbackImages`	Eine Reihe von Ersatzbildern, die angezeigt werden sollen, falls das Symbol nicht angezeigt werden kann. Pfad: `/avails/ads/icons/iconClicks/iconClickFallbackImages`	Array
`iconViewTracking`	Die URL für die Nachverfolgung, wenn ein Symbol angezeigt wird. Pfad: `/avails/ads/icons/iconViewTracking`	Zeichenfolge	`https://tracking.example.com/icon-view`
`offset`	Der Zeitversatz, zu dem ein Symbol während der Anzeigenwiedergabe erscheinen soll. Pfad: `/avails/ads/icons/attributes/offset`	Zeichenfolge	`00:00:05`
`program`	Das Programm oder die Initiative, die mit dem Symbol verknüpft ist, z. B. "AdChoices“. Pfad: `/avails/ads/icons/attributes/program`	Zeichenfolge	`AdChoices`
`pxratio`	Das Pixelverhältnis für das Symbol oder die Begleitanzeige, das für Displays mit hohem DPI-Wert verwendet wird. Pfad: oder `/avails/ads/icons/attributes/pxratio` `/avails/ads/companionAds/attributes/pxratio`	Zeichenfolge	`1` oder `2`
`type`	Der Typ der Ressource oder Erweiterung. Pfad: `/avails/ads/extensions/type` oder `/avails/ads/adVerifications/executableResource/type`	Zeichenfolge	`text/javascript`
`content`	Der Inhalt einer Erweiterung. Pfad: `/avails/ads/extensions/content`	Zeichenfolge
`language`	Die Programmiersprache einer ausführbaren Ressource. Pfad: `/avails/ads/adVerifications/executableResource/language`	Zeichenfolge	`javascript`
`browserOptional`	Gibt an, ob Browserunterstützung für die JavaScript Ressource erforderlich ist. Pfad: `/avails/ads/adVerifications/javaScriptResource/browserOptional`	Zeichenfolge	`true` oder `false`
`id`	Ein Bezeichner für verschiedene Elemente im Schema. Pfad: `/avails/ads/companionAds/attributes/id` oder `/avails/ads/icons/iconClicks/iconClickTracking/id`	Zeichenfolge	`companion-1`
`assetHeight`	Die Höhe der Begleitperson und des Assets. Pfad: `/avails/ads/companionAds/attributes/assetHeight`	Zeichenfolge	`250`
`assetWidth`	Die Breite des Begleit-Assets. Pfad: `/avails/ads/companionAds/attributes/assetWidth`	Zeichenfolge	`300`
`expandedHeight`	Die Höhe der Begleitanzeige im erweiterten Zustand. Pfad: `/avails/ads/companionAds/attributes/expandedHeight`	Zeichenfolge	`600`
`expandedWidth`	Die Breite der Begleitanzeige, wenn sie erweitert wird. Pfad: `/avails/ads/companionAds/attributes/expandedWidth`	Zeichenfolge	`600`
`renderingMode`	Der Rendermodus für die Begleitanzeige. Pfad: `/avails/ads/companionAds/attributes/renderingMode`	Zeichenfolge	`default` oder `transparent`
`adSlotId`	Die ID der Werbefläche, in der die Begleitanzeige angezeigt werden soll. Pfad: `/avails/ads/companionAds/attributes/adSlotId`	Zeichenfolge	`banner-1`
`creativeType`	Der MIME-Typ des kreativen Assets. Pfad: `/avails/ads/icons/staticResource/creativeType`	Zeichenfolge	`image/png`

Warnung JavaScript ist in Ihrem Browser nicht verfügbar oder deaktiviert.

Zur Nutzung der AWS-Dokumentation muss JavaScript aktiviert sein. Weitere Informationen finden auf den Hilfe-Seiten Ihres Browsers.

Dokumentkonventionen

Kundenseitiges Tracking

Zeitpunkt der Aktivität

Schema und Eigenschaften für das clientseitige Ad-Tracking

Schema

Eigenschaften

Wichtig