Classe: ImaSdkSettings

google.ima.ImaSdkSettings

class public static

Cette classe contient des paramètres à l'échelle du SDK.

Énumérations

Mode de remplissage associé

constante statique

string

Définit un ensemble de constantes pour le paramètre des annonces de remplissage associées. Ce paramètre indique si les annonces associées doivent être remplies dans divers scénarios.

Si la valeur est ALWAYS, une annonce de remplissage associée est tentée dans toutes les situations, même lorsqu'aucune annonce principale n'est renvoyée.

Si la valeur est ON_MASTER_AD, le remplissage d'une annonce associée est tenté s'il existe une annonce principale en contenant moins que le nombre d'emplacements associés. Les annonces associées manquantes seront remplacées.

La valeur par défaut est ALWAYS.

Notez que pour utiliser des créations de remplacement associées côté client, vous devez ajouter correctement un tag Google Publisher Tag (GPT) à vos créations associées. Pour activer les annonces de remplissage, vous devez apporter les modifications suivantes à la configuration GPT standard : 
...
let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div');
slot1.addService(googletag.companionAds()).addService(googletag.pubads());
...
googletag.companionAds().setRefreshUnfilledSlots(true);
...
googletag.enableServices();
Pour les vidéos en lecture automatique, il est recommandé d'apporter les modifications supplémentaires suivantes afin d'empêcher le préchargement des espaces associés, puis leur remplacement immédiat. 
googletag.pubads().disableInitialLoad();
...
googletag.enableServices();

Valeur

TOUJOURS

ON_MASTER_AD

Mode VPAID

constante statique

number (nombre)

Ensemble de constantes permettant d'activer la fonctionnalité VPAID.

Valeur

DÉSACTIVÉE

Les annonces VPAID ne sont pas diffusées et une erreur est renvoyée.

ACTIVÉ

Les annonces VPAID sont activées à l'aide d'un cadre iFrame interdomaine. L'annonce VPAID ne peut pas accéder au site. Les annonces VPAID qui dépendent d'un accès iFrame convivial peuvent générer une erreur. Il s'agit de la valeur par défaut.

NON SÉCURISÉ

Les annonces VPAID sont activées à l'aide d'un iFrame convivial. Cela permet à l'annonce d'accéder au site via JavaScript.

Propriétés

Mode de remplissage associé

constante statique

string

Définit un ensemble de constantes pour le paramètre des annonces de remplissage associées. Ce paramètre indique si les annonces associées doivent être remplies dans divers scénarios.

Si la valeur est ALWAYS, une annonce de remplissage associée est tentée dans toutes les situations, même lorsqu'aucune annonce principale n'est renvoyée.

Si la valeur est ON_MASTER_AD, le remplissage d'une annonce associée est tenté s'il existe une annonce principale en contenant moins que le nombre d'emplacements associés. Les annonces associées manquantes seront remplacées.

La valeur par défaut est ALWAYS.

Notez que pour utiliser des créations de remplacement associées côté client, vous devez ajouter correctement un tag Google Publisher Tag (GPT) à vos créations associées. Pour activer les annonces de remplissage, vous devez apporter les modifications suivantes à la configuration GPT standard : 
...
let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div');
slot1.addService(googletag.companionAds()).addService(googletag.pubads());
...
googletag.companionAds().setRefreshUnfilledSlots(true);
...
googletag.enableServices();
Pour les vidéos en lecture automatique, il est recommandé d'apporter les modifications supplémentaires suivantes afin d'empêcher le préchargement des espaces associés, puis leur remplacement immédiat. 
googletag.pubads().disableInitialLoad();
...
googletag.enableServices();

Valeur

TOUJOURS

ON_MASTER_AD

Mode VPAID

constante statique

number (nombre)

Ensemble de constantes permettant d'activer la fonctionnalité VPAID.

Valeur

DÉSACTIVÉE

Les annonces VPAID ne sont pas diffusées et une erreur est renvoyée.

ACTIVÉ

Les annonces VPAID sont activées à l'aide d'un cadre iFrame interdomaine. L'annonce VPAID ne peut pas accéder au site. Les annonces VPAID qui dépendent d'un accès iFrame convivial peuvent générer une erreur. Il s'agit de la valeur par défaut.

