рекламный перерыв()

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

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 placementInfo() .
Только места с вознаграждением...
beforeReward функция Вызывается, если доступна реклама с вознаграждением. Функция должна принимать один аргумент — showAdFn() , который должен быть вызван для отображения рекламы с вознаграждением.
adDismissed функция Вызывается только для рекламы с вознаграждением, когда игрок закрывает рекламу. Он вызывается только в том случае, если игрок закрывает объявление до его завершения. В этом случае вознаграждение не должно быть предоставлено.
adViewed функция Вызывается только для объявлений с вознаграждением, когда игрок завершает объявление и должен получить вознаграждение.

adBreakDone() and placementInfo PlacementInfo

Если в Ad Placement 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' Ad Placement API не инициализирован
'timeout' Время ожидания места размещения истекло, так как Ad Placement API слишком долго не отвечал.
'invalid' Размещение было недопустимым и было проигнорировано — например, должно быть только одно место размещения перед просмотром на одну загрузку страницы, последующие предварительные показы не выполняются с этим статусом.
'error' Ошибка JavaScript в обратном вызове
'noAdPreloaded' Объявление еще не было предварительно загружено, поэтому это место размещения было пропущено.
'frequencyCapped' Объявление не было показано, поскольку к этому месту размещения было применено ограничение частоты показов.
'ignored' Пользователь не нажал на приглашение к вознаграждению до того, как достиг следующего места размещения, то есть showAdFn() не был вызван до следующего adBreak() .
'other' Объявление не было показано по другой причине. (например, объявление по-прежнему загружалось или ранее кэшированное объявление было удалено из-за изменения размера/поворота экрана.)
'dismissed' Пользователь отклонил рекламу с вознаграждением, не досмотрев ее до конца.
'viewed' Объявление было просмотрено пользователем

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

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