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 à connaître entre la spécification VPAID 2 et la façon dont le SDK IMA est compatible avec 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. En effet, les créations peuvent générer des erreurs ou ne pas fonctionner comme prévu lorsqu'elles sont affichées par le SDK IMA HTML5.

Prérequis

  • Lecteur vidéo HTML5 avec SDK IMA pour 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 VPAID 2, appelez la méthode suivante avant d'initialiser 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 les articles Sécurité des tags iFrame et Élément de proxy du lecteur vidéo.
  • DISABLED : les annonces VPAID ne sont pas lues. 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 compatibilité avec 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 sur la page pour afficher les créations JavaScript VPAID 2. Cela signifie que si une création s'attend à accéder au DOM de la page parente, une erreur peut se produire. Pour afficher votre annonce dans un cadre iFrame convivial, 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 applications mobiles, en mode ENABLED, le SDK IMA pour HTML5 ne fournit pas l'élément vidéo réel dans l'annonce. Au lieu de cela, il fournit un élément proxy imitant une grande partie des fonctionnalités de l'élément vidéo normal. Pour les créations publicitaires qui n'appellent que des méthodes d'API compatibles, l'affichage des créations ne devrait pas changer. Avec le mode VpaidMode.INSECURE, le SDK fournit l'élément de lecteur vidéo au lieu du proxy.

Voici les méthodes, écouteurs et attributs disponibles pour 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 compatible avec les créations JavaScript VPAID 2 pour le moment.
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.