Clase: ImaSdkSettings

google.ima.Configuración de ImaSdk

class public static

Esta clase contiene la configuración de todo el SDK.

Enumeraciones

Modo de relleno complementario

constante estática

string

Define un conjunto de constantes para la configuración de reabastecimiento complementario. Esta configuración indica si los complementarios deben reabastecerse en varias situaciones.

Si el valor es ALWAYS, el reabastecimiento complementario se intentará en todas las situaciones, incluso cuando no se muestre un anuncio principal.

Si el valor es ON_MASTER_AD, se intentará el reabastecimiento complementario si hay un anuncio principal con menos anuncios complementarios que los espacios complementarios. Los compañeros faltantes se reabastecerán.

El valor predeterminado es ALWAYS.

Ten en cuenta que el reabastecimiento complementario del cliente requiere que se etiqueten correctamente con una Google Publisher Tag (GPT). Para habilitar el reabastecimiento, se requieren los siguientes cambios en la configuración estándar de GPT: 
...
let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div');
slot1.addService(googletag.companionAds()).addService(googletag.pubads());
...
googletag.companionAds().setRefreshUnfilledSlots(true);
...
googletag.enableServices();
En el caso de los videos de reproducción automática, se recomienda el siguiente cambio adicional a fin de evitar que se carguen previamente las ranuras complementarias y que se reemplacen de inmediato por las creatividades complementarias. 
googletag.pubads().disableInitialLoad();
...
googletag.enableServices();

Valor

SIEMPRE

ON_MASTER_AD

Modo de pago pagado

constante estática

número

Un conjunto de constantes para habilitar la funcionalidad de VPAID.

Valor

INHABILITADA

No se reproducirán los anuncios de VPAID y se mostrará un error.

HABILITADO

Los anuncios VPAID se habilitan mediante un iframe multidominio. El anuncio de VPAID no puede acceder al sitio. Los anuncios de VPAID que dependen del acceso de iframe compatible pueden fallar. Esta es la opción predeterminada.

SEGURIDAD

Los anuncios VPAID se habilitan con un iframe compatible. Esto permite que el anuncio acceda al sitio a través de JavaScript.

Propiedades

Modo de relleno complementario

constante estática

string

Define un conjunto de constantes para la configuración de reabastecimiento complementario. Esta configuración indica si los complementarios deben reabastecerse en varias situaciones.

Si el valor es ALWAYS, el reabastecimiento complementario se intentará en todas las situaciones, incluso cuando no se muestre un anuncio principal.

Si el valor es ON_MASTER_AD, se intentará el reabastecimiento complementario si hay un anuncio principal con menos anuncios complementarios que los espacios complementarios. Los compañeros faltantes se reabastecerán.

El valor predeterminado es ALWAYS.

Ten en cuenta que el reabastecimiento complementario del cliente requiere que se etiqueten correctamente con una Google Publisher Tag (GPT). Para habilitar el reabastecimiento, se requieren los siguientes cambios en la configuración estándar de GPT: 
...
let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div');
slot1.addService(googletag.companionAds()).addService(googletag.pubads());
...
googletag.companionAds().setRefreshUnfilledSlots(true);
...
googletag.enableServices();
En el caso de los videos de reproducción automática, se recomienda el siguiente cambio adicional a fin de evitar que se carguen previamente las ranuras complementarias y que se reemplacen de inmediato por las creatividades complementarias. 
googletag.pubads().disableInitialLoad();
...
googletag.enableServices();

Valor

SIEMPRE

ON_MASTER_AD

Modo de pago pagado

constante estática

número

Un conjunto de constantes para habilitar la funcionalidad de VPAID.

Valor

INHABILITADA

No se reproducirán los anuncios de VPAID y se mostrará un error.

HABILITADO

Los anuncios VPAID se habilitan mediante un iframe multidominio. El anuncio de VPAID no puede acceder al sitio. Los anuncios de VPAID que dependen del acceso de iframe compatible pueden fallar. Esta es la opción predeterminada.

SEGURIDAD

Los anuncios VPAID se habilitan con un iframe compatible. Esto permite que el anuncio acceda al sitio a través de JavaScript.

