adBreak()

Funktionssignatur:

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

Parameter für adBreak()

Name Typ Beschreibung
Alle Placement-Typen
type String

Der Typ des Placements. Werte:

  • 'preroll', bevor das Spiel geladen wird (bevor die Benutzeroberfläche gerendert wurde)
  • 'start' vor Beginn des Spiels (nach dem Rendern der Benutzeroberfläche)
  • 'pause' der Spieler pausiert das Spiel
  • 'next' Spieler gelangt zum nächsten Level
  • 'browse' der Spieler erkundet Optionen außerhalb des Gameplays.
  • 'reward' eine Anzeige mit Prämie
name String (OPTIONAL) Ein Name für diese bestimmte Anzeigenplatzierung in Ihrem Spiel. Es handelt sich um eine interne Kennung, die dem Spieler nicht angezeigt wird. In zukünftigen Versionen kann diese Kennung verwendet werden, um zusätzliche Berichts- und Optimierungsfunktionen zu ermöglichen.

Wir empfehlen, alle Ihre Placements zu benennen.
beforeAd Funktion (OPTIONAL) Wird aufgerufen, bevor die Anzeige ausgeliefert wird. Das Spiel sollte pausieren und der Ton sollte stummgeschaltet werden. Diese Aktionen müssen synchron ausgeführt werden. Die Anzeige wird sofort nach Abschluss dieses Rückrufs eingeblendet.
afterAd Funktion (OPTIONAL) Wird nach dem Ende der Anzeige (aus beliebigen Gründen) aufgerufen. Bei Anzeigen mit Prämie wird nach entweder adDismissed oder adViewed aufgerufen, je nachdem, was der Nutzer im Player tut. Diese Funktion sollte verwendet werden, um den Spielfluss fortzusetzen. Damit können Sie beispielsweise den Ton wieder aktivieren und das nächste Level starten.
adBreakDone Funktion (OPTIONAL) Wird immer als letzter Schritt in einem adBreak() aufgerufen, auch wenn keine Anzeige ausgeliefert wurde. Die Funktion akzeptiert als Argument ein placementInfo-Objekt, das so definiert ist: 
{
    breakType: '<type>',
    breakName: '<name>',
    breakFormat: 'interstitial|reward',
    breakStatus:  'error|noAdPreloaded|...|viewed',
}
 Eine detaillierte Beschreibung des Objekts „placement info“ finden Sie unter adBreakDone und placementInfo().
Nur Placements mit Prämie…
beforeReward Funktion Wird aufgerufen, wenn eine Anzeige mit Prämie verfügbar ist. Die Funktion sollte ein einzelnes Argument verwenden: showAdFn(). Dieses muss aufgerufen werden, um die Prämienanzeige zu präsentieren.
adDismissed Funktion Wird nur für Anzeigen mit Prämie aufgerufen, wenn der Nutzer die Anzeige schließt. Wird nur aufgerufen, wenn der Nutzer die Anzeige vor dem Ende schließt. In diesem Fall sollte die Prämie nicht gewährt werden.
adViewed Funktion Wird nur für Anzeigen mit Prämie aufgerufen, wenn der Nutzer die Anzeige vollständig angesehen hat und die Prämie erhalten soll.

adBreakDone() and placementInfo

Wenn die Ad Placement API keine Anzeige ausliefern kann, werden die verschiedenen Before/After-Callbacks, die Sie übergeben, nicht aufgerufen. Wenn Sie jedoch einen adBreakDone()-Callback angeben, wird dieser immer aufgerufen, auch wenn keine Anzeige ausgeliefert wird. So können Sie alle zusätzlichen Aufgaben erledigen, die für die Platzierung erforderlich sind, z. B. zusätzliche Analysen zur Platzierung protokollieren.

Die Funktion adBreakDone() akzeptiert als Argument ein placementInfo-Objekt, das so definiert ist:

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

Die Felder in diesem Objekt haben die folgende Semantik:

  • breakType ist das Typargument, das an adBreak() übergeben wird.
  • breakName ist das Argument „name“, das an adBreak() übergeben wird.
  • breakStatus ist der Status dieser Platzierung und kann einen der folgenden Werte annehmen:
breakStatus Grund
'notReady' Die Ad Placement API wurde nicht initialisiert.
'timeout' Das Zeitlimit für einen Placement wurde überschritten, weil die Ad Placement API zu lange für die Antwort benötigt hat.
'invalid' Das Placement war ungültig und wurde ignoriert. Pro Seitenaufruf darf es beispielsweise nur ein Preroll-Placement geben. Nachfolgende Prerolls schlagen mit diesem Status fehl.
'error' In einem Callback ist ein JavaScript-Fehler aufgetreten
'noAdPreloaded' Eine Anzeige wurde noch nicht vorab geladen, daher wurde dieses Placement übersprungen.
'frequencyCapped' Eine Anzeige wurde nicht ausgeliefert, weil das Frequency Capping auf dieses Placement angewendet wurde.
'ignored' Der Nutzer hat nicht auf einen Aufforderungs-Prompt für eine Belohnung geklickt, bevor er die nächste Platzierung erreicht hat. Das bedeutet, dass showAdFn() nicht vor dem nächsten adBreak() aufgerufen wurde.
'other' Die Anzeige wurde aus einem anderen Grund nicht ausgeliefert. (z. B. mit der Die Anzeige wurde noch abgerufen oder eine zuvor im Cache gespeicherte Anzeige wurde verworfen, weil die Größe des Bildschirms geändert oder der Bildschirm gedreht wurde.)
'dismissed' Der Nutzer hat eine Anzeige mit Prämie geschlossen, bevor er sie vollständig angesehen hat.
'viewed' Die Anzeige wurde vom Nutzer angesehen.

Hinweis: adBreakDone() ist immer der letzte Callback, der von adBreak() aufgerufen wird.

Wenn Sie afterAd() verwenden, um das Spiel nach der Anzeige einer Werbung fortzusetzen, wird adBreakDone() nach dem Neustart des Spiels aufgerufen. Für Dinge wie die Protokollierung von Analysen kann dies geeignet sein. Wenn Sie jedoch zusätzliche Aufgaben ausführen möchten, bevor Ihr Spiel neu gestartet wird, verschieben Sie die Logik zum Aufheben der Pausierung des Spiels von afterAd() nach adBreakDone().