google. ima. AdsManager
Fournit l'API publique externe à l'éditeur et communique avec l'instance interne du gestionnaire d'annonces.
Méthodes
réduire
collapse()
Réduisez l'annonce actuelle. Cette opération n'est pas possible pour le SDK HTML5.
configureAdsManager
configureAdsManager(content, adsRenderingSettings)
Définit les paramètres requis pour obtenir une référence à cet AdManager à partir de l'événement AdsManagerLoaded.
Paramètre |
|
---|---|
contenu |
Objet Objet qui lit le contenu de l'éditeur. La valeur ne doit pas être nulle. |
paramètres de rendu des annonces |
Facultative AdsRenderingSettings Paramètres facultatifs permettant de contrôler l'affichage des annonces. La valeur peut être nulle. |
destroy
détruire()
Supprime les assets d'annonce chargés au moment de l'exécution qui doivent être correctement supprimés une fois l'annonce terminée et arrête l'annonce et tout le suivi.
supprimer la coupure publicitaire
ignoreAdBreak()
Si une coupure publicitaire est en cours de lecture, supprimez-la et réactivez le contenu. Sinon, ignorez la prochaine coupure publicitaire planifiée. Par exemple, elle peut être appelée immédiatement après le chargement du gestionnaire d'annonces pour ignorer une annonce vidéo pré-roll sans perdre les annonces mid-roll ou post-roll futures. Il s'agit d'une opération no-op, sauf si la demande d'annonce a renvoyé une playlist ou une réponse VMAP.
expand
expand()
Développez l'annonce actuelle. Cette opération n'est pas possible pour le SDK HTML5.
concentration
focus()
Placer le curseur sur le bouton "Ignorer" (s'il est présent) Sinon, il met l'accent sur les éléments interactifs, comme les icônes ou les créations interactives.
getAdskippableState
La fonction getAdskippableState() renvoie une valeur booléenne
Renvoie la valeur "true" si l'annonce peut être ignorée. Lorsque cette valeur change, AdsManager
déclenche un événement AdEvent.SKIPPABLE_STATE_CHANGED
.
- Renvoie
-
boolean
"True" si l'annonce peut être ignorée, false dans le cas contraire.
getCuePoints
La fonction getCuePoints() renvoie un tableau de nombres.
Renvoie un tableau de décalages en secondes indiquant le moment où une coupure publicitaire planifiée va être lancée. Une annonce vidéo pré-roll est représentée par 0 et une annonce vidéo post-roll par -1. Un tableau vide indique que l'annonce ou la série d'annonces ne sont pas programmées et peuvent être lues à tout moment.
- Renvoie
-
non-null Array of number
Liste des décalages temporels en secondes.
getRemainingTime
getrestTime() renvoie le numéro
Obtenir la durée restante de l'annonce en cours de lecture Si l'annonce n'est pas encore chargée ou si sa lecture est terminée, l'API renvoie -1.
- Renvoie
-
number
Renvoie le temps restant pour l'annonce actuelle. Si le temps restant n'est pas défini pour l'annonce actuelle (par exemple, les annonces personnalisées), la valeur renvoyée est -1.
getVolume
La fonction getVolume() renvoie le numéro
Obtenez le volume de l'annonce actuelle.
- Renvoie
-
number
Volume de l'annonce en cours, compris entre 0 (avec le son désactivé) et 1 (le plus fort).
init
init(width, height, viewMode, videoElement)
Appelez la méthode "init" pour initialiser l'expérience publicitaire dans le gestionnaire d'annonces.
Paramètre |
|
---|---|
largeur |
number (nombre) Largeur choisie pour l'annonce. |
hauteur |
number (nombre) La hauteur choisie pour l'annonce. |
mode Vue |
Mode Vue Mode d'affichage choisi. La valeur ne doit pas être nulle. |
élément vidéo |
Facultative HTMLVideoElement Élément vidéo pour la lecture personnalisée. Cet élément vidéo remplace celui fourni dans le constructeur AdDisplayContainer. N'utilisez cette propriété que si c'est absolument nécessaire. Sinon, nous vous recommandons de spécifier cet élément vidéo lors de la création du conteneur AdDisplayContainer. La valeur peut être nulle. |
IsCustomClickTrackingUsed
isCustomClickTrackingUsed() renvoie des valeurs booléennes
Renvoie la valeur "true" si un élément de suivi des clics personnalisé est utilisé pour le suivi des clics sur l'annonce actuelle. Le suivi des clics personnalisé n'est utilisé que lorsqu'un élément de suivi des clics facultatif est fourni à AdDisplayContainer
, que la lecture personnalisée est utilisée et que l'annonce actuelle n'est pas une annonce AdSense/AdX.
- Renvoie
-
boolean
Indique si le suivi des clics personnalisé est utilisé.
IsCustomPlaybackUsed
isCustomPlaybackUsed() renvoie des valeurs booléennes
Renvoie la valeur "true" si un élément vidéo personnalisé est utilisé pour lire l'annonce en cours. La lecture personnalisée se produit lorsqu'un élément vidéo facultatif est fourni au AdDisplayContainer
sur les plates-formes où un élément vidéo personnalisé lui permettrait d'afficher l'annonce de façon plus fluide.
- Renvoie
-
boolean
Indique si la lecture personnalisée est utilisée.
pause
pause()
Met en veille l'annonce en cours de lecture. Cette fonction est no-op lorsqu'une superposition statique est affichée, ou que l'annonce n'est pas encore chargée ou que sa lecture est terminée.
resize
redimensionner(largeur, hauteur, mode d'affichage)
Redimensionne l'annonce actuelle.
Paramètre |
|
---|---|
largeur |
number (nombre) Nouvelle largeur de l'espace publicitaire. |
hauteur |
number (nombre) Nouvelle hauteur de l'espace publicitaire. |
mode Vue |
Mode Vue Nouveau mode Vue La valeur ne doit pas être nulle. |
resume
CV()
Réactive l'annonce actuellement chargée et mise en veille. Cette fonction est "no-op" lorsqu'une superposition statique est affichée, ou que l'annonce n'est pas encore chargée ou que sa lecture est terminée.
Régler le volume
setVolume(volume)
Réglez le volume de l'annonce actuelle.
Paramètre |
|
---|---|
volume |
number (nombre) Volume à définir, de 0 (muet) à 1 (le plus fort). |
ignorer
ignorer()
Ignore l'annonce actuelle lorsque la valeur de AdsManager.getAdSkippableState()
est "true". Lorsqu'elle est appelée dans d'autres cas, l'action Ignorer n'a aucun effet. Une fois le saut terminé, AdsManager
déclenche un événement AdEvent.SKIPPED
.
démarrer
start()
Commencez à diffuser les annonces.
Les développeurs doivent d'abord appeler AdDisplayContainer.initialize()
.
stop
stop()
Arrête la lecture des annonces. Si vous appelez cette méthode, l'éditeur reprendra le contenu.
updateAdsRenderingSettings
updateAdsRenderingSettings(adsRenderingSettings)
Met à jour les paramètres d'affichage des annonces. Elle doit être utilisée spécifiquement pour les cas d'utilisation VMAP entre les coupures publicitaires lorsque les paramètres d'affichage des annonces tels que le débit doivent être mis à jour.
Paramètre |
|
---|---|
paramètres de rendu des annonces |
AdsRenderingSettings Paramètres de rendu des annonces mis à jour. La valeur ne doit pas être nulle. |