Créations JavaScript VPAID 2

Le SDK IMA pour HTML5 est compatible avec les créations JavaScript VPAID 2. L'activation de la compatibilité est simple, mais il existe deux différences à prendre en compte entre la spécification VPAID 2 et la façon dont le SDK IMA prend en charge la norme VPAID 2. Ces différences n'ont aucune incidence sur le code d'intégration du lecteur ou du SDK, mais elles sont importantes pour les auteurs de créations JavaScript VPAID 2, car elles peuvent générer des erreurs ou ne pas fonctionner comme prévu lorsqu'elles sont affichées par le SDK IMA HTML5.

Conditions préalables

  • Lecteur vidéo HTML5 avec SDK IMA HTML5 intégré Si vous n'en avez pas, consultez notre guide de démarrage.
  • URL de tag d'emplacement publicitaire VAST qui redirige vers une création JavaScript VPAID 2.

Introductions utiles

Activer la compatibilité avec VPAID 2

Pour activer la compatibilité avec JavaScript 2 avec JavaScript, appelez la méthode suivante avant d'initialiser votre AdDisplayContainer:

      google.ima.settings.setVpaidMode(google.ima.ImaSdkSettings.VpaidMode.ENABLED);
      ...
      var adDisplayContainer = new google.ima.AdDisplayContainer(adContainerElement);
      var adsLoader = new google.ima.AdsLoader(adDisplayContainer);
      ...

Les modes VPAID disponibles sont les suivants:

  • ENABLED : autorise les annonces VPAID avec les paramètres par défaut.
  • INSECURE : autorise les annonces VPAID en mode non sécurisé. Pour en savoir plus, consultez Sécurité iFrame et Élément proxy du lecteur vidéo.
  • DISABLED : la lecture des annonces VPAID n'est pas autorisée. Si une annonce demandée renvoie une création VPAID, une erreur est générée.
Pour en savoir plus sur les modes VPAID, consultez la documentation de l'API pour ImaSdkSettings.VpaidMode.

Mises en garde concernant la norme VPAID 2

Sécurité iFrame

Par défaut, le SDK IMA utilise un iFrame sécurisé au lieu d'un iFrame convivial (même domaine) ou d'un script de type encart pour afficher les créations JavaScript VPAID 2. Par conséquent, si une création prévoit d'accéder au DOM de la page parente, elle peut provoquer une erreur. Pour afficher votre annonce dans un cadre iFrame compatible, vous pouvez utiliser ImaSdkSettings.setVpaidMode(...), comme suit : 

adsLoader.getSettings().setVpaidMode(google.ima.ImaSdkSettings.VpaidMode.INSECURE);

Élément proxy du lecteur vidéo

Pour des raisons de sécurité et de bon fonctionnement des appareils mobiles, en mode ENABLED, le SDK IMA HTML5 ne fournit pas l'élément vidéo proprement dit à l'annonce, mais un élément proxy qui imite une grande partie des fonctionnalités de l'élément vidéo normal. Pour les créations qui n'appellent que des méthodes d'API compatibles, aucun changement de comportement ne devrait se produire au niveau de l'affichage des créations. Avec le mode VpaidMode.INSECURE, le SDK fournit l'élément du lecteur vidéo au lieu du proxy.

Voici les méthodes, les écouteurs et les attributs disponibles au niveau de l'élément proxy vidéo:

Méthodes

  • addEventListener
  • canPlayType
  • load
  • play
  • pause
  • setattribute

Types d'événements pour addEventListener

  • abort
  • canplay
  • canplaythrough
  • click
  • durationchange
  • emptied
  • ended
  • error
  • loadeddata
  • loadedmetadata
  • loadstart
  • pause
  • play
  • playing
  • progress
  • ratechange
  • suspend
  • seeked
  • seeking
  • timeupdate
  • waiting

Attributs

  • currentTime
  • duration
  • ended
  • paused
  • playbackRate
  • src
  • type

Questions fréquentes

Les créations JavaScript VPAID 2 sont-elles compatibles avec les SDK iOS ou Android ?
Le SDK IMA HTML5 est la seule plate-forme SDK IMA qui accepte actuellement les créations JavaScript VPAID 2.
Les créations VPAID sont-elles activées dans le SDK IMA pour HTML5 ?
Oui, le SDK IMA pour HTML5 est compatible avec les créations JavaScript VPAID 2.