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'UI)
  • 'start' avant le début du jeu (après le rendu de l'UI)
  • 'pause' : le joueur met le jeu en pause.
  • Le joueur 'next' passe au niveau suivant
  • 'browse' le joueur explore les options en dehors du gameplay.
  • 'reward' une annonce avec récompense
name chaîne (FACULTATIF) : nom de cet emplacement publicitaire spécifique dans votre jeu. Il s'agit d'un identifiant interne qui n'est pas visible par le joueur. Dans les prochaines versions, cet identifiant pourra être utilisé pour activer des fonctionnalités de reporting et d'optimisation supplémentaires.

Nous vous recommandons de nommer tous vos emplacements.
beforeAd fonction (FACULTATIF) Appelé avant l'affichage de l'annonce. Le jeu doit se mettre en pause et couper le son. Ces actions doivent être effectuées de manière synchrone. L'annonce s'affichera immédiatement après la fin de ce rappel.
afterAd fonction (FACULTATIF) Appelé une fois l'annonce terminée (pour quelque raison que ce soit). Pour les annonces avec récompense, il est appelé après adDismissed ou adViewed, selon les actions du lecteur. Cette fonction doit être utilisée pour reprendre le déroulement du jeu. Par exemple, utilisez pour réactiver le son et passer au niveau suivant.
adBreakDone fonction (FACULTATIF) : toujours appelé en tant que dernière étape d'un adBreak(), même si aucune annonce n'a été diffusée. La fonction prend comme argument un objet placementInfo défini comme suit : 
{
    breakType: '<type>',
    breakName: '<name>',
    breakFormat: 'interstitial|reward',
    breakStatus:  'error|noAdPreloaded|...|viewed',
}
 Pour obtenir une explication détaillée de l'objet d'informations sur l'emplacement, consultez adBreakDone et placementInfo().
Emplacements avec récompense uniquement…
beforeReward fonction Appelée si une annonce avec récompense est disponible. La fonction doit accepter 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 ferme l'annonce. Il n'est appelé que si le lecteur ferme l'annonce avant la fin de la lecture. 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 a terminé de regarder l'annonce et doit recevoir la récompense.

adBreakDone() and placementInfo

Si l'API Ad Placement n'a pas d'annonce à afficher, 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. Cela vous permet d'effectuer tout travail supplémentaire dont vous pourriez avoir besoin pour l'emplacement, comme enregistrer des données analytiques supplémentaires à son sujet.

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

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

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 correspond à l'état de cet emplacement et peut prendre l'une des valeurs suivantes :
breakStatus Motif
'notReady' L'API Ad Placement ne s'est pas initialisée
'timeout' Le délai d'un emplacement a expiré, car l'API Ad Placement a mis trop de temps à répondre.
'invalid' L'emplacement n'était pas valide et a été ignoré (par exemple, il ne doit y avoir qu'un seul emplacement de préroll par chargement de page. Les prérolls suivants échouent avec cet état).
'error' Une erreur JavaScript s'est produite dans un rappel
'noAdPreloaded' Aucune annonce n'avait encore été préchargée. Cet emplacement a donc été ignoré.
'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 le prochain emplacement, c'est-à-dire que 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é/tourné.)
'dismissed' L'utilisateur a fermé une annonce avec récompense avant de la regarder en entier.
'viewed' L'utilisateur a vu l'annonce.

Remarque : adBreakDone() est toujours le dernier rappel appelé par adBreak().

Si vous utilisez afterAd() pour réactiver votre jeu une fois qu'une annonce a été diffusée, adBreakDone() sera appelé après le redémarrage de votre jeu. Cela peut convenir pour des tâches telles que la journalisation des données analytiques, mais si vous souhaitez effectuer des tâches supplémentaires avant le redémarrage de votre jeu, déplacez la logique de réactivation de votre jeu de afterAd() vers adBreakDone().