adBreak()

Firma de la función:

adBreak(
   type: '<type>',                     // The type of this placement
   name: '<name>',                     // A descriptive name for this placement
   beforeAd: () => {},                 // Prepare for the ad. Mute and pause the game flow
   afterAd: () => {},                  // Resume the game and re-enable sound
   beforeReward: (showAdFn) => {},     // Show reward prompt (call showAdFn() if clicked)
   adDismissed: () => {},              // Player dismissed the ad before completion
   adViewed: () => {},                 // Ad was viewed and closed
   adBreakDone: (placementInfo) => {}, // Always called (if provided) even if an ad didn't show
);

Parámetros de adBreak()

Nombre Tipo Descripción
Todos los tipos de posición
type string

Es el tipo de posición. Valores:

  • 'preroll' antes de que se cargue el juego (antes de que se procese la IU)
  • 'start' antes de que comience el juego (después de que se renderice la IU)
  • 'pause' el jugador pausa el juego
  • 'next' jugador navega al siguiente nivel
  • 'browse' el jugador explora las opciones fuera del juego
  • 'reward' un anuncio recompensado
name string (OPCIONAL) Un nombre para esta posición del anuncio específica dentro de su juego. Es un identificador interno y no se muestra al reproductor. En versiones futuras, es posible que se utilice este identificador para habilitar funciones adicionales de optimización y generación de informes.

Le recomendamos que mencione todas sus posiciones.
beforeAd función (OPCIONAL) Se llama antes de que se muestre el anuncio. El juego debe pausarse y silenciarse. Estas acciones deben realizarse de forma síncrona. El anuncio se mostrará inmediatamente después de que finalice esta devolución de llamada.
afterAd función (OPCIONAL) Se llama después de que finaliza el anuncio (por cualquier motivo). En el caso de los anuncios recompensados, se llama después de adDismissed o adViewed, según las acciones del jugador. Esta función debe usarse para reanudar el flujo del juego. Por ejemplo, úsalo para activar el sonido y comenzar el siguiente nivel.
adBreakDone función (OPCIONAL) Siempre se llama como el último paso de un adBreak(), incluso si no se mostró ningún anuncio. La función toma como argumento un objeto placementInfo definido de la siguiente manera: 
{
    breakType: '<type>',
    breakName: '<name>',
    breakFormat: 'interstitial|reward',
    breakStatus:  'error|noAdPreloaded|...|viewed',
}
Consulta adBreakDone y placementInfo() para obtener una explicación detallada del objeto de información de posición.
Solo posiciones gestionadas...
beforeReward función Se llama si hay un anuncio recompensado disponible. La función debe tomar un solo argumento: showAdFn(), que se debe llamar para mostrar el anuncio recompensado.
adDismissed función Se invoca solo para anuncios recompensados cuando el jugador descarta el anuncio. Solo se invoca si el reproductor descarta el anuncio antes de completarse. En este caso, no se debería otorgar la recompensa.
adViewed función Se invoca solo para anuncios recompensados cuando el jugador completa el anuncio y se le debe otorgar la recompensa.

adBreakDone() and placementInfo

Si la API de Ad Placement no tiene un anuncio para mostrar, no llamará a las distintas devoluciones de llamada anteriores o posteriores que apruebes. Sin embargo, si proporcionas una devolución de llamada adBreakDone(), siempre se llamará a esta, incluso si no se muestra un anuncio. Esto te permite realizar cualquier trabajo adicional que necesites realizar para la posición, como registrar estadísticas adicionales sobre la posición.

La función adBreakDone() toma como argumento un objeto placementInfo definido de la siguiente manera:

{
  breakType: '<type>',
  breakName: '<name>',
  breakFormat: 'interstitial|reward',
  breakStatus: 'notReady|timeout|error|noAdPreloaded|frequencyCapped|ignored|other|dismissed|viewed',
}

Los campos dentro de este objeto tienen la siguiente semántica:

  • breakType es el argumento de tipo que se pasa a adBreak().
  • breakName es el argumento de nombre que se pasa a adBreak().
  • breakStatus es el estado de esta posición y puede ser uno de los siguientes valores:
breakStatus Motivo
'notReady' La API de Ad Placement no se ha inicializado
'timeout' Se agotó el tiempo de espera de la ubicación porque la API de Ad Placement tardó demasiado en responder.
'invalid' La posición no era válida y se ignoró. Por ejemplo, solo debería haber una ubicación para el anuncio previo al video por cada carga de la página; los anuncios previos al video fallan con este estado.
'error' Se produjo un error de JavaScript en una devolución de llamada
'noAdPreloaded' Aún no se cargó previamente un anuncio, por lo que se omitió esta ubicación.
'frequencyCapped' No se mostró un anuncio porque se aplicó la limitación de frecuencia a esta ubicación
'ignored' El usuario no hizo clic en un mensaje de recompensa antes de llegar a la siguiente posición, es decir, no se llamó a showAdFn() antes del próximo adBreak().
'other' El anuncio no se mostró por otro motivo. (P. ej., El anuncio aún se estaba recuperando o se eliminó un anuncio que se almacenó en caché anteriormente porque se cambió el tamaño o se giró la pantalla.
'dismissed' El usuario descartó un anuncio recompensado antes de verlo hasta el final.
'viewed' El usuario vio el anuncio

Nota: adBreakDone() es siempre la última devolución de llamada a la que llama adBreak().

Si usas afterAd() para reanudar el juego una vez que se muestra un anuncio, se llamará a adBreakDone() después de que se reinicie. Esto podría resultarte útil para realizar análisis de registros, pero si quieres realizar más trabajo antes de reiniciar el juego, mueve la lógica para reanudarlo desde tu afterAd() hasta adBreakDone().