Métodos

ObtenerRelleno complementario

getCompanionBackfill() muestra CompanionBackfillMode

Muestra el modo actual de reabastecimiento complementario.

Resultado que se muestra

non-null CompanionBackfillMode El valor actual.

getDisableCustomPlaybackForIOS10Plus

getDisableCustomPlaybackForIOS10Plus() muestra un valor booleano

Obtiene si se inhabilita la reproducción personalizada en navegadores con iOS 10 o versiones posteriores. El valor predeterminado es falso.

Resultado que se muestra

boolean 

getFeatureFlags

getFeatureFlags() muestra el objeto con cualquier propiedad de tipo

Muestra un objeto con claves como marcas de función y valores como su estado actual.

Resultado que se muestra

non-null Object with any type properties 

getLocale

getLocale() muestra una string

Muestra la configuración regional que proporcionó el publicador.

Resultado que se muestra

string Configuración regional proporcionada por el publicador.

getNumRedirects

getNumRedirects() muestra el número

Muestra la cantidad máxima de redireccionamientos para los redireccionamientos subsiguientes.

Resultado que se muestra

number la cantidad máxima de redireccionamientos.

getPlayerType

getPlayerType() muestra la string

Muestra el tipo de reproductor proporcionado por el socio.

Resultado que se muestra

string Tipo de reproductor asociado.

getPlayerVersion.

getPlayerVersion() muestra una string

Muestra la versión de reproductor proporcionada por el socio.

Resultado que se muestra

string Versión de reproductor para socios.

getPpid;

getPpid() (nulo o string)

Muestra el ID proporcionado por el publicador.

Resultado que se muestra

ID proporcionado por el publicador de (null or string).

Las cookies están habilitadas

isCookiesEnabled() muestra un booleano

Resultado que se muestra

boolean Indica si el publicador permite el uso de cookies.

setAutoPlayAdBreaks

setAutoPlayAdBreaks(autoPlayAdBreaks) muestra void

Establece si las pausas publicitarias de VMAP y de reglas de anuncios se reproducen automáticamente

Parámetro

pausas publicitarias de Play

boolean

Indica si se debe reproducir automáticamente las pausas publicitarias.
Resultado que se muestra

void 

setBackBackBack

setCompanionBackfill(mode) devuelve void

Establece el modo de reabastecimiento complementario. Consulta los distintos modos disponibles en ImaSdkSettings.CompanionBackfillMode.

El modo predeterminado es ImaSdkSettings.CompanionBackfillMode.ALWAYS.

Parámetro

medio

Modo de relleno complementario

El modo de reabastecimiento complementario elegido

El valor no debe ser nulo.
Resultado que se muestra

void 

setCookiesEnabled

setCookiesEnabled(cookiesEnabled) devuelve void

Indica si el SDK debe almacenar una cookie de Google Ad Manager (GFP Cookie) en el dominio del publicador como una cookie propia. Esto permite la persistencia en varias visitas al mismo dominio sin usar las cookies de terceros. El valor predeterminado es verdadero.

Esta configuración no afectará a otras cookies que otras partes pudiesen establecer o que tengan otros fines. El consentimiento y la inhabilitación de los usuarios también pueden inhabilitar el uso de cookies propias. Se retirarán si el publicador usa un proveedor de administración de consentimiento que cumple con la IAB, si está en el mismo marco.

Parámetro

cookies habilitadas

boolean
Resultado que se muestra

void 

setDisableCustomPlaybackForIOS10Plus

setDisableCustomPlaybackForIOS10Plus(disable) devuelve void

Establece si se inhabilita la reproducción personalizada en navegadores con iOS 10 y versiones posteriores. Si es verdadero, los anuncios se reproducirán de forma intercalada si el video de contenido está intercalado. Esto habilita los anuncios TrueView que se pueden omitir. Sin embargo, el anuncio permanecerá intercalado y no será compatible con la pantalla completa nativa de iOS. Si es falso, los anuncios se reproducirán en el mismo reproductor que tu contenido. El valor establecido aquí cuando se crea un AdDisplayContainer se usa durante el ciclo de vida del contenedor. El valor predeterminado es falso.