NON SÉCURISÉ

Les annonces VPAID sont activées à l'aide d'un iFrame convivial. Cela permet à l'annonce d'accéder au site via JavaScript.

Méthodes

getCompanionBackfill

getCompanionBackfill() renvoie CompanionBackfillMode

Renvoie le mode de remplissage associé actuel.

Renvoie

non-null CompanionBackfillMode Valeur actuelle.

getDisableCustomPlaybackForIOS10Plus

La méthode getDisableCustomPlaybackForIOS10Plus() renvoie une valeur booléenne

Détermine si la lecture personnalisée doit être désactivée sur les navigateurs iOS 10 et versions ultérieures. La valeur par défaut est "false".

Renvoie

boolean 

getFeatureFlags

getFeatureFlags() renvoie l'objet avec n'importe quelle propriété de type

Renvoie un objet avec les clés en tant qu'indicateurs de caractéristiques et les valeurs en tant qu'état actuel.

Renvoie

non-null Object with any type properties 

getLocale

La fonction getLocale() renvoie la chaîne

Renvoie les paramètres régionaux fournis par l'éditeur.

Renvoie

string Paramètres régionaux fournis par l'éditeur.

getNumRedirects

La fonction getNumRedirects() renvoie les valeurs suivantes :

Renvoie le nombre maximal de redirections pour les redirections suivantes.

Renvoie

number : nombre maximal de redirections.

getPlayerType (getPlayerType)

La fonction getPlayerType() renvoie la chaîne

Renvoie le type de joueur fourni par le partenaire.

Renvoie

string Type de lecteur partenaire.

getPlayerVersion

getPlayerVersion() affiche la chaîne

Renvoie la version du lecteur fournie par le partenaire.

Renvoie

string Version du lecteur partenaire

getPpid

getPpid() returns (null ou chaîne)

Renvoie l'ID fourni par l'éditeur.

Renvoie

(null or string) ID fourni par l'éditeur.

IsCookiesEnabled

isCookiesEnabled() renvoie une valeur booléenne

Renvoie

boolean Indique si l'éditeur autorise l'utilisation des cookies.

setAutoPlayAdBreaks

setAutoPlayAdBreaks(autoPlayAdBreaks) renvoie void

Détermine si les coupures publicitaires VMAP et liées aux règles relatives aux annonces sont lues automatiquement

Paramètre

autoPlayAdBreaks

booléen

Lire automatiquement ou non les coupures publicitaires.
Renvoie

void 

setCompanionBackfill

setCompanionBackfill(mode) renvoie void

Définit le mode de remplissage associé. Consultez les différents modes disponibles dans ImaSdkSettings.CompanionBackfillMode.

Le mode par défaut est ImaSdkSettings.CompanionBackfillMode.ALWAYS.

Paramètre

mode

Mode de remplissage associé

Mode de remplissage associé sélectionné.

La valeur ne doit pas être nulle.
Renvoie

void 

setCookiesEnabled

setCookiesEnabled(cookiesEnabled) renvoie void

Indique si le SDK doit stocker un cookie Google Ad Manager (cookie GFP) sur le domaine de l'éditeur en tant que cookie propriétaire. Cela permet la persistance de plusieurs visites sur le même domaine sans utiliser de cookies tiers. Valeur par défaut : true.

Ce paramètre n'aura aucune incidence sur les autres cookies qui peuvent être définis par d'autres parties ou à d'autres fins. Le consentement de l'utilisateur et la désactivation peuvent également désactiver l'utilisation des cookies propriétaires. Elles seront récupérées par l'éditeur qui utilise un fournisseur de gestion du consentement conforme aux règles de l'IAB, s'il se trouve dans le même cadre.

Paramètre

cookies activés

booléen
Renvoie

void 

setDisableCustomPlaybackForIOS10Plus

setDisableCustomPlaybackForIOS10Plus(disable) renvoie void

