imagin.
L'espace de noms google.ima permet d'accéder aux classes, aux interfaces, aux énumérations et aux propriétés du SDK.
Classes
Annonce
Classe d'annonce développée par des classes représentant différents types d'annonces.
AdCuePoints
La liste des points de repère représente la planification des coupures publicitaires dans le temps. Notez que les annonces individuelles de la coupure publicitaire ne sont pas incluses dans le calendrier.
ConteneurDisplay
Cette classe représente un conteneur pour afficher des annonces. Le SDK crée automatiquement des structures dans le paramètre containerElement pour héberger des annonces vidéo et en superposition.
Lorsqu'une instance de cette classe est créée, elle crée un cadre iFrame dans 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é lues 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 faisant partie du DOM. Il est nécessaire de positionner correctement containerElement pour que les annonces s'affichent correctement. Nous vous recommandons de le placer au-dessus du lecteur vidéo du contenu et de le dimensionner pour qu'il couvre l'ensemble du lecteur vidéo. Consultez la documentation du SDK pour en savoir plus sur les implémentations recommandées.
Remarque:Il est toujours nécessaire d'appeler la méthode initialize() dans le code qui a été appelé directement par une action de l'utilisateur (un clic ou une pression, par exemple).
AdError
AdError indique à l'utilisateur si un échec s'est produit lors du chargement ou de la lecture de l'annonce. L'accesseur errorType indique si l'erreur s'est produite lors du chargement ou de la lecture de l'annonce.
Événement d'erreur
Cet événement est généré lorsqu'une erreur se produit lors du chargement d'une annonce à partir des serveurs Google ou DoubleClick. Les types sur lesquels vous pouvez vous inscrire à l'événement sont AdsLoader et AdsManager.
Événement publicitaire
Ce type d'événement est généré par l'annonce sous forme de notification lorsque l'état de l'annonce change et que les utilisateurs interagissent avec elle. Il peut s'agir, par exemple, d'un clic sur l'annonce, etc. Vous pouvez vous inscrire aux différents événements de changement d'état dans Ads Manager.
Événement AdMetadata
Ce cours est obsolète. Utilisez l'API AdsManager.getCuePoints(). Un événement publicitaire spécifique comportant des métadonnées.
AdPodInfo.
Une série d'annonces peut faire partie d'une annonce. Cet objet expose les métadonnées associées à cette série d'annonces, telles que le nombre d'annonces et la position des annonces dans la série d'annonces.
L'API getTotalAds contenue dans cet objet est souvent correcte, mais dans certains cas, elle représente la meilleure estimation du SDK. Pour en savoir plus, consultez la documentation de cette méthode.
Données AdProgress
Cet objet fournit des informations sur la progression actuelle dans une annonce.
AdsLoader
AdsLoader permet aux clients de demander des annonces aux ad servers. Pour ce faire, les utilisateurs doivent s'inscrire à l'événement AdsManagerLoadedEvent, puis demander des annonces.
AdsManager
Fournit l'API publique externe à l'éditeur et communique avec l'instance interne du gestionnaire d'annonces.
AdsManagerLoadedEvent.
Cet événement est généré lorsque les annonces sont correctement chargées à partir des ad servers Google ou DoubleClick via AdsLoader. Vous pouvez vous inscrire à cet événement sur AdsLoader.
AdsAdsSettings
Définit les paramètres qui contrôlent l'affichage des annonces.
AdsRequest
Classe permettant de spécifier les propriétés de la demande d'annonce.
Annonce associée
Représente une annonce associée.
CompanionAdSelectionSettings (Paramètres de l'annonce associée)
L'objet CompanionAdSelectionSettings permet de définir les critères de sélection lorsque vous appelez la fonction ima.Ad.getCompanionAds.
Paramètres ImaSdk
Cette classe contient des paramètres à l'échelle du SDK.
UniversalAdIdInfo.
Cet objet fournit des informations sur l'identifiant d'annonce universel associé à la création, y compris la valeur de l'identifiant de l'annonce et le registre de l'identifiant de l'annonce.
Énumérations
Mode accèsOmid
string
Modes d'accès disponibles pour OMID pour le Web, qui contrôlent le niveau d'accès du script de validation.
Valeur |
|
|---|---|
|
LIMITÉ |
Le script de validation est mis en bac à sable et ne peut pas accéder à la création ni à la page de l'éditeur. Il ne peut pas confirmer directement le domaine de l'éditeur sur lequel il se trouve. |
|
DOMAIN |
Le script de validation est exécuté en bac à sable et ne peut pas accéder à la création ni à la page de l'éditeur. Toutefois, le script est chargé de manière à confirmer directement le domaine de l'éditeur sur lequel il se trouve. |
|
FULL |
Le script de validation a un accès direct à la création et à la page de l'éditeur. |
Fournisseur de validation
number (nombre)
Identifie un fournisseur de validation OMID. Les fournisseurs sont classés par ordre alphabétique.
Valeur |
|
|---|---|
|
SCORE |
|
|
VALIDER PLUS |
|
|
|
|
|
INTEGRAL_AD_SCIENCE |
|
|
MÉTRIQUES |
|
|
MOAT |
|
|
NIELSEN |
|
|
PIXELATE |
|
|
AUTRE |
Fournisseur par défaut à utiliser lorsque l'URL de script ne correspond à aucun autre fournisseur. |
Éléments d'interface utilisateur
string
Énumération spécifiant différents éléments d'interface utilisateur qui peuvent être configurés pour être affichés ou masqués. Ces paramètres peuvent être ignorés pour les annonces AdSense et ADX.
Valeur |
|
|---|---|
|
AD_ATTRIBUTION |
Affiche le texte "Annonce" dans l'interface utilisateur. Doit être présent pour afficher le compte à rebours. |
|
COUNTDOWN |
L'attribution d'annonce est obligatoire pour qu'un compte à rebours s'affiche. |
Mode Vue
string
Énumération spécifiant différents modes d'affichage VPAID pour les annonces.
Valeur |
|
|---|---|
|
NORMALE |
Mode de visionnage de l'annonce normal |
|
Plein écran |
Mode d'affichage des annonces en plein écran. Indique au gestionnaire d'annonces que l'accord actuel AdDisplayContainer est considéré comme plein écran (par exemple, une simulation en plein écran). Le gestionnaire d'annonces ne passe pas en plein écran. |
- Obsolète
Propriétés
Mode accèsOmid
string
Modes d'accès disponibles pour OMID pour le Web, qui contrôlent le niveau d'accès du script de validation.
Valeur |
|
|---|---|
|
LIMITÉ |
Le script de validation est mis en bac à sable et ne peut pas accéder à la création ni à la page de l'éditeur. Il ne peut pas confirmer directement le domaine de l'éditeur sur lequel il se trouve. |
|
DOMAIN |
Le script de validation est exécuté en bac à sable et ne peut pas accéder à la création ni à la page de l'éditeur. Toutefois, le script est chargé de manière à confirmer directement le domaine de l'éditeur sur lequel il se trouve. |
|
FULL |
Le script de validation a un accès direct à la création et à la page de l'éditeur. |
Fournisseur de validation
number (nombre)
Identifie un fournisseur de validation OMID. Les fournisseurs sont classés par ordre alphabétique.
Valeur |
|
|---|---|
|
SCORE |
|
|
VALIDER PLUS |
|
|
|
|
|
INTEGRAL_AD_SCIENCE |
|
|
MÉTRIQUES |
|
|
MOAT |
|
|
NIELSEN |
|
|
PIXELATE |
|
|
AUTRE |
Fournisseur par défaut à utiliser lorsque l'URL de script ne correspond à aucun autre fournisseur. |
Éléments d'interface utilisateur
string
Énumération spécifiant différents éléments d'interface utilisateur qui peuvent être configurés pour être affichés ou masqués. Ces paramètres peuvent être ignorés pour les annonces AdSense et ADX.
Valeur |
|
|---|---|
|
AD_ATTRIBUTION |
Affiche le texte "Annonce" dans l'interface utilisateur. Doit être présent pour afficher le compte à rebours. |
|
COUNTDOWN |
L'attribution d'annonce est obligatoire pour qu'un compte à rebours s'affiche. |
Mode Vue
string
Énumération spécifiant différents modes d'affichage VPAID pour les annonces.
Valeur |
|
|---|---|
|
NORMALE |
Mode de visionnage de l'annonce normal |
|
Plein écran |
Mode d'affichage des annonces en plein écran. Indique au gestionnaire d'annonces que l'accord actuel AdDisplayContainer est considéré comme plein écran (par exemple, une simulation en plein écran). Le gestionnaire d'annonces ne passe pas en plein écran. |
- Obsolète
paramètres
paramètres ImaSdkSettings non nuls
Instance globale des paramètres singleton.