API Reference

Методы Adsgram

init

Инициализирует AdController, который используется для загрузки, показа и прекращения показа рекламы.
Достаточно один раз инициализировать для одного blockId.
Если вы вызываете init с тем же blockId несколько раз, будет возвращён тот же AdController.

Синтаксис

const AdController = window.Adsgram.init({
  blockId: "your-block-id",
  debug: true,
  debugBannerType: "FullscreenMedia"
});

Параметры

blockId

Строка с цифрами, например, "123".
Уникальный идентификатор рекламного блока, доступный в аккаунте издателя.
Подробнее о получении BlockId в разделе Получить blockId.

debug опционально

Логическое значение. Если true, сервер возвращает тестовую рекламу.

ВНИМАНИЕ:

Убедитесь, что параметр установлен в false перед выпуском в production.
Тестовые показы не учитываются в статистике, а запросы к Reward URL не отправляются.

debugBannerType опционально

Возможные значения: "FullscreenMedia" и "RewardedVideo".
Указывает тип тестового баннера. Работает только если параметр debug равен true.

Возвращаемое значение

AdController: объект для управления рекламой.

Методы AdController

show

Загружает и показывает рекламу.

Синтаксис

javascript

AdController.show();

typescript

const showPromise: Promise<ShowPromiseResult> = AdController.show();

Возвращаемое значение

Promise , который:

• Резолвится, если пользователь досмотрел рекламу до конца или пропустил рекламу для Interstitial формата.
• Реджектится, если у пользователя возникла ошибка.

Результат промиса

interface ShowPromiseResult {
  done: boolean; // true, если реклама досмотрена до конца, иначе false
  description: string; // описание события
  state: 'load' | 'render' | 'playing' | 'destroy'; /// состояние баннера
  error: boolean; // true, если возникла ошибка, иначе false
}

Примеры

Используя promises API:

javascript

AdController.show().then((result) => {
  // Пользователь досмотрел рекламу до конца
  // Ваш код для награждения пользователя
}).catch((result) => {
  // Ошибка или пользователь пропустил рекламу
  // Ваш код на случай ошибки
})

typescript

AdController.show().then((result: ShowPromiseResult) => {
  // Пользователь досмотрел рекламу до конца
  // Ваш код для награждения пользователя
}).catch((result: ShowPromiseResult) => {
  // Ошибка или пользователь пропустил рекламу
  // Ваш код на случай ошибки
})

Использование с await:

javascript

try {
  const showPromiseResult = await AdController.show();
  // Пользователь досмотрел рекламу до конца
  // Ваш код для награждения пользователя
} catch (showPromiseResult) {
  // Ошибка или пользователь пропустил рекламу
  // Ваш код на случай ошибки
}

typescript

try {
  const showPromiseResult: ShowPromiseResult = await AdController.show();
  // Пользователь досмотрел рекламу до конца
  // Ваш код для награждения пользователя
} catch (showPromiseResult: ShowPromiseResult) {
  // Ошибка или пользователь пропустил рекламу
  // Ваш код на случай ошибки
}

Совет:

Используйте finally для выполнения действий после завершения рекламы.

destroy

Прекращает показ рекламы и удаляет загруженные данные.

Синтаксис

AdController.destroy();

Возвращаемое значение

None(undefined)

Информация:

Обычно вызов destroy не требуется. В случае ошибки, пропуска или полного просмотра показ рекламы прекращается автоматически.

addEventListener

Подписывается на событие и вызывает функцию обратного вызова, если событие произошло.

Синтаксис

AdController.addEventListener('onReward', () => {
    // Ваш код для награждения пользователя
});

Параметры

event

тип события:

Событие	Когда возникант
onStart	первый кадр баннера отображён
onSkip	пользователь закрыл рекламу
onReward	пользователь досмотрел Rewarded баннер до конца
onComplete	пользователь досмотрел Interstitial баннер или закрыл его
onError	ошибка при воспроизведении или рендере баннера
onBannerNotFound	баннер для показа отсутствует
onNonStopShow	пользователь пытается посмотреть несколько реклам подряд

Совет:

Вы можете подписаться на события onBannerNotFound или onNonStopShow, если вы хотите показывать свой собственный alert.
Иначе отобразится alert по умолчанию.
Языком уведомления будет язык пользователя или английский 👇

callback

Функция, вызываемая при наступлении события.

Возвращаемое значение

None(undefined)

removeEventListener

Отписывается от события.

Синтаксис

AdController.removeEventListener('onReward', rewardFuction);

Параметры

Те же, что в addEventListener

Возвращаемое значение

None(undefined)