google.
Cette classe représente un conteneur permettant d'afficher des annonces. Le SDK crée automatiquement des structures dans le paramètre containerElement pour héberger les annonces vidéo et les annonces en superposition.
Lorsqu'une instance de cette classe est créée, elle crée un cadre iFrame dans l'élément containerElement et charge le noyau du SDK. Cet IFRAME doit être conservé pour que le SDK fonctionne correctement. Une fois que toutes les annonces ont été diffusées et que le SDK n'est plus nécessaire, utilisez la méthode destroy() pour décharger le SDK.
Le paramètre containerElement doit être un élément qui fait partie du DOM. Vous devez positionner correctement le conteneurElement pour que les annonces s'affichent correctement. Nous vous recommandons de le placer au-dessus du lecteur vidéo du contenu et de le redimensionner pour qu'il couvre l'intégralité du lecteur vidéo. Reportez-vous à la documentation du SDK pour en savoir plus sur les mises en œuvre recommandées.
Remarque : Il est toujours nécessaire d'appeler la méthode initialize() dans le code invoqué directement par une action utilisateur (un clic ou une pression, par exemple).
Constructeur
Conteneur pour les annonces display
new AdDisplayContainer(containerElement, videoElement, clickTrackingElement)
Paramètre |
|
|---|---|
|
containerElement |
Élément dans lequel les annonces doivent être diffusées. L'élément doit être inséré dans le DOM avant de créer AdDisplayContainer. La valeur ne doit pas être nulle. |
|
élément vidéo |
Facultative Spécifie l'élément de lecture de l'annonce vidéo alternative. Nous vous recommandons de toujours transmettre votre lecteur vidéo de contenu. La valeur ne doit pas être nulle. |
|
clickTrackingElement |
Facultative Spécifie l'élément de clic sur une annonce vidéo alternative. Laissez cette valeur nulle pour permettre au SDK de gérer les clics. Même s'il est fourni, le SDK n'utilisera l'élément de suivi des clics personnalisé que si des créations autres qu'AdSense/AdX sont affichées dans des environnements qui ne sont pas compatibles avec les éléments d'interface utilisateur qui se superposent à un lecteur vidéo (par exemple, iPhone ou version antérieure à Android 4.0). L'élément de suivi des clics personnalisé ne doit jamais être affiché sur le lecteur vidéo, car il peut intercepter les clics sur les éléments de l'interface utilisateur rendus par le SDK. Notez également que le SDK ne modifie pas la visibilité de l'élément de suivi des clics personnalisé. Cela signifie que si un élément de suivi des clics personnalisé est fourni, il doit s'afficher correctement lors de la lecture de l'annonce linéaire. Vous pouvez vérifier ima.AdsManager.isCustomClickTrackingUsed lorsque l'événement ima.AdEvent.Type.STARTED est déclenché pour déterminer si vous devez afficher votre élément de suivi des clics personnalisé. Si cela convient à votre interface utilisateur, vous devez masquer l'élément de suivi des clics lorsque l'événement ima.AdEvent.Type.CONTENT_RESUME_REQUESTED se déclenche. La valeur ne doit pas être nulle. |
Méthodes
destroy
détruire()
Détruit l'état interne et les éléments DOM créés précédemment. Le SDK IMA sera déchargé et aucun autre appel à des API ne devra être effectué.
initialize
initialize()
Initialise les éléments vidéo internes pour la lecture. Vous devez appeler cette méthode en réponse à une action de l'utilisateur afin que le navigateur puisse marquer l'élément vidéo comme initié par l'utilisateur.
Certains navigateurs autorisent la lecture de la vidéo sans interaction de l'internaute si le son est désactivé. Pour ce comportement, utilisez AdsRequest.setAdWillPlayMuted(true) et appelez cette méthode avant AdsManager.start().