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 renderice la IU)
  • 'start' antes de que comience la partida (después de que se renderice la IU)
  • 'pause' el reproductor pausa el juego
  • El jugador 'next' navega al siguiente nivel.
  • 'browse' El jugador explora opciones fuera de la jugabilidad.
  • 'reward' un anuncio recompensado
name string (OPCIONAL) Es un nombre para esta posición del anuncio en particular dentro del juego. Es un identificador interno y no se muestra al jugador. En versiones futuras, es posible que este identificador se use para habilitar funciones adicionales de informes y optimización.

Te recomendamos que les pongas nombre a todas tus posiciones.
beforeAd función (OPCIONAL) Se llama antes de que se muestre el anuncio. El juego debería 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 reproductor. Esta función se debe usar para reanudar el flujo del juego. Por ejemplo, se usa para reactivar el sonido y comenzar el siguiente nivel.
adBreakDone función (OPCIONAL) Siempre se llama como el último paso en 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 la posición.
Solo posiciones recompensadas…
beforeReward función Se llama a este método si hay un anuncio recompensado disponible. La función debe tomar un solo argumento: showAdFn(), al que se debe llamar para mostrar el anuncio recompensado.
adDismissed función Se llama solo para los anuncios recompensados cuando el jugador descarta el anuncio. Solo se llama si el reproductor descarta el anuncio antes de que se complete. En este caso, no se debe otorgar la recompensa.
adViewed función Se llama solo para los anuncios recompensados cuando el reproductor completa el anuncio y se 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 de antes y después que pases. Sin embargo, si proporcionas una devolución de llamada adBreakDone(), siempre se llamará, incluso si no se muestra un anuncio. Esto te permite realizar cualquier trabajo adicional que necesites 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 tener uno de los siguientes valores:
breakStatus Motivo
'notReady' No se inicializó la API de Ad Placement
'timeout' Se agotó el tiempo de espera de una posició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 debe haber una posición de anuncio previo al video por carga de página. Los anuncios previos al video posteriores fallan con este estado.
'error' Se produjo un error de JavaScript en una devolución de llamada
'noAdPreloaded' Aún no se había precargado un anuncio, por lo que se omitió esta posición.
'frequencyCapped' No se mostró un anuncio porque se aplicó la limitación de frecuencia a esta posició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 siguiente adBreak().
'other' El anuncio no se mostró por otro motivo. (p. ej., El anuncio aún se estaba recuperando o se descartó un anuncio almacenado en caché anteriormente porque se cambió el tamaño o se rotó la pantalla.
'dismissed' El usuario descartó un anuncio recompensado antes de verlo hasta el final.
'viewed' El usuario vio el anuncio.

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

Si usas afterAd() para reanudar el juego después de que se mostró un anuncio, se llamará a adBreakDone() después de que se reinicie el juego. Para tareas como el registro de Analytics, esto puede ser adecuado, pero si deseas realizar trabajo adicional antes de que se reinicie el juego, mueve la lógica para reanudar el juego de afterAd() a adBreakDone().