Classe: Ad

google.ima.Annonce

class   static

Classe d'annonce développée par des classes représentant différents types d'annonces.

Méthodes

getAdId

getAdId() renvoie la chaîne

L'identifiant de l'annonce permet de synchroniser l'annonce principale et les annonces associées.

Renvoie

string ID de l'annonce, ou chaîne vide si ces informations ne sont pas disponibles.

getAdPodInfo

La méthode getAdPodInfo() renvoie AdPodInfo.

Renvoie les informations sur la série d'annonces de l'annonce.

Renvoie

non-null AdPodInfo Informations sur la série d'annonces de l'annonce.

getAdSystem

La fonction getAdSystem() renvoie une chaîne.

Informations sur l'ad server source incluses dans la réponse d'annonce.

Renvoie

string : ad server source de l'annonce ou chaîne vide si ces informations ne sont pas disponibles.

getNomAnnonceur

La méthode getAnnonceurName() renvoie une chaîne.

Nom de l'annonceur, tel que défini par le tiers actif.

Renvoie

string Nom de l'annonceur ou chaîne vide si ces informations ne sont pas disponibles.

getApiFramework

La méthode getApiFramework() renvoie la chaîne

Identifie l'API nécessaire à la diffusion de l'annonce. Cela correspond à l'apiFramework spécifié dans VAST.

Renvoie

nullable string Le framework de l'API doit exécuter l'annonce, ou la valeur "null" si ces informations ne sont pas disponibles.

getCompanionAds

getCompanionAds(adSlotWidth, adSlotHeight, paramètres) renvoie un tableau de CompanionAd non nul.

Récupère les annonces associées pour cette annonce en fonction de la taille de l'espace publicitaire associé. Les paramètres de sélection avancés sont éventuellement acceptés. Notez que cette méthode ne renvoie un tableau non vide que pour les instances d'annonces acquises ou après l'événement STARTED. Plus précisément, les annonces de l'événement LOADED renvoient un tableau vide.

Paramètre

Largeur de l'espace publicitaire

number (nombre)

Largeur de l'espace publicitaire associé.

Hauteur de l'annonce

number (nombre)

Hauteur de l'espace publicitaire associé.

paramètres

Facultatif

Paramètres des annonces associées

Paramètres de sélection des annonces associées.

La valeur ne doit pas être null.
Renvoie

non-null Array of non-null CompanionAd : tableau d'annonces associées correspondant aux paramètres et à la taille de l'espace publicitaire.

getContentType

La méthode getContentType() renvoie une chaîne.

Renvoie le type de contenu de la création actuellement sélectionnée ou une chaîne vide si aucune création n'est sélectionnée ou si le type de contenu n'est pas disponible. Pour les annonces linéaires, le type de contenu n'est disponible qu'après l'événement START, lorsque le fichier multimédia est sélectionné.

Renvoie

string : type de contenu (chaîne vide si non disponible).

getCreativeAdId

La méthode getCreativeAdId() renvoie une chaîne.

Renvoie le code ISCI (Industry Standard Commercial Identifier) d'une annonce, ou une chaîne vide si le code n'est pas disponible. Il s'agit de l'identifiant de l'annonce de la création dans la réponse VAST.

Renvoie

string 

getCreativeId

La méthode getCreativeId() renvoie une chaîne.

Récupère l'identifiant de la création sélectionnée pour l'annonce.

Renvoie

string ID de la création sélectionnée pour l'annonce, ou de la chaîne vide si ces informations ne sont pas disponibles.

getDealId

getDealId() renvoie la chaîne

Renvoie le premier ID d'accord présent dans la chaîne de wrapper pour l'annonce actuelle, en commençant par le haut. Renvoie la chaîne vide si celle-ci est indisponible.

Renvoie

string 

getDescription

La description getDescription() renvoie une chaîne.

Renvoie la description de cette annonce à partir de la réponse VAST.

Renvoie

string La description est vide si elle n'est pas spécifiée.

getDuration

La méthode getDuration() renvoie un nombre.

Renvoie la durée de la création sélectionnée, ou "-1" pour les créations non linéaires.

Renvoie

