Client-side schéma et propriétés de suivi des publicités

Grâce à la fonction de suivi des publicités MediaTailor côté client, vous pouvez intégrer des données détaillées de suivi des publicités côté client dans votre environnement de joueur. Les sections suivantes présentent le schéma général de suivi des publicités, ainsi que les propriétés et valeurs spécifiques qui le composent.

Schema

La structure JSON suivante montre le schéma de suivi des publicités MediaTailor côté client. Cette représentation illustre la structure d'imbrication du schéma pour vous aider à comprendre les relations entre les différentes parties.

Pour obtenir des informations détaillées sur chaque propriété, consultezPropriétés.


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

Propriétés

Le tableau suivant répertorie les propriétés de l'API de suivi côté client, leurs définitions, leurs types de valeurs et des exemples.

Propriété	Définition	Type de la valeur	Exemple
`adID`	HLS - le numéro de séquence associé au début de l'annonce DASH - l'identifiant de période de l'annonce Parcours : `/avails/ads/adId` Cartographie VAST : Aucune	Chaîne	`10`
`adBreakTrackingEvents`	Un tableau qui contient les événements de suivi VMAP issus de la réponse VAST. Pour plus d'informations, consultez la section 2.3.3 de la spécification VMAP 1.0. Parcours : `/avails/ads/adBreakTrackingEvents`	Tableau	`[]`
`adMarkerDuration`	Durée de disponibilité observée à partir du marqueur publicitaire figurant dans le manifeste.	Chaîne	`30`
`adParameters`	Chaîne de paramètres publicitaires, provenant du VAST VPAID, qui est MediaTailor transmise au lecteur. Parcours : `/avails/ads/adParameters` Cartographie VAST : `VAST/Ad/InLine/Creatives/Creative/Linear/AdParameters`	Chaîne
`adProgramDateTime`	HLS : date, au format ISO/IEC 8601:2004, qui représente la première séquence multimédia de l'annonce. DASH - [Non spécifié]	Chaîne
`ads`	Tableau contenant les objets publicitaires qui constituent l'offre. Les annonces sont répertoriées dans l'ordre dans lequel elles apparaissent dans le manifeste. Parcours : `/avails/ads`	Tableau	`[]`
`adSystem`	Le nom du système qui diffuse l'annonce. Important Assurez-vous de fournir une valeur. Si vous ne fournissez pas de valeur, des problèmes peuvent survenir.	Chaîne	`myADS`
`adTitle`	Titre de l'annonce.	Chaîne	`ad1`
`adVerifications`	Contient les ressources et les métadonnées nécessaires pour exécuter un code de mesure tiers afin de vérifier la lecture créative. Pour plus d'informations sur cette propriété, consultez la section 3.16 de la spécification https://iabtechlab.com/standards/vast/ VAST 4.2. MediaTailor prend `adVerifications` en charge les nœuds d'extension VAST 3. Parcours : `/avails/ads/adVerifications` Cartographie VAST : `VAST/Ad/InLine/AdVerifications`	Tableau	`[]`
`altText`	Texte alternatif pour l'image d'une annonce complémentaire. Ce texte permet aux joueurs disposant d'un support audio descriptif pour les malvoyants de relire une description de l'image. Parcours : `/avails/ads/companionAds/altText`	Chaîne	`video sequence advertising sneakers`
`apiFramework`	Réglez sur `VPAID` pour indiquer au joueur que cette annonce est une annonce VPAID. Peut apparaître à plusieurs endroits dans le schéma.	Chaîne	`VPAID`
`availID`	HLS - le numéro de séquence associé au début de l'annonce disponible. DASH : l'identifiant de période de disponibilité de l'annonce, qui est généralement l'identifiant de période du contenu à remplacer par une annonce. Parcours : `/avails/availID`	Chaîne	`34` `PT34S_1`
`avails`	Un tableau contenant des objets de rupture de publicité, ou avantages, qui sont présentés dans la fenêtre de manifeste active. Les ressources sont répertoriées dans l'ordre dans lequel elles apparaissent dans le manifeste. Parcours : `/avails`	Tableau	`[]`
`adType`	Le type de l'annonce. Parcours : `/avails/adType` et `/avails/ads/adType`	Chaîne
`dateTime`	Programmez la date et l'heure, au format ISO 8601 secondes, pour le début de l'annonce ou de l'annonce. Parcours : `/avails/dateTime` et `/avails/ads/dateTime`	Chaîne
`duration`	Durée, au format ISO 8601 secondes. La réponse inclut les durées pour l'ensemble de la diffusion de l'annonce et pour chaque annonce et balise, bien que les durées des balises soient toujours nulles. Parcours : `/avails/duration` et `/avails/ads/duration`	Chaîne	`15.015`
`durationInSeconds`	Durée, au format secondes. Parcours : `/avails/durationInSeconds` et `/avails/ads/durationInSeconds`	Nombre
`extensions`	Extensions personnalisées de VAST utilisées par les serveurs publicitaires. Pour plus d'informations sur les extensions, consultez la section 3.18 de la spécification https://iabtechlab.com/standards/vast/ VAST 4.2. Parcours : `/avails/ads/extensions` Cartographie VAST : `VAST/Ad/InLine/Extensions`	Tableau	`[]`
`icons`	Éléments d'icône pour l'annonce. Parcours : `/avails/ads/icons` Cartographie VAST : `VAST/Ad/InLine/Creatives/Creative/Linear/Icons`	Tableau
`mediaFiles`	Les vidéos et autres ressources dont le joueur a besoin pour diffuser la publicité. Parcours : `/avails/ads/mediaFiles`	Objet
`nonLinearAvails`	Tableau d'objets non linéaires et disponibles. Parcours : `/nonLinearAvails`	Tableau
`executableResource`	Ressources exécutables pour la vérification. Parcours : `/avails/ads/adVerifications/executableResource` Cartographie VAST : `VAST/Ad/InLine/AdVerifications/Verification/ExecutableResource`	Tableau
`javaScriptResource`	JavaScript ressources pour la vérification. Parcours : `/avails/ads/adVerifications/javaScriptResource` Cartographie VAST : `VAST/Ad/InLine/AdVerifications/Verification/JavaScriptResource`	Tableau
`trackingEvents`	Suivi des événements à des fins de vérification ou d'annonces complémentaires. Trajectoire : `/avails/ads/adVerifications/trackingEvents` ou `/avails/ads/companionAds/trackingEvents`	Tableau
`vendor`	Fournisseur de services de vérification. Parcours : `/avails/ads/adVerifications/vendor` Cartographie VAST : `VAST/Ad/InLine/AdVerifications/Verification/@vendor`	Chaîne
`uri`	URI qui pointe vers une ressource exécutable, une ressource vidéo ou un point de terminaison de suivi. Chemin : différents emplacements dans le schéma Cartographie VAST : divers éléments CDATA dans VAST	Chaîne	`https://tracking.example.com/impression`
`verificationParameters`	Paramètres de vérification Parcours : `/avails/ads/adVerifications/verificationParameters` Cartographie VAST : `VAST/Ad/InLine/AdVerifications/Verification/VerificationParameters`	Chaîne
`attributes`	Attributs d'annonces complémentaires tels que les dimensions et le mode de rendu. Parcours : `/avails/ads/companionAds/attributes`	Objet
`companionClickThrough`	URL de la page de l'annonceur que le lecteur multimédia ouvre lorsque le spectateur clique sur l'annonce associée. Parcours : `/avails/ads/companionAds/companionClickThrough` Cartographie VAST : `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/CompanionClickThrough`	Chaîne	`https://aws.amazon.com/`
`companionClickTracking`	URL de suivi de la `companionClickThrough` propriété. Parcours : `/avails/ads/companionAds/companionClickTracking` Cartographie VAST : `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/CompanionClickTracking`	Chaîne	`https://myads.com/beaconing/event=clicktracking`
`htmlResource`	Le CDATA-encoded code HTML inséré directement dans la page HTML du fournisseur de streaming. Parcours : `/avails/ads/companionAds/htmlResource` Cartographie VAST : `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/HTMLResource`	Chaîne	`<![CDATA[<!doctype html><html><head><meta name=\"viewport\" content=\"width=1, initial-scale=1.0, minimum-scale=1.0,...]]>`
`iFrameResource`	URL d'un fichier de ressources HTML que le fournisseur de streaming charge dans un iframe. Parcours : `/avails/ads/companionAds/iFrameResource` Cartographie VAST : `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/iFrameResource`	Chaîne
`sequence`	La valeur de séquence spécifiée pour la création dans la réponse VAST. Parcours : `/avails/ads/companionAds/sequence`	Chaîne	`1`
`startTime`	La position temporelle, au format ISO 8601 secondes. Pour HLS, cela se rapporte au début de la session de lecture. Pour DASH, cela est relatif à l'AST (heure de début de disponibilité) du manifeste. La réponse inclut les heures de début pour l'ensemble de la diffusion de publicités, et pour chaque publicité et balise beacon. Parcours : `/avails/startTime` et `/avails/ads/startTime`	Chaîne	`PT18.581355S`
`startTimeInSeconds`	Position temporelle, au format secondes. Pour HLS, cela se rapporte au début de la session de lecture. Pour DASH, cela est relatif à l'AST (heure de début de disponibilité) du manifeste. La réponse inclut les heures de début pour l'ensemble de la diffusion de publicités, et pour chaque publicité et balise beacon. Parcours : `/avails/startTimeInSeconds` et `/avails/ads/startTimeInSeconds`	Nombre	`18.581`
`eventId`	HLS : numéro de séquence associé à la balise. DASH : `ptsTime` date du début de l'annonce.	Chaîne
`event`	Le nom de l'événement de suivi. Trajectoire : `/avails/ads/adVerifications/trackingEvents/event` ou `/avails/ads/companionAds/trackingEvents/event`	Chaîne	`impression`, `start`, `firstQuartile`, `midpoint`, `thirdQuartile`, `complete`
`beaconUrls`	URL à laquelle MediaTailor est envoyée la balise publicitaire. Parcours : `/avails/ads/mediaFiles/trackingEvents/beaconUrls`	Tableau
`bitrate`	Le débit de la ressource vidéo. Cette propriété n'est généralement pas incluse pour une ressource exécutable.	Chaîne	`2048`
`companionAds`	Une ou plusieurs spécifications de contenu publicitaire complémentaire, chacune d'entre elles spécifiant un fichier de ressources à utiliser. Des publicités complémentaires accompagnent l'annonce et fournissent du contenu, tel qu'un cadre autour de l'annonce ou une bannière, à afficher à proximité de la vidéo. Parcours : `/avails/ads/companionAds`	Tableau	`[]`
`creativeId`	La valeur d'`Id`attribut de la `Creative` balise de l'annonce.	Chaîne	`creative-1`
`creativeSequence`	L'ordre dans lequel une annonce doit être diffusée, en fonction de la `Ad@id` valeur de la réponse VAST.	Chaîne	`1`
`dashAvailabilityStartTime`	Pour live/dynamic DASH, le `MPD@availabilityStartTime` manifeste d'origine.	Chaîne	`2022-10-05T19:38:39.263Z`
`delivery`	Indique si un `streaming` protocole `progressive` ou est utilisé.	Chaîne	`progressive`
`eventType`	Type de balise. Parcours : `/avails/ads/mediaFiles/trackingEvents/eventType`	Chaîne	`impression`
`height`	Hauteur, en pixels, de la ressource vidéo.	Chaîne	`360`
`hlsAnchorMediaSequenceNumber`	Le numéro de séquence multimédia de la séquence first/oldest multimédia vue dans le manifeste d'origine HLS.	Chaîne	`77`
`maintainAspectRatio`	Indique s'il faut conserver le format d'image de la vidéo lors de la mise à l'échelle.	Booléen	`true`
`mediaFilesList`	Spécifie la vidéo et les autres ressources dont le joueur a besoin pour diffuser la publicité. Parcours : `/avails/ads/mediaFiles/mediaFilesList`	Tableau	`[]`
`mediaFileUri`	URI qui pointe vers une ressource exécutable ou une ressource vidéo.	Chaîne	`https://myad.com/ad/ad134/vpaid.js`
`mediaType`	Type MIME de la ressource créative ou complémentaire.	Chaîne	`video/mp4`
`meta`	Métadonnées supplémentaires pour l'annonce.	Objet
`mezzanine`	URL de la ressource MP4 de la mezzanine, spécifiée si l'annonce VPAID en inclut une. Parcours : `/avails/ads/mediaFiles/mezzanine`	Chaîne	`https://gcdn.2mdn.net/videoplayback/id/itag/ck2/file/file.mp4`
`nextToken`	La valeur du jeton qui pointe vers la page de résultats suivante, lorsqu'une telle valeur existe.	Chaîne	`UFQzOS44NzNTXzIwMjMtMDctMzFUMTY6NTA6MDYuMzUwNjI2ODQ1Wl8x`
`nonLinearAds`	Non-linear publicités qui apparaissent à côté du contenu vidéo.	Tableau	`[]`
`nonLinearAdsList`	Liste des publicités non linéaires.	Tableau	`[]`
`scalable`	Indique s'il faut redimensionner la vidéo en fonction d'autres dimensions.	Booléen	`true`
`skipOffset`	La valeur temporelle qui identifie le moment où le joueur met les commandes de saut à la disposition de l'utilisateur.	Chaîne	`00:00:05`
`staticResource`	URL d'un fichier créatif statique utilisé pour le composant publicitaire. Parcours : `/avails/ads/companionAds/staticResource`	Chaîne	`https://very-interactive-ads.com/campaign1/file.json?c=1019113602`
`vastAdId`	La valeur d'`Id`attribut de la `Ad` balise.	Chaîne	`ad1`
`width`	Largeur, en pixels, de la ressource vidéo.	Chaîne	`640`
`xPosition`	Position horizontale d'une icône dans le lecteur vidéo. Il peut s'agir d'une valeur de pixel spécifique ou d'une position telle que « gauche » ou « droite ». Parcours : `/avails/ads/icons/attributes/xPosition`	Chaîne	`left` ou `10`
`yPosition`	Position verticale d'une icône dans le lecteur vidéo. Il peut s'agir d'une valeur de pixel spécifique ou d'une position telle que « haut » ou « bas ». Parcours : `/avails/ads/icons/attributes/yPosition`	Chaîne	`top` ou `10`
`iconClicks`	Contient les informations relatives aux clics et au suivi d'une icône. Parcours : `/avails/ads/icons/iconClicks`	Objet
`iconClickThrough`	URL de la page de l'annonceur que le lecteur multimédia ouvre lorsque le spectateur clique sur l'icône. Parcours : `/avails/ads/icons/iconClicks/iconClickThrough`	Chaîne	`https://advertiser.com/landing-page`
`iconClickTracking`	URL de suivi de la `iconClickThrough` propriété. Parcours : `/avails/ads/icons/iconClicks/iconClickTracking`	Objet
`iconClickFallbackImages`	Tableau d'images de repli à afficher si l'icône ne peut pas être affichée. Parcours : `/avails/ads/icons/iconClicks/iconClickFallbackImages`	Tableau
`iconViewTracking`	URL permettant de suivre l'affichage d'une icône. Parcours : `/avails/ads/icons/iconViewTracking`	Chaîne	`https://tracking.example.com/icon-view`
`offset`	Décalage temporel pendant lequel une icône doit apparaître pendant la diffusion d'une annonce. Parcours : `/avails/ads/icons/attributes/offset`	Chaîne	`00:00:05`
`program`	Le programme ou l'initiative associé à l'icône, tel que « AdChoices ». Parcours : `/avails/ads/icons/attributes/program`	Chaîne	`AdChoices`
`pxratio`	Rapport de pixels de l'icône ou de la publicité associée, utilisé pour les écrans haute résolution. Chemin : `/avails/ads/icons/attributes/pxratio` ou `/avails/ads/companionAds/attributes/pxratio`	Chaîne	`1` ou `2`
`type`	Type de ressource ou d'extension. Chemin : `/avails/ads/extensions/type` ou `/avails/ads/adVerifications/executableResource/type`	Chaîne	`text/javascript`
`content`	Le contenu d'une extension. Parcours : `/avails/ads/extensions/content`	Chaîne
`language`	Langage de programmation d'une ressource exécutable. Parcours : `/avails/ads/adVerifications/executableResource/language`	Chaîne	`javascript`
`browserOptional`	Indique si la prise en charge du navigateur est requise pour la JavaScript ressource. Parcours : `/avails/ads/adVerifications/javaScriptResource/browserOptional`	Chaîne	`true` ou `false`
`id`	Un identifiant pour les différents éléments du schéma. Chemin : `/avails/ads/companionAds/attributes/id` ou `/avails/ads/icons/iconClicks/iconClickTracking/id`	Chaîne	`companion-1`
`assetHeight`	Hauteur de l'élément publicitaire associé. Parcours : `/avails/ads/companionAds/attributes/assetHeight`	Chaîne	`250`
`assetWidth`	Largeur de la ressource publicitaire associée. Parcours : `/avails/ads/companionAds/attributes/assetWidth`	Chaîne	`300`
`expandedHeight`	Hauteur de l'annonce d'accompagnement lorsqu'elle est agrandie. Parcours : `/avails/ads/companionAds/attributes/expandedHeight`	Chaîne	`600`
`expandedWidth`	Largeur de l'annonce complémentaire lorsqu'elle est agrandie. Parcours : `/avails/ads/companionAds/attributes/expandedWidth`	Chaîne	`600`
`renderingMode`	Mode de rendu de l'annonce complémentaire. Parcours : `/avails/ads/companionAds/attributes/renderingMode`	Chaîne	`default` ou `transparent`
`adSlotId`	L'identifiant de l'espace publicitaire dans lequel l'annonce complémentaire doit être affichée. Parcours : `/avails/ads/companionAds/attributes/adSlotId`	Chaîne	`banner-1`
`creativeType`	Type MIME de la ressource créative. Parcours : `/avails/ads/icons/staticResource/creativeType`	Chaîne	`image/png`

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Client-side suivi

Calendrier des activités

Client-side schéma et propriétés de suivi des publicités

Schema

Propriétés

Important