Détermine si la lecture personnalisée doit être désactivée sur les navigateurs iOS 10 et versions ultérieures. Si la valeur est "true", les annonces sont lues de manière intégrée si le contenu vidéo est intégré. Les annonces désactivables TrueView sont ainsi activées. Toutefois, l'annonce reste intégrée et n'est pas compatible avec le mode plein écran natif d'iOS. Si la valeur est "false", les annonces sont diffusées dans le même lecteur que votre contenu. La valeur définie ici lorsqu'un AdDisplayContainer est créé est utilisée pendant la durée de vie du conteneur. La valeur par défaut est "false".

Paramètre

désactiver

booléen

Désactiver ou non la lecture personnalisée.
Renvoie

void 

setFeatureFlags

setFeatureFlags(featureFlags) renvoie void

Définissez la valeur de tous les indicateurs de caractéristiques. Ce paramètre doit être défini dès que possible avant de demander des annonces. Les paramètres restent identiques jusqu'à la prochaine demande d'annonce. Si vous appelez à nouveau cette méthode, tous les commutateurs de fonctionnalité seront réinitialisés pour la prochaine demande d'annonce.

Paramètre

commutateurs de fonctionnalités

Objet avec n'importe quelle propriété de type

La valeur ne doit pas être nulle.
Renvoie

void 

setLocale

setLocale(locale) renvoie void

Définit les paramètres régionaux fournis par l'éditeur. Doit être appelé avant la création d'AdsLoader ou d'AdDisplayContainer. Les paramètres régionaux spécifient la langue d'affichage des éléments de l'interface utilisateur. Les codes compatibles sont disponibles dans la section Localisation pour la langue et les paramètres régionaux.

Paramètre

locale

string

Paramètres régionaux fournis par l'éditeur.
Renvoie

void 

setNumRedirects

setNumRedirects(numRedirects) returns void

Spécifie le nombre maximal de redirections avant que les redirections suivantes soient refusées et que le chargement de l'annonce soit annulé. Le nombre de redirections affecte directement la latence et donc l'expérience utilisateur. Cela s'applique à toutes les annonces wrapper VAST.

Paramètre

Nombre de redirections

number (nombre)

le nombre maximal de redirections.
Renvoie

void 

définirPlayerType

setPlayerType(playerType) returns void

Définit le type de joueur fourni par le partenaire. Ce paramètre permet de spécifier le nom du lecteur intégré au SDK. Si le type de lecteur est supérieur à 20 caractères, il sera tronqué. Le type de lecteur spécifié doit être court et unique. Ce paramètre facultatif permet d'améliorer la facilité d'utilisation du SDK en suivant les types de joueurs.

Exemple : 


settings.setPlayerType('google/gmf-player');

Paramètre

lecteur

string

Type de lecteur partenaire.
Renvoie

void 

setPlayerVersion

setPlayerVersion(playerVersion) returns void

Définit la version du lecteur fournie par le partenaire. Ce paramètre permet de spécifier la version du lecteur partenaire intégrée au SDK. Les versions de lecteur supérieures à 20 caractères seront tronquées. Ce paramètre facultatif permet d'améliorer la facilité d'utilisation du SDK en suivant la version du lecteur.

Exemple : 


settings.setPlayerVersion('1.0.0');

Paramètre

lecteurVersion

string

Version du lecteur partenaire.
Renvoie

void 

setPpid

setPpid(ppid) renvoie void

Définit l'ID fourni par l'éditeur.

Paramètre

ppid

string

ID fourni par l'éditeur.
Renvoie

void 

setSessionId

setSessionId(sessionId) renvoie void

L'ID de session est un ID aléatoire temporaire. Elle est utilisée exclusivement pour la limitation de la fréquence d'exposition. Un ID de session doit être un UUID.

Paramètre

sessionId

string

UUID temporaire utilisé pour la limitation de la fréquence d'exposition.
Renvoie

void 

setVpaidAllowed

setVpaidAllowed(allowVpaid) returns void

Obsolète. Utilisez setVpaidMode. Indique si les créations VPAID sont autorisées.

Paramètre

allowVpaid

booléen

Autoriser ou non les créations VPAID.
Renvoie

void 

setVpaidMode

setVpaidMode(vpaidMode) return void

Définir le mode de lecture VPAID

Paramètre

Mode VPAID

Mode VPAID

Ce paramètre permet de définir le mode de lecture des annonces VPAID. Le mode sécurisé est défini par défaut.

La valeur ne doit pas être nulle.
Renvoie

void