number : durée de la création sélectionnée en secondes (-1 si elle n'est pas linéaire).

getHeight

getHeight() renvoie le nombre

Renvoie la hauteur de la création non linéaire sélectionnée.

Renvoie

number Hauteur de la création non linéaire sélectionnée ou 0 pour une création linéaire.

getMediaUrl

getMediaUrl() renvoie la chaîne

Renvoie l'URL du fichier multimédia choisi dans l'annonce en fonction des paramètres de sélection de contenus multimédias actuellement utilisés. Renvoie la valeur "null" si ces informations ne sont pas disponibles. Disponible sur l'événement STARTED.

Renvoie

nullable string 

getMinSuggestedDuration

La fonction getMinSuggestedDuration() renvoie un nombre.

Renvoie la durée minimale suggérée en secondes pendant laquelle la création non linéaire doit être affichée. Renvoie -2 si la durée minimale suggérée est inconnue. Pour une création linéaire, elle renvoie l'intégralité de la durée de l'annonce.

Renvoie

number Durée minimale suggérée (en secondes) pour l'affichage d'une création.

getSkipTimeOffset

La fonction getSkipTimeOffset() renvoie un nombre

Durée de lecture en secondes avant que l'annonce ne devienne désactivable. -1 est renvoyé pour les annonces non désactivables ou si cette information n'est pas disponible.

Renvoie

number Décalage en secondes, ou -1

getSurveyUrl

getSurveyUrl() renvoie la chaîne

Affiche l'URL associée à l'enquête pour l'annonce donnée. Renvoie la valeur "null" si l'élément est indisponible.

Renvoie

nullable string 

getTitle

La fonction getTitle() renvoie la chaîne

Renvoie le titre de cette annonce dans la réponse VAST.

Renvoie

string Titre, s'il n'est pas spécifié.

getTraffickingParameters

La méthode getTraffickingParameters() renvoie un objet avec les propriétés de chaîne

Récupère les paramètres personnalisés associés à l'annonce au moment du trafficking.

Renvoie

non-null Object with string properties Mappage de clés de trafficking sur leurs valeurs, ou de l'objet vide si ces informations ne sont pas disponibles.

getTraffickingParametersString

getTraffickingParametersString() renvoie chaîne

Récupère les paramètres personnalisés associés à l'annonce au moment du trafficking. Renvoie une version de chaîne brute des paramètres analysés à partir de getTraffickingParameters.

Renvoie

string Paramètres de trafficking, ou chaîne vide si ces informations ne sont pas disponibles.

getUiElements

getUiElements() renvoie un tableau de chaînes

Renvoie les éléments d'interface utilisateur qui s'affichent lors de la lecture de cette annonce. Reportez-vous à UiElements pour connaître les éléments possibles du tableau renvoyé.

Renvoie

non-null Array of string Éléments d'interface utilisateur affichés

getUniversalAdIdRegistry

getUniversalAdIdRegistry() renvoie la chaîne

Registre associé au catalogue du UniversalAdId de la création sélectionnée pour l'annonce.

Obsolète
Utilisez plutôt ad.getUniversalAdIds()
Renvoie

string Renvoie la valeur du registre, ou "inconnu" s'il n'est pas disponible.

getUniversalAdIdValue

La fonction getUniversalAdIdValue() renvoie

Identifiant UniversalAdId de la création sélectionnée pour l'annonce.

Obsolète
Utilisez plutôt ad.getUniversalAdIds()
Renvoie

string Renvoie la valeur de l'ID ou "inconnu" s'il n'est pas disponible.

getUniversalAdIds

getUniversalAdIds() renvoie un tableau de valeurs UniversalAdIdInfo non nulles

Liste des UniversalAdId de la création sélectionnée pour l'annonce.

Renvoie

non-null Array of non-null UniversalAdIdInfo Renvoie la liste des identifiants universels des annonces qui s'appliquent à cette annonce.

getVastMediaBitrate

La méthode getVastMediaBitrate() renvoie le nombre

Une fois que la création et le fichier multimédia ont été sélectionnés par le SDK, le débit du fichier multimédia indiqué dans la réponse VAST est renvoyé.

Renvoie

number débit du fichier multimédia sélectionné ou 0.

getVastMediaHeight

La méthode getVastMediaHeight() renvoie le nombre

Renvoie la hauteur du média VAST de la création sélectionnée.

Renvoie

number Hauteur du média VAST de la création sélectionnée, ou valeur 0 si aucune n'est sélectionnée.

getVastMediaWidth

getVastMediaWidth() renvoie le nombre

Renvoie la largeur du média VAST de la création sélectionnée.

Renvoie

number La largeur du média VAST de la création sélectionnée ou la valeur 0 si aucune n'est sélectionnée.

getWidth

getWidth() renvoie un nombre

Renvoie la largeur de la création sélectionnée.

Renvoie

number Largeur de la création non linéaire sélectionnée ou 0 pour une création linéaire.

getWrapperAdId

getWrapperAdIds() renvoie un tableau de chaînes

ID des annonces wrapper. L'ID renvoyé commence à l'annonce intégrée (en interne) et traverse l'annonce wrapper externe. Un tableau vide est renvoyé en l'absence d'annonces wrapper.

Renvoie

non-null Array of string ID des annonces, à partir de l'annonce intégrée, ou un tableau vide en l'absence d'annonces wrapper.

getWrapperAdSystems

getWrapperAdSystems() renvoie un tableau de chaînes

Systèmes publicitaires utilisés pour les annonces wrapper. Les systèmes publicitaires renvoyés débutent au niveau de l'annonce intégrée et se dirigent vers l'annonce de wrapper la plus externe. Un tableau vide est renvoyé en l'absence d'annonces wrapper.

Renvoie

non-null Array of string : systèmes publicitaires, à partir de l'annonce intégrée, ou un tableau vide en l'absence d'annonces wrapper.

getWrapperCreativeIds

getWrapperCreativeIds() renvoie un tableau de chaînes

ID des créations sélectionnées utilisés pour les wrappers publicitaires. L'ID de création renvoyé commence par l'annonce intégrée et se dirige vers l'annonce de wrapper la plus externe. Un tableau vide est renvoyé en l'absence d'annonces wrapper.

Renvoie

non-null Array of string ID des créations, à partir de l'annonce intégrée, ou un tableau vide en l'absence d'annonces wrapper.

IsLinear

La fonction isLinear() renvoie une valeur booléenne

Indique si le mode de fonctionnement actuel de l'annonce est linéaire ou non linéaire. Si la valeur est "true", cela indique que l'annonce est en mode de lecture linéaire. Si la valeur est "false", cela indique le mode non linéaire. Le lecteur vérifie la propriété linéaire et met à jour son état en fonction des détails de l'emplacement d'annonce. Lorsque l'annonce est en mode linéaire, le lecteur met la vidéo en pause. Si une valeur linéaire est définie initialement sur "true" et que l'annonce est une annonce vidéo pré-roll (définie en externe), le lecteur peut choisir de différer le chargement du contenu vidéo jusqu'à la fin de la lecture de l'annonce.

Renvoie

boolean "True" si l'annonce est linéaire, sinon "false".