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 di adBreak()

Nome Tipo Descrizione
Tutti i tipi di posizionamento
type stringa

Il tipo di posizionamento. Valori:

  • 'preroll' prima del caricamento del gioco (prima del rendering dell'interfaccia utente)
  • 'start' prima dell'inizio del gameplay (dopo il rendering dell'interfaccia utente)
  • 'pause' il giocatore mette in pausa la partita
  • Il giocatore 'next' passa al livello successivo
  • 'browse' il giocatore esplora le opzioni al di fuori del gameplay
  • 'reward' un annuncio con premio
name stringa (FACOLTATIVO) un nome per questo particolare posizionamento degli annunci all'interno del gioco. È un identificatore interno e non viene mostrato al giocatore. Nelle versioni future, questo identificatore potrebbe essere utilizzato per attivare funzionalità aggiuntive di generazione di report e ottimizzazione.

Ti consigliamo di assegnare un nome a tutti i tuoi posizionamenti.
beforeAd funzione (FACOLTATIVO) Chiamato prima della visualizzazione dell'annuncio. Il gioco dovrebbe mettersi in pausa e disattivare l'audio. Queste azioni devono essere eseguite in modo sincrono. L'annuncio verrà visualizzato immediatamente al termine di questo callback.
afterAd funzione (FACOLTATIVO) Chiamato 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 di gioco. Ad esempio, usa per riattivare l'audio e iniziare il livello successivo.
adBreakDone funzione (FACOLTATIVO) Viene sempre chiamato come ultimo passaggio in un adBreak(), anche se non è stato mostrato alcun annuncio. La funzione accetta come argomento un oggetto placementInfo definito come segue: 
{
    breakType: '<type>',
    breakName: '<name>',
    breakFormat: 'interstitial|reward',
    breakStatus:  'error|noAdPreloaded|...|viewed',
}
 Per una spiegazione dettagliata dell'oggetto delle informazioni sul posizionamento, vedi adBreakDone e placementInfo().
Solo posizionamenti con premi…
beforeReward funzione Chiamato se è disponibile un annuncio con premio. La funzione deve accettare un solo argomento, showAdFn(), che deve essere chiamato per visualizzare l'annuncio con premio.
adDismissed funzione Chiamato solo per gli annunci con premio quando il player chiude l'annuncio. Viene chiamato solo se il player chiude l'annuncio prima del completamento. In questo caso, il premio non deve essere concesso.
adViewed funzione Chiamato solo per gli annunci con premio quando il player completa l'annuncio e deve essere concesso il premio.

adBreakDone() and placementInfo

Se l'API Ad Placement non ha un annuncio da mostrare, non chiamerà i vari callback before/after che passi. Tuttavia, se fornisci un adBreakDone() callback, questo verrà sempre chiamato, anche se non viene mostrato un annuncio. In questo modo puoi eseguire qualsiasi lavoro aggiuntivo necessario per il posizionamento, ad esempio registrare analisi aggiuntive sul posizionamento.

La funzione adBreakDone() accetta 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',
}

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ò assumere uno dei seguenti valori:
breakStatus Motivo
'notReady' L'API Ad Placement non è stata inizializzata
'timeout' Un posizionamento è scaduto perché l'API Ad Placement ha impiegato troppo tempo a rispondere
'invalid' Il posizionamento non era valido ed è stato ignorato. Ad esempio, dovrebbe esserci un solo posizionamento preroll per caricamento di pagina. I preroll successivi non vanno a buon fine con questo stato.
'error' Si è verificato un errore JavaScript in un callback
'noAdPreloaded' Un annuncio non era ancora stato precaricato, quindi questo posizionamento è stato ignorato
'frequencyCapped' Un annuncio non è stato mostrato perché è stata applicata la quota limite a questo posizionamento
'ignored' L'utente non ha fatto clic su un prompt di premio prima di raggiungere il posizionamento successivo, ovvero showAdFn() non è stato chiamato prima del successivo adBreak().
'other' L'annuncio non è stato pubblicato per un altro motivo. (ad es. L'annuncio era ancora in fase di recupero o un annuncio precedentemente memorizzato nella cache è stato eliminato perché lo schermo è stato ridimensionato/ruotato.)
'dismissed' L'utente ha chiuso un annuncio con premio prima di visualizzarlo fino al completamento
'viewed' L'annuncio è stato visualizzato dall'utente

Nota: adBreakDone() è sempre l'ultimo richiamo che adBreak() effettua.

Se usi afterAd() per riprendere la partita dopo la visualizzazione di un annuncio, adBreakDone() verrà chiamato dopo il riavvio della partita. Per attività come la registrazione delle analisi, questa soluzione potrebbe essere adatta, ma se vuoi eseguire operazioni aggiuntive prima del riavvio del gioco, sposta la logica per riprendere la partita da afterAd() a adBreakDone().