adBreak()

Signature de la fonction:

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

Paramètres adBreak()

Nom	Type	Description
Tous les types d'emplacements
type	chaîne	Type d'emplacement. Valeurs : 'preroll' avant le chargement du jeu (avant le rendu de l'interface utilisateur) 'start' avant le début du jeu (après le rendu de l'interface utilisateur) 'pause', le joueur met la partie en pause 'next' joueur passe au niveau suivant 'browse' le joueur explore des options en dehors du jeu 'reward' une annonce avec récompense
name	chaîne	(FACULTATIF) : nom de cet emplacement d'annonce spécifique dans votre jeu. Il s'agit d'un identifiant interne qui n'est pas visible par le lecteur. Dans les prochaines versions, cet identifiant pourra être utilisé pour activer des fonctionnalités de création de rapports et d'optimisation supplémentaires. Nous vous recommandons de nommer tous vos emplacements.
beforeAd	fonction	(FACULTATIF) est appelé avant l'affichage de l'annonce. Le jeu doit mettre en pause et couper le son. Ces actions doivent être effectuées de manière synchrone. L'annonce sera affichée immédiatement après la fin de ce rappel.
afterAd	fonction	(FACULTATIF) est appelé une fois l'annonce terminée (pour quelque raison que ce soit). Pour les annonces avec récompense, elle est appelée après adDismissed ou adViewed, selon les actions du joueur. Cette fonction doit être utilisée pour reprendre le jeu. Vous pouvez par exemple réactiver le son et passer au niveau suivant.
adBreakDone	fonction	(FACULTATIF) Toujours appelé comme la dernière étape d'un adBreak(), même si aucune annonce n'est diffusée. La fonction utilise comme argument un objet placementInfo défini comme suit : { breakType: '<type>', breakName: '<name>', breakFormat: 'interstitial|reward', breakStatus: 'error|noAdPreloaded|...|viewed', } Reportez-vous à adBreakDone et placementInfo() pour obtenir une explication détaillée de l'objet d'informations sur l'emplacement.
Emplacements avec récompense uniquement...
beforeReward	fonction	Appelée si une annonce avec récompense est disponible. La fonction doit comporter un seul argument (showAdFn()) qui doit être appelé pour afficher l'annonce avec récompense.
adDismissed	fonction	Appelé uniquement pour les annonces avec récompense lorsque le lecteur ignore l'annonce. Elle n'est appelée que si le lecteur ignore l'annonce avant la fin. Dans ce cas, la récompense ne doit pas être accordée.
adViewed	fonction	Appelé uniquement pour les annonces avec récompense lorsque le lecteur termine l'annonce et doit recevoir la récompense.

adBreakDone() and placementInfo

Si l'API Ad Placement ne dispose d'aucune annonce à diffuser, elle n'appellera pas les différents rappels avant/après que vous transmettez. Toutefois, si vous fournissez un rappel adBreakDone(), il sera toujours appelé, même si aucune annonce n'est diffusée. Vous pouvez ainsi effectuer toutes les tâches supplémentaires que vous pouvez effectuer pour l'emplacement, comme consigner des données analytiques supplémentaires sur l'emplacement.

La fonction adBreakDone() utilise un objet placementInfo défini comme suit:

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

Où les champs de cet objet ont la sémantique suivante:

• breakType est l'argument de type transmis à adBreak().
• breakName est l'argument de nom transmis à adBreak().
• breakStatus est l'état de cet emplacement et peut être l'une des valeurs suivantes:

breakStatus	Motif
'notReady'	L'API Ad Placement n'avait pas été initialisée
'timeout'	L'emplacement d'annonce a expiré, car l'API Ad Placement a pris trop de temps pour répondre
'invalid'	L'emplacement n'est pas valide et a été ignoré. Par exemple, il ne doit y avoir qu'un seul emplacement d'annonce vidéo pré-roll par chargement de page. Les annonces vidéo pré-roll suivantes présentent cet état.
'error'	Une erreur JavaScript s'est produite dans un rappel
'noAdPreloaded'	Cet emplacement a été ignoré, car aucune annonce n'a encore été préchargée.
'frequencyCapped'	Une annonce n'a pas été diffusée, car la limite de la fréquence d'exposition a été appliquée à cet emplacement
'ignored'	L'utilisateur n'a pas cliqué sur une invite de récompense avant d'atteindre l'emplacement suivant, soit showAdFn() n'a pas été appelé avant le prochain adBreak().
'other'	L'annonce n'a pas été diffusée pour une autre raison. (par exemple, L'annonce était toujours en cours de récupération, ou une annonce précédemment mise en cache a été supprimée, car l'écran a été redimensionné ou alterné.
'dismissed'	L'utilisateur a ignoré une annonce avec récompense avant de la regarder en entier
'viewed'	L'annonce a été vue par l'utilisateur

Remarque : adBreakDone() est toujours le dernier rappel que adBreak() appelle.

Si vous utilisez afterAd() pour réactiver votre jeu après la diffusion d'une annonce, adBreakDone() sera appelé une fois le jeu redémarré. Par exemple, pour consigner des données d'analyse, vous pouvez effectuer des tâches supplémentaires avant de redémarrer votre jeu en déplaçant la logique afin de réactiver votre jeu de afterAd() à adBreakDone().