Schéma et propriétés de suivi des publicités côté client

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 jeu. Les sections suivantes couvrent le schéma global 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 : le numéro de période de l'annonce Trajectoire : /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. Trajectoire : /avails/ads/adBreakTrackingEvents	Tableau	[]
adMarkerDuration	Durée de validité observée à partir du marqueur publicitaire dans le manifeste.	Chaîne	30
adParameters	Une chaîne de paramètres publicitaires, provenant du VAST VPAID, qui est MediaTailor transmise au joueur. Trajectoire : /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. Trajectoire : /avails/ads	Tableau	[]
adSystem	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	Le titre de l'annonce.	Chaîne	ad1
adVerifications	Contient les ressources et les métadonnées requises pour exécuter un code de mesure tiers afin de vérifier une lecture créative. Pour plus d'informations sur cette propriété, consultez la section 3.16 de la spécification VAST 4.2. MediaTailor prend en charge en adVerifications tant que nœuds d'extension VAST 3. Trajectoire : /avails/ads/adVerifications Cartographie VAST : VAST/Ad/InLine/AdVerifications	Tableau	[]
altText	Texte alternatif pour l'image d'une annonce associée. Ce texte permet aux joueurs disposant d'un support audio descriptif pour malvoyants de relire une description de l'image. Trajectoire : /avails/ads/companionAds/altText	Chaîne	video sequence advertising sneakers
apiFramework	Réglez sur VPAID pour indiquer au joueur qu'il s'agit d'une publicité VPAID. Peut apparaître à plusieurs endroits dans le schéma.	Chaîne	VPAID
availID	HLS : numéro de séquence associé au début de la diffusion de l'annonce. 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 publicité. Trajectoire : /avails/availID	Chaîne	34 PT34S_1
avails	Tableau contenant des objets publicitaires, ou outils, présentés dans la fenêtre de manifeste active. Les options sont répertoriées dans l'ordre dans lequel elles apparaissent dans le manifeste. Trajectoire : /avails	Tableau	[]
adType	Le type de publicité. Trajectoire : /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 la diffusion de l'annonce ou de l'annonce. Trajectoire : /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 publicité et pour chaque annonce et balise, bien que les durées des balises soient toujours nulles. Trajectoire : /avails/duration et /avails/ads/duration	Chaîne	15.015
durationInSeconds	Durée, en secondes. Trajectoire : /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 VAST 4.2. Trajectoire : /avails/ads/extensions Cartographie VAST : VAST/Ad/InLine/Extensions	Tableau	[]
icons	Éléments d'icône de l'annonce. Trajectoire : /avails/ads/icons Cartographie VAST : VAST/Ad/InLine/Creatives/Creative/Linear/Icons	Tableau
mediaFiles	Vidéos et autres ressources dont le joueur a besoin pour profiter de la publicité. Trajectoire : /avails/ads/mediaFiles	Objet
nonLinearAvails	Tableau d'objets non linéaires et disponibles. Trajectoire : /nonLinearAvails	Tableau
executableResource	Ressources exécutables à des fins de vérification. Trajectoire : /avails/ads/adVerifications/executableResource Cartographie VAST : VAST/Ad/InLine/AdVerifications/Verification/ExecutableResource	Tableau
javaScriptResource	JavaScript ressources pour la vérification. Trajectoire : /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 vérification. Trajectoire : /avails/ads/adVerifications/vendor Cartographie VAST : VAST/Ad/InLine/AdVerifications/Verification/@vendor	Chaîne
uri	URI pointant 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 Trajectoire : /avails/ads/adVerifications/verificationParameters Cartographie VAST : VAST/Ad/InLine/AdVerifications/Verification/VerificationParameters	Chaîne
attributes	Attributs publicitaires complémentaires tels que les dimensions et le mode de rendu. Trajectoire : /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. Trajectoire : /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é. Trajectoire : /avails/ads/companionAds/companionClickTracking Cartographie VAST : VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/CompanionClickTracking	Chaîne	https://myads.com/beaconing/event=clicktracking
htmlResource	Le code HTML codé en CData qui est inséré directement dans la page HTML du fournisseur de streaming. Trajectoire : /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. Trajectoire : /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. Trajectoire : /avails/ads/companionAds/sequence	Chaîne	1
startTime	Position temporelle, au format ISO 8601 secondes. Pour le 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. Trajectoire : /avails/startTime et /avails/ads/startTime	Chaîne	PT18.581355S
startTimeInSeconds	Position temporelle, au format des secondes. Pour le 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. Trajectoire : /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	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 envoie la balise publicitaire. Trajectoire : /avails/ads/mediaFiles/trackingEvents/beaconUrls	Tableau
bitrate	Débit de la ressource vidéo. Cette propriété n'est généralement pas incluse pour un actif exécutable.	Chaîne	2048
companionAds	Une ou plusieurs spécifications de contenu publicitaire complémentaires, chacune d'entre elles spécifiant un fichier de ressources à utiliser. Des publicités complémentaires accompagnent le contenu publicitaire et fournissent du contenu, comme un cadre autour de l'annonce ou une bannière, à afficher à côté de la vidéo. Trajectoire : /avails/ads/companionAds	Tableau	[]
creativeId	La valeur d'Idattribut de la Creative balise associée à l'annonce.	Chaîne	creative-1
creativeSequence	L'ordre dans lequel une publicité doit être diffusée, en fonction de la Ad@id valeur de la réponse VAST.	Chaîne	1
dashAvailabilityStartTime	Pour live/dynamic DASH, MPD@availabilityStartTime le 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	Le type de balise. Trajectoire : /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 visible dans le manifeste d'origine HLS.	Chaîne	77
maintainAspectRatio	Indique s'il faut conserver le rapport hauteur/largeur 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 bénéficier de la publicité. Trajectoire : /avails/ads/mediaFiles/mediaFilesList	Tableau	[]
mediaFileUri	URI pointant 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 MP4 ressource mezzanine, spécifiée si l'annonce VPAID en inclut une. Trajectoire : /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	Publicités non linéaires 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 à 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. Trajectoire : /avails/ads/companionAds/staticResource	Chaîne	https://very-interactive-ads.com/campaign1/file.json?c=1019113602
vastAdId	La valeur d'Idattribut 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 ». Trajectoire : /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 ». Trajectoire : /avails/ads/icons/attributes/yPosition	Chaîne	top ou 10
iconClicks	Contient des informations relatives au clic et au suivi d'une icône. Trajectoire : /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. Trajectoire : /avails/ads/icons/iconClicks/iconClickThrough	Chaîne	https://advertiser.com/landing-page
iconClickTracking	URL de suivi de la iconClickThrough propriété. Trajectoire : /avails/ads/icons/iconClicks/iconClickTracking	Objet
iconClickFallbackImages	Un tableau d'images de remplacement à afficher si l'icône ne peut pas être affichée. Trajectoire : /avails/ads/icons/iconClicks/iconClickFallbackImages	Tableau
iconViewTracking	URL permettant de suivre l'affichage d'une icône. Trajectoire : /avails/ads/icons/iconViewTracking	Chaîne	https://tracking.example.com/icon-view
offset	Décalage horaire pendant lequel une icône doit apparaître pendant la diffusion d'une publicité. Trajectoire : /avails/ads/icons/attributes/offset	Chaîne	00:00:05
program	Le programme ou l'initiative associé à l'icône, tel que « AdChoices ». Trajectoire : /avails/ads/icons/attributes/program	Chaîne	AdChoices
pxratio	Le ratio de pixels de l'icône ou de la publicité associée, utilisé pour les écrans haute résolution. Trajectoire : /avails/ads/icons/attributes/pxratio ou /avails/ads/companionAds/attributes/pxratio	Chaîne	1 ou 2
type	Type de ressource ou d'extension. Trajectoire : /avails/ads/extensions/type ou /avails/ads/adVerifications/executableResource/type	Chaîne	text/javascript
content	Le contenu d'une extension. Trajectoire : /avails/ads/extensions/content	Chaîne
language	Langage de programmation d'une ressource exécutable. Trajectoire : /avails/ads/adVerifications/executableResource/language	Chaîne	javascript
browserOptional	Indique si le support du navigateur est requis pour la JavaScript ressource. Trajectoire : /avails/ads/adVerifications/javaScriptResource/browserOptional	Chaîne	true ou false
id	Identifiant pour les différents éléments du schéma. Trajectoire : /avails/ads/companionAds/attributes/id ou /avails/ads/icons/iconClicks/iconClickTracking/id	Chaîne	companion-1
assetHeight	Hauteur du compagnon et de la ressource. Trajectoire : /avails/ads/companionAds/attributes/assetHeight	Chaîne	250
assetWidth	Largeur de la ressource publicitaire associée. Trajectoire : /avails/ads/companionAds/attributes/assetWidth	Chaîne	300
expandedHeight	Hauteur de l'annonce associée lorsqu'elle est agrandie. Trajectoire : /avails/ads/companionAds/attributes/expandedHeight	Chaîne	600
expandedWidth	Largeur de l'annonce associée lorsqu'elle est agrandie. Trajectoire : /avails/ads/companionAds/attributes/expandedWidth	Chaîne	600
renderingMode	Mode de rendu de l'annonce associée. Trajectoire : /avails/ads/companionAds/attributes/renderingMode	Chaîne	default ou transparent
adSlotId	ID de l'espace publicitaire dans lequel l'annonce associée doit être affichée. Trajectoire : /avails/ads/companionAds/attributes/adSlotId	Chaîne	banner-1
creativeType	Type MIME de la ressource créative. Trajectoire : /avails/ads/icons/staticResource/creativeType	Chaîne	image/png