adBreak()

Firma della funzione:

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
);

Parametri adBreak()

Nome Tipo Descrizione
Tutti i tipi di posizionamento
type string

Il tipo di posizionamento. Valori:

  • 'preroll' prima del caricamento del gioco (prima che l'UI venga visualizzata)
  • 'start' prima dell'inizio del gameplay (dopo il rendering dell'interfaccia utente)
  • 'pause' il giocatore mette in pausa la partita
  • 'next' giocatore passa al livello successivo
  • 'browse' il giocatore esplora le opzioni al di fuori del gameplay
  • 'reward' un annuncio con premio
name string (OPTIONAL) un nome per questo specifico posizionamento dell'annuncio all'interno del tuo gioco. Si tratta di un identificatore interno e non viene mostrato al player. Nelle prossime versioni, questo identificatore potrebbe essere utilizzato per attivare funzioni aggiuntive di generazione di report e ottimizzazione.

Ti consigliamo di assegnare un nome a tutti i posizionamenti.
beforeAd funzione (FACOLTATIVO) Richiamato prima della visualizzazione dell'annuncio. Il gioco deve mettere in pausa e disattivare l'audio. Queste azioni devono essere sincronizzate. L'annuncio verrà visualizzato immediatamente dopo il termine del callback.
afterAd funzione (FACOLTATIVO) Richiamata al termine dell'annuncio (per qualsiasi motivo). Per gli annunci con premio, viene chiamato dopo adDismissed o adViewed, a seconda delle azioni del giocatore. Questa funzione deve essere utilizzata per riprendere il flusso del gioco. Ad esempio, usa questa opzione per riattivare l'audio e iniziare il livello successivo.
adBreakDone funzione (Facoltativo) Sempre chiamato come ultimo passaggio di un elemento adBreak(), anche se non è stato mostrato alcun annuncio. La funzione prende come argomento un oggetto placementInfo definito come segue: 
{
    breakType: '<type>',
    breakName: '<name>',
    breakFormat: 'interstitial|reward',
    breakStatus:  'error|noAdPreloaded|...|viewed',
}
Consulta adBreakDone e placementInfo() per una spiegazione dettagliata dell'oggetto informazioni sul posizionamento.
Solo posizionamenti con premio...
beforeReward funzione Richiamato se è disponibile un annuncio con premio. La funzione dovrebbe utilizzare un singolo argomento, showAdFn(), che deve essere chiamato per visualizzare l'annuncio con premio.
adDismissed funzione Richiamati solo per gli annunci con premio quando il giocatore ignora l'annuncio. Viene chiamato solo se il player ignora l'annuncio prima del completamento. In questo caso, il premio non deve essere concesso.
adViewed funzione Richiamati solo per gli annunci con premio quando il giocatore completa l'annuncio e deve ricevere il premio.

adBreakDone() and placementInfo

Se l'API Ad Placement non ha annunci da mostrare, non chiamerà i vari callback prima/dopo che trasmetti. Tuttavia, se effettui un callback adBreakDone() verrà sempre chiamato, anche se un annuncio non viene mostrato. In questo modo puoi eseguire altre operazioni che potrebbero essere necessarie per il posizionamento, ad esempio registrare dati di analisi aggiuntivi sul posizionamento.

La funzione adBreakDone() prende come argomento un oggetto placementInfo definito come segue:

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

Dove i campi all'interno di questo oggetto hanno la seguente semantica:

  • breakType è l'argomento di tipo passato a adBreak()
  • breakName è l'argomento del nome passato a adBreak()
  • breakStatus è lo stato di questo posizionamento e può essere uno dei seguenti valori:
breakStatus Motivo
'notReady' L'API Ad Placement non è stata inizializzata
'timeout' Si è verificato il timeout di un posizionamento perché l'API Ad Placement ha impiegato troppo tempo per rispondere
'invalid' Il posizionamento non era valido ed è stato ignorato: ad esempio, dovrebbe essere presente un solo posizionamento pre-roll per ogni caricamento pagina. I pre-roll successivi non sono riusciti con questo stato.
'error' Si è verificato un errore JavaScript in un callback
'noAdPreloaded' Un annuncio non è stato ancora caricato, quindi questo posizionamento è stato ignorato
'frequencyCapped' Un annuncio non è stato pubblicato perché la quota limite è stata applicata a questo posizionamento
'ignored' L'utente non ha fatto clic su un messaggio di premio prima di raggiungere il posizionamento successivo, ovvero showAdFn() non è stato chiamato prima del giorno adBreak() successivo.
'other' L'annuncio non è stato pubblicato per un altro motivo. (ad es. L'annuncio era ancora in fase di recupero oppure è stato eliminato un annuncio precedentemente memorizzato nella cache perché lo schermo è stato ridimensionato/ruotato.
'dismissed' L'utente ha ignorato un annuncio con premio prima di visualizzarlo fino alla fine
'viewed' L'annuncio è stato visualizzato dall'utente

Nota: adBreakDone() è sempre l'ultimo callback che adBreak() chiama.

Se usi afterAd() per riattivare il gioco dopo che è stato mostrato un annuncio, adBreakDone() verrà chiamato dopo il riavvio del gioco. Ad esempio, per esempio, è opportuno registrare i dati analitici. Tuttavia, se vuoi eseguire ulteriori operazioni prima del riavvio del gioco, puoi spostare la logica per riattivare il gioco da afterAd() a adBreakDone().