adBreak()

Podpis funkcji:

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

Parametry funkcji adBreak()

Nazwa Typ Opis
Wszystkie typy miejsc docelowych
type ciąg znaków

Typ miejsca docelowego. Wartości:

  • 'preroll' przed załadowaniem gry (zanim zostanie wyrenderowany interfejs);
  • 'start' przed rozpoczęciem rozgrywki (po wyrenderowaniu interfejsu);
  • 'pause' gracz wstrzymuje grę,
  • 'next' gracz przechodzi na następny poziom;
  • 'browse' gracz przegląda opcje poza rozgrywką;
  • 'reward' reklama z nagrodą,
name ciąg znaków (OPCJONALNIE) nazwa tego konkretnego miejsca docelowego reklamy w grze. Jest to identyfikator wewnętrzny, który nie jest widoczny dla gracza. W przyszłych wersjach ten identyfikator może być używany do włączania dodatkowych funkcji raportowania i optymalizacji.

Zalecamy nadawanie nazw wszystkim miejscom docelowym.
beforeAd funkcja (OPCJONALNIE) Wywoływana przed wyświetleniem reklamy. Gra powinna się zatrzymać, a dźwięk powinien zostać wyciszony. Te działania muszą być wykonywane synchronicznie. Reklama zostanie wyświetlona natychmiast po zakończeniu tego wywołania zwrotnego.
afterAd funkcja (OPCJONALNIE) Wywoływana po zakończeniu reklamy (z jakiegokolwiek powodu). W przypadku reklam z nagrodą jest to po adDismissed lub adViewed w zależności od działań gracza. Ta funkcja powinna być używana do wznawiania rozgrywki. Na przykład użyj, aby wyłączyć wyciszenie i rozpocząć kolejny poziom.
adBreakDone funkcja (OPCJONALNIE) Zawsze wywoływana jako ostatni krok w adBreak(), nawet jeśli nie wyświetlono żadnej reklamy. Funkcja przyjmuje jako argument obiekt placementInfo zdefiniowany w ten sposób: 
{
    breakType: '<type>',
    breakName: '<name>',
    breakFormat: 'interstitial|reward',
    breakStatus:  'error|noAdPreloaded|...|viewed',
}
 Szczegółowe wyjaśnienie obiektu informacji o miejscu docelowym znajdziesz w sekcjach adBreakDone i placementInfo().
Tylko miejsca docelowe z nagrodą...
beforeReward funkcja Wywoływana, jeśli dostępna jest reklama z nagrodą. Funkcja powinna przyjmować 1 argument – showAdFn(), który musi zostać wywołany, aby wyświetlić reklamę z nagrodą.
adDismissed funkcja Wywoływana tylko w przypadku reklam z nagrodą, gdy odtwarzacz odrzuci reklamę. Jest wywoływana tylko wtedy, gdy odtwarzacz odrzuci reklamę przed jej zakończeniem. W takim przypadku nagroda nie powinna zostać przyznana.
adViewed funkcja Wywoływane tylko w przypadku reklam z nagrodą, gdy odtwarzacz zakończy odtwarzanie reklamy i użytkownik powinien otrzymać nagrodę.

adBreakDone() and placementInfo

Jeśli interfejs Ad Placement API nie ma reklamy do wyświetlenia, nie wywoła różnych wywołań zwrotnych przed/po, które przekazujesz. Jeśli jednak podasz adBreakDone()wywołanie zwrotne, zostanie ono zawsze wywołane, nawet jeśli reklama się nie wyświetli. Umożliwia to wykonanie dodatkowych czynności, które mogą być potrzebne w przypadku miejsca docelowego, np. rejestrowanie dodatkowych danych analitycznych dotyczących tego miejsca.

Funkcja adBreakDone() przyjmuje jako argument obiekt placementInfo zdefiniowany w ten sposób:

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

Pola w tym obiekcie mają następujące znaczenie:

  • breakType to argument typu przekazany do funkcji adBreak()
  • breakName to argument nazwy przekazany do funkcji adBreak()
  • breakStatus to stan tej sekcji reklamy, który może mieć jedną z tych wartości:
breakStatus Przyczyna
'notReady' Interfejs Ad Placement API nie został zainicjowany.
'timeout' Miejsce docelowe przekroczyło limit czasu, ponieważ interfejs Ad Placement API zbyt długo odpowiadał na żądanie.
'invalid' Miejsce docelowe było nieprawidłowe i zostało zignorowane – na przykład na stronie może być tylko jedno miejsce docelowe typu preroll, a kolejne prerolle będą miały ten stan.
'error' W funkcji zwrotnej wystąpił błąd JavaScript
'noAdPreloaded' Reklama nie została jeszcze wstępnie wczytana, więc to miejsce docelowe zostało pominięte
'frequencyCapped' Reklama nie została wyświetlona, ponieważ w tym miejscu docelowym zastosowano limit wyświetleń na użytkownika
'ignored' Użytkownik nie kliknął prośby o nagrodę, zanim dotarł do następnego miejsca docelowego, czyli funkcja showAdFn() nie została wywołana przed następną funkcją adBreak().
'other' Reklama nie została wyświetlona z innego powodu. (np. Reklama była nadal pobierana lub wcześniej zapisana w pamięci podręcznej reklama została usunięta, ponieważ rozmiar ekranu został zmieniony lub ekran został obrócony).
'dismissed' Użytkownik zamknął reklamę z nagrodą, zanim obejrzał ją w całości.
'viewed' Reklama została wyświetlona użytkownikowi.

Uwaga: adBreakDone() jest zawsze ostatnim wywołaniem zwrotnym, które wykonuje adBreak().

Jeśli po wyświetleniu reklamy użyjesz afterAd(), aby wznowić grę, po ponownym uruchomieniu gry zostanie wywołana funkcja adBreakDone(). W przypadku takich czynności jak rejestrowanie danych analitycznych może to być odpowiednie rozwiązanie, ale jeśli przed ponownym uruchomieniem gry chcesz wykonać dodatkowe działania, przenieś logikę wznawiania gry z funkcji afterAd() do funkcji adBreakDone().