Parámetro

inhabilitar

boolean

Si se inhabilita o no la reproducción personalizada.
Resultado que se muestra

void 

setFeatureFlags

setFeatureFlags(featureFlags) returns void

Establece el valor de cualquier marca de función. Se debe configurar lo antes posible antes de solicitar anuncios. La configuración se mantendrá constante hasta la siguiente solicitud de anuncios. Si vuelves a llamar a este método, se restablecerán las marcas de función para la siguiente solicitud de anuncio.

Parámetro

featureFlags

Objeto con cualquier tipo de propiedades

El valor no debe ser nulo.
Resultado que se muestra

void 

setLocale

setLocale(locale) devuelve void

Establece la configuración regional proporcionada por el editor. Se debe llamar antes de crear AdsLoader o AdDisplayContainer. La configuración regional especifica el idioma en el que se muestran los elementos de la IU. Puedes encontrar los códigos admitidos en Cómo localizar para un idioma y una configuración regional.

Parámetro

configuración regional

string

Configuración regional proporcionada por el editor.
Resultado que se muestra

void 

setNumRedirects

setNumRedirects(numRedirects) muestra void.

Especifica la cantidad máxima de redireccionamientos antes de que se rechacen los redireccionamientos subsiguientes y se anule la carga del anuncio. La cantidad de redireccionamientos afecta directamente la latencia y, por lo tanto, la experiencia del usuario. Esto se aplica a todos los anuncios wrapper de VAST.

Parámetro

NumRedirect

número

la cantidad máxima de redireccionamientos.
Resultado que se muestra

void 

TipodeReproductor

setPlayerType(playerType) devuelve void.

Establece el tipo de reproductor proporcionado por el socio. Esta configuración se debe usar para especificar el nombre del reproductor que se integra con el SDK. Se truncará el tipo de reproductor que tenga más de 20 caracteres. El tipo de reproductor especificado debe ser corto y único. Esta es una configuración opcional que se utiliza para mejorar la usabilidad del SDK mediante el seguimiento de los tipos de jugadores.

Ejemplo: 


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

Parámetro

Tipo de jugador

string

Es el tipo de reproductor del socio.
Resultado que se muestra

void 

Versión del reproductor

setPlayerVersion(playerVersion) muestra un valor nulo.

Configura la versión del reproductor proporcionada por el socio. Esta configuración debe usarse para especificar la versión del reproductor del socio que se integra con el SDK. Se truncarán las versiones que tengan más de 20 caracteres. Esta es una configuración opcional que se utiliza para mejorar la usabilidad del SDK mediante el seguimiento de la versión del reproductor.

Ejemplo: 


settings.setPlayerVersion('1.0.0');

Parámetro

Versión del reproductor

string

La versión del reproductor del socio.
Resultado que se muestra

void 

setPpid

setPpid(ppid) muestra void

Establece el ID proporcionado por el publicador.

Parámetro

PPID

string

ID proporcionado por el publicador.
Resultado que se muestra

void 

ID de sesión

setSessionId(sessionId) muestra un valor nulo.

El ID de sesión es un ID aleatorio temporal. Se usa exclusivamente para la limitación de frecuencia. Un ID de sesión debe ser un UUID.

Parámetro

sessionId

string

Un UUID temporal que se usa para la limitación de frecuencia.
Resultado que se muestra

void 

setVpaidAllowed

setVpaidAllowed(allowVpaid) muestra un resultado nulo

Ya no está disponible. Usa setVpaidMode. Establece si se permiten las creatividades de VPAID.

Parámetro

allowVpaid

boolean

Indica si se deben permitir las creatividades de VPAID.
Resultado que se muestra

void 

setVpaidMode

setVpaidMode(vpaidMode) devuelve void

Establece el modo de reproducción de VPAID.

Parámetro

Modo pagado

Modo de pago pagado

Establece cómo se reproducirán los anuncios de VPAID. El valor predeterminado es el modo seguro.

El valor no debe ser nulo.
Resultado que se muestra

void