Activer les créations JavaScript VPAID 2

Le SDK IMA HTML5 est compatible avec les créations JavaScript VPAID 2. Lorsque vous activez la compatibilité, vous devez tenir compte de deux différences principales entre les spécifications VPAID 2 et la façon dont le SDK IMA est compatible avec VPAID 2. Ces différences n'ont pas d'incidence sur le code d'implémentation du lecteur ou du SDK, mais elles sont importantes pour les auteurs de créations JavaScript VPAID 2, car 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 pour HTML5.

Prérequis

Pour suivre ce guide, commencez par une application qui présente les caractéristiques suivantes :

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

Guides utiles

Activer la compatibilité avec VPAID 2

Pour activer la compatibilité avec VPAID 2 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);
...

Voici les modes VPAID disponibles :

  • 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é des iFrames et Élément proxy du lecteur vidéo.
  • DISABLED : les annonces VPAID ne sont pas diffusées. 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.

Remarques concernant la compatibilité avec VPAID 2

Sécurité des iFrames

Par défaut, le SDK IMA utilise un iFrame sécurisé au lieu d'un iFrame friendly (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, elle peut potentiellement provoquer une erreur. Pour afficher votre annonce dans un friendly iframe, 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 sur mobile, le SDK IMA HTML5 en mode ENABLED ne fournit pas l'élément vidéo réel à l'annonce. Il fournit plutôt un élément proxy qui imite 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, le rendu des créations ne devrait pas changer. 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 sur l'élément de 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 compatible avec les créations JavaScript VPAID 2.
Cela permet-il d'activer les créations VPAID dans le SDK IMA pour HTML5 ?
Oui, le SDK IMA HTML5 est compatible avec les créations JavaScript VPAID 2.