Referencia de API

Metodos de Adsgram

init

Crea un AdController, que se utiliza para mostrar, cargar y eliminar publicidad.
Es suficiente inicializarlo solo una vez para un blockId.
Si llamas a la funcion init con el mismo blockId mas de una vez, obtendras el mismo AdController para ese blockId.

Sintaxis

const AdController = window.Adsgram.init({
  blockId: "your-block-id",
  debug: true,
  debugConsole: true,
  debugBannerType: "FullscreenMedia"
});

Parametros

blockId

Una cadena con numeros, por ejemplo "123".
Identificador unico del bloque publicitario que obtienes en el panel del editor.
Encontraras instrucciones detalladas para obtener el blockId en la seccion Obtener blockId

debug Opcional

Un valor booleano, si se establece en true, recibiras una respuesta del servidor con publicidad de prueba y logs detallados con el prefijo ADSGRAM DEBUG LOG se mostraran en la consola del navegador para depurar la integracion.

ATENCIÓN:

No olvides eliminarlo o establecerlo en false al lanzar a produccion.
No agregamos impresiones de publicidad de prueba a las estadisticas, por lo que no veras las estadisticas de impresiones, visualizaciones, clics, etc. en la pagina de la plataforma y el bloque.
La solicitud a Reward Url no sera enviada.

debugConsole Opcional

Un valor booleano. Por defecto true. Funciona solo si el parametro debug es true.
Si es true, los logs detallados con el prefijo ADSGRAM DEBUG LOG se mostraran en la consola del navegador. Si es false, los logs no se muestran en la consola, incluso en modo de depuracion.

debugBannerType Opcional

Valores posibles: "FullscreenMedia" y "RewardedVideo".
Usa este valor cuando quieras obtener un tipo especifico de banner de prueba. Funciona solo si el parametro debug es true.

Valor de retorno

AdController

Metodos de AdController

show

Carga y muestra publicidad.

Sintaxis

javascript

AdController.show();

typescript

const showPromise: Promise<ShowPromiseResult> = AdController.show();

Valor de retorno

Un Promise que se resuelve si el usuario vio la publicidad hasta el final, en caso contrario se rechaza.
El resultado de la promesa tiene los siguientes tipos:

interface ShowPromiseResult {
  done: boolean; // true si el usuario vio hasta el final, de lo contrario false
  description: string; // descripcion del evento
  state: 'load' | 'render' | 'playing' | 'destroy'; // estado del banner
  error: boolean; // true si el evento fue causado por un error, de lo contrario false
}

Ejemplos

Uso de API de promesas:

javascript

AdController.show().then((result) => {
  // el usuario vio la publicidad hasta el final
  // tu codigo para recompensar al usuario
}).catch((result) => {
  // el usuario obtuvo un error durante la reproduccion de la publicidad o salto la publicidad
  // no hacer nada o hacer lo que quieras
})

typescript

AdController.show().then((result: ShowPromiseResult) => {
  // el usuario vio la publicidad hasta el final
  // tu codigo para recompensar al usuario
}).catch((result: ShowPromiseResult) => {
  // el usuario obtuvo un error durante la reproduccion de la publicidad o salto la publicidad
  // no hacer nada o hacer lo que quieras
})

Tambien puedes lograr el mismo comportamiento con await

javascript

try {
  const showPromiseResult = await AdController.show();
  // el usuario vio la publicidad hasta el final
  // tu codigo para recompensar al usuario
} catch (showPromiseResult) {
  // el usuario obtuvo un error durante la reproduccion de la publicidad o salto la publicidad
  // no hacer nada o hacer lo que quieras
}

typescript

try {
  const showPromiseResult: ShowPromiseResult = await AdController.show();
  // el usuario vio la publicidad hasta el final
  // tu codigo para recompensar al usuario
} catch (showPromiseResult: ShowPromiseResult) {
  // el usuario obtuvo un error durante la reproduccion de la publicidad o salto la publicidad
  // no hacer nada o hacer lo que quieras
}

Consejo:

Usa finally para la promesa si necesitas agregar alguna accion adicional despues de que termine la reproduccion de la publicidad, se salte o se produzca un error.

destroy

Detiene la reproduccion de la publicidad y elimina los datos del banner cargado.

Sintaxis

AdController.destroy();

Valor de retorno

None(undefined)

Información:

Normalmente no necesitas llamar a esto manualmente, en caso de error, salto o visualizacion completa de la publicidad, esta se eliminara automaticamente.

addEventListener

Se suscribe a un event y llama a la funcion callback cuando el event se dispara.
Se utiliza si necesitas un mayor control sobre la visualizacion de la publicidad.

Sintaxis

AdController.addEventListener('onReward', () => {
    // tu codigo para recompensar al usuario
});

Parametros

event

Tipos de eventos:

Evento	Ocurre cuando
onStart	se muestra el primer cuadro del banner
onSkip	el usuario cierra la publicidad
onReward	el usuario ve el banner reward hasta el final
onComplete	el usuario ve el banner interstitial hasta el final o lo cierra
onError	el usuario obtiene un error durante la reproduccion o visualizacion del banner
onBannerNotFound	no hay un banner para mostrar
onNonStopShow	el usuario intenta ver varias publicidades seguidas
onTooLongSession	la sesion es demasiado larga, el usuario necesita reiniciar la aplicacion para mostrar publicidad

Consejo:

Si quieres mostrar tu propia alerta, puedes suscribirte a onBannerNotFound, onNonStopShow o onTooLongSession.
De lo contrario, mostraremos una alerta por defecto.
La alerta se muestra en el idioma del usuario o en ingles
y se ve asi

callback

Funcion que se llamara cuando ocurra el evento del tipo especificado.

Valor de retorno

None(undefined)

removeEventListener

Se desuscribe del event con el callback indicado

Sintaxis

AdController.removeEventListener('onReward', rewardFunction);

Parametros

Los mismos que en addEventListener

Valor de retorno

None(undefined)