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

Nazwa	Typ	Opis
Wszystkie typy miejsc docelowych
type	tekst	Typ miejsca docelowego. Wartości: 'preroll' przed załadowaniem gry (przed wyrenderowaniem interfejsu użytkownika). 'start' przed rozpoczęciem rozgrywki (po wyrenderowaniu interfejsu) 'pause' gracz wstrzymuje grę 'next' gracz przechodzi na kolejny poziom 'browse' gracz analizuje opcje spoza rozgrywki 'reward' reklama z nagrodą
name	tekst	(OPTIONAL) nazwa tego miejsca docelowego reklamy w grze. To wewnętrzny identyfikator, który nie wyświetla się odtwarzaczowi. W przyszłych wersjach ten identyfikator może służyć do włączania dodatkowych funkcji raportowania i optymalizacji. Zalecamy nazwanie wszystkich miejsc docelowych.
beforeAd	funkcja	(OPTIONAL) wywołane przed wyświetleniem reklamy. Gra powinna wstrzymywać i wyciszać dźwięk. Wszystkie te czynności musisz wykonywać synchronicznie. Reklama zostanie wyświetlona natychmiast po zakończeniu tego wywołania zwrotnego.
afterAd	funkcja	(OPTIONAL) wywoływane po zakończeniu reklamy (z dowolnego powodu). W przypadku reklam z nagrodą nazwa ta następuje po adDismissed lub adViewed w zależności od działań odtwarzacza. Należy użyć tej funkcji do wznowienia gry. Na przykład, aby wyłączyć wyciszenie dźwięku i przejść do następnego poziomu.
adBreakDone	funkcja	(OPTIONAL) Zawsze wywoływane jako ostatni krok w adBreak(), nawet jeśli nie wyświetliła się reklama. Funkcja przyjmuje jako argument obiekt placementInfo zdefiniowany w ten sposób: { breakType: '<type>', breakName: '<name>', breakFormat: 'interstitial|reward', breakStatus: 'error|noAdPreloaded|...|viewed', } Szczegółowe informacje o miejscu docelowym znajdziesz w opisie właściwości adBreakDone i placementInfo().
Tylko miejsca docelowe z nagrodą...
beforeReward	funkcja	Wywołane, jeśli jest dostępna reklama z nagrodą. Ta funkcja powinna przyjąć jeden argument – showAdFn(), który musi zostać wywołany w celu wyświetlenia reklamy z nagrodą.
adDismissed	funkcja	Wywoływane tylko w przypadku reklam z nagrodą, gdy odtwarzacz odrzuci reklamę. Jest ona wywoływana tylko wtedy, gdy gracz zamknie reklamę przed jej ukończeniem. W takim przypadku nagroda nie powinna zostać przyznana.
adViewed	funkcja	Wywoływane tylko w przypadku reklam z nagrodą, gdy gracz obejrzy reklamę i powinny otrzymać nagrodę.

adBreakDone() and placementInfo

Jeśli interfejs Ad Placement API nie ma reklamy, która mogłaby wyświetlić reklamę, nie będzie wywoływała różnych przekazywanych wywołań zwrotnych. Jeśli jednak podasz wywołanie zwrotne adBreakDone(), będzie ono zawsze wywoływane, nawet jeśli reklama się nie wyświetli. Dzięki temu możesz wykonywać dodatkowe działania związane z miejscem docelowym, np. rejestrować dodatkowe statystyki.

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

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

Gdzie pola w tym obiekcie mają taką semantykę:

• breakType to argument typu przekazany do adBreak()
• breakName to argument nazwy przekazany do adBreak()
• breakStatus to stan tego miejsca docelowego, który może mieć jedną z tych wartości:

breakStatus	Uzasadnienie
'notReady'	Interfejs Ad Placement API nie został zainicjowany
'timeout'	Przekroczono limit czasu miejsca docelowego, ponieważ interfejs Ad Placement API odpowiadał zbyt długo
'invalid'	Miejsce docelowe było nieprawidłowe i zostało zignorowane – na przykład przy każdym wczytaniu strony powinno znajdować się tylko jedno miejsce docelowe przed filmem, a kolejne reklamy przed tym filmem nie powiodły się.
'error'	Podczas wywołania zwrotnego wystąpił błąd JavaScript
'noAdPreloaded'	Reklama nie została wstępnie wczytana, więc to miejsce zostało pominięte
'frequencyCapped'	Reklama nie była wyświetlana, ponieważ limit wyświetleń na użytkownika został zastosowany w tym miejscu docelowym
'ignored'	Użytkownik nie kliknął prośby o nagrodę, zanim dotarł do następnego miejsca docelowego, czyli aplikacja showAdFn() nie została wywołana przed następnym adBreak().
'other'	Reklama nie była wyświetlana z innego powodu. (np. reklama była nadal pobierana, lub reklama umieszczona w pamięci podręcznej została odrzucona, ponieważ rozmiar ekranu został zmieniony lub obrócono).
'dismissed'	Użytkownik odrzucił reklamę z nagrodą przed obejrzeniem jej w całości.
'viewed'	Reklama została wyświetlona przez użytkownika

Uwaga: adBreakDone() to zawsze ostatnie wywołanie zwrotne, które adBreak() dzwoni.

Jeśli używasz metody afterAd(), aby wznowić wyświetlanie gry po wyświetleniu reklamy, właściwość adBreakDone() zostanie wywołana po ponownym uruchomieniu gry. Może to być przydatne w przypadku statystyk rejestrowania, ale jeśli chcesz uruchomić dodatkowe zadania przed ponownym uruchomieniem gry, zmień logikę, aby wznowić grę od afterAd() do adBreakDone().