adBreak()

Сигнатура функции:

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

параметры adBreak()

Имя Тип Описание
Все типы размещения
type нить

Тип размещения. Значения:

  • 'preroll' перед загрузкой игры (до того, как будет отрисован пользовательский интерфейс)
  • 'start' до начала игрового процесса (после отрисовки пользовательского интерфейса)
  • 'pause' игрок ставит игру на паузу
  • 'next' игрок переходит на следующий уровень
  • 'browse' игрок исследует возможности за пределами игрового процесса
  • 'reward' за объявление с вознаграждением
name нить (НЕОБЯЗАТЕЛЬНО) название для данного рекламного места в вашей игре. Это внутренний идентификатор, который не отображается игроку. В будущих версиях этот идентификатор может быть использован для включения дополнительных функций отчётности и оптимизации.

Мы рекомендуем вам дать названия всем вашим местам размещения.
beforeAd функция (НЕОБЯЗАТЕЛЬНО) Вызывается перед показом рекламы. Игра должна приостановиться, а звук отключиться. Эти действия должны выполняться синхронно. Реклама будет отображена сразу после завершения этого обратного вызова.
afterAd функция (НЕОБЯЗАТЕЛЬНО) Вызывается после завершения рекламы (по любой причине). Для рекламы с вознаграждением она вызывается после adDismissed или adViewed , в зависимости от действий игрока. Эту функцию следует использовать для возобновления игры. Например, для включения звука и перехода к следующему уровню.
adBreakDone функция (НЕОБЯЗАТЕЛЬНО) Всегда вызывается на последнем этапе функции adBreak() , даже если реклама не показывалась. Функция принимает в качестве аргумента объект placementInfo определённый следующим образом:
{
    breakType: '<type>',
    breakName: '<name>',
    breakFormat: 'interstitial|reward',
    breakStatus:  'error|noAdPreloaded|...|viewed',
}
 Подробное объяснение объекта информации о размещении см. в adBreakDone и placementInfo()
Только вознагражденные за трудоустройство...
beforeReward функция Вызывается, если доступна реклама с вознаграждением. Функция должна принимать один аргумент – showAdFn() , который необходимо вызвать для отображения рекламы с вознаграждением.
adDismissed функция Вызывается только для рекламы с вознаграждением, когда игрок закрывает рекламу. Вызывается только в том случае, если игрок закрывает рекламу до её завершения. В этом случае вознаграждение не предоставляется.
adViewed функция Вызывается только для объявлений с вознаграждением, когда игрок завершает просмотр рекламы и должен получить вознаграждение.

adBreakDone() and placementInfo

Если у API размещения рекламы нет рекламы для показа, он не будет вызывать различные обратные вызовы «до/после», которые вы передадите. Однако, если вы предоставите обратный вызов adBreakDone() он будет вызываться всегда, даже если реклама не показывается. Это позволит вам выполнить любые дополнительные действия, которые могут потребоваться для размещения, например, записать дополнительную аналитику о нём.

Функция adBreakDone() принимает в качестве аргумента объект placementInfo , определенный следующим образом:

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

Поля внутри этого объекта имеют следующую семантику:

  • breakType — это аргумент типа, передаваемый в adBreak()
  • breakName — это аргумент имени, переданный в adBreak()
  • breakStatus — это статус данного размещения и может принимать одно из следующих значений:
breakStatus Причина
'notReady' API размещения рекламы не был инициализирован
'timeout' Время размещения истекло, поскольку API размещения рекламы слишком долго отвечал.
'invalid' Размещение было недействительным и было проигнорировано. Например, на одну загрузку страницы должно быть только одно размещение преролла. Последующие прероллы завершаются неудачей с этим статусом.
'error' В обратном вызове произошла ошибка JavaScript.
'noAdPreloaded' Реклама еще не была предварительно загружена, поэтому это размещение было пропущено.
'frequencyCapped' Объявление не было показано, поскольку к этому месту размещения было применено ограничение частоты показов.
'ignored' Пользователь не нажал на подсказку о вознаграждении до того, как достиг следующего места размещения, то есть showAdFn() не был вызван до следующего adBreak() .
'other' Объявление не было показано по другой причине. (Например, объявление все еще загружалось или ранее кэшированное объявление было удалено из-за изменения размера/поворота экрана.)
'dismissed' Пользователь отклонил объявление с вознаграждением, не досмотрев его до конца.
'viewed' Объявление было просмотрено пользователем

Примечание : adBreakDone() всегда является последним обратным вызовом, который вызывает adBreak() .

Если вы используете afterAd() для возобновления игры после показа рекламы, то adBreakDone() будет вызван после перезапуска игры. Для таких задач, как ведение журнала аналитики, это может быть удобно, но если вы хотите выполнить дополнительные действия перед перезапуском игры, перенесите логику возобновления игры из afterAd() в adBreakDone() .