Référence API

Méthodes Adsgram

init

Crée un AdController qui est utilisé pour afficher, charger et détruire la publicité.
Il suffit d'initialiser une seule fois pour un blockId.
Si vous appelez la fonction init avec le même blockId plus d'une fois, vous obtiendrez le même AdController pour ce blockId.

Syntaxe

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

Paramètres

blockId

Chaîne avec des chiffres, par exemple "123".
L'identifiant unique du bloc publicitaire que vous recevez dans l'espace éditeur.
Instructions détaillées sur la façon d'obtenir le blockId dans la section Obtenir un blockId

debug Optional

Valeur booléenne si définie sur true, vous obtiendrez une réponse du serveur avec une publicité de test et des logs détaillés avec le préfixe ADSGRAM DEBUG LOG seront affichés dans la console du navigateur pour le débogage de l'intégration.

DANGER

N'oubliez pas de supprimer ou de définir sur false lors de la mise en production.
Nous n'ajoutons pas les impressions de publicités de test aux statistiques, donc vous ne verrez pas les statistiques de ses impressions, affichages, clics, etc. sur la page de la plateforme et du bloc.
La requête vers Reward Url ne sera pas envoyée.

debugConsole Optional

Valeur booléenne. Par défaut true. Fonctionne uniquement si le paramètre debug est true.
Si true, les logs détaillés avec le préfixe ADSGRAM DEBUG LOG seront affichés dans la console du navigateur. Si false, les logs ne sont pas affichés dans la console, même en mode debug.

debugBannerType Optional

Les valeurs possibles sont "FullscreenMedia" et "RewardedVideo".
Utilisez cette valeur lorsque vous souhaitez obtenir un type de bannière de test exact. Fonctionne uniquement si le paramètre debug est égal à true.

Valeur de retour

AdController

Méthodes AdController

show

Charge et affiche la publicité.

Syntaxe

javascript

AdController.show();

typescript

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

Valeur de retour

La Promise qui devient résolue si l'utilisateur regarde la publicité jusqu'au bout, sinon rejetée.
Le résultat de la promesse a les types suivants :

interface ShowPromiseResult {
  done: boolean; // true if user watch till the end, otherwise false
  description: string; // event description
  state: 'load' | 'render' | 'playing' | 'destroy'; // banner state
  error: boolean; // true if event was emitted due to error, otherwise false
}

Exemples

Utilisation de l'API promises :

javascript

AdController.show().then((result) => {
  // user watch ad till the end
  // your code to reward user
}).catch((result) => {
  // user get error during playing ad or skip ad
  // do nothing or whatever you want
})

typescript

AdController.show().then((result: ShowPromiseResult) => {
  // user watch ad till the end
  // your code to reward user
}).catch((result: ShowPromiseResult) => {
  // user get error during playing ad or skip ad
  // do nothing or whatever you want
})

Vous pouvez également obtenir le même comportement en utilisant await

javascript

try {
  const showPromiseResult = await AdController.show();
  // user watch ad till the end
  // your code to reward user
} catch (showPromiseResult) {
  // user get error during playing ad or skip ad
  // do nothing or whatever you want
}

typescript

try {
  const showPromiseResult: ShowPromiseResult = await AdController.show();
  // user watch ad till the end
  // your code to reward user
} catch (showPromiseResult: ShowPromiseResult) {
  // user get error during playing ad or skip ad
  // do nothing or whatever you want
}

TIP

Enchaînez la promesse avec finally si vous devez ajouter une action supplémentaire après la fin de la lecture de la publicité, son ignorance ou une erreur.

destroy

Pour arrêter l'affichage de la publicité et supprimer les données de bannière chargées.

Syntaxe

AdController.destroy();

Valeur de retour

None(undefined)

INFO

Généralement, vous n'avez pas besoin de l'appeler manuellement, en cas d'erreur, d'ignorance ou de publicité entièrement regardée, la publicité sera automatiquement détruite.

addEventListener

S'abonne à un event et invoque la fonction callback si l'event est déclenché.
Utilisé si vous avez besoin de plus de contrôle sur l'affichage des publicités.

Syntaxe

AdController.addEventListener('onReward', () => {
    // your code to reward user
});

Paramètres

event

Types d'événements :

Événement	Se produit
onStart	lorsque la première frame de bannière est affichée
onSkip	lorsque l'utilisateur ferme la publicité
onReward	lorsque l'utilisateur a regardé la bannière rewarded jusqu'au bout
onComplete	lorsque l'utilisateur a regardé la bannière interstitial jusqu'au bout ou l'a fermée
onError	lorsque l'utilisateur obtient une erreur pendant le rendu ou la lecture de la bannière
onBannerNotFound	lorsqu'il n'y a pas de bannière à afficher
onNonStopShow	lorsque l'utilisateur essaie de regarder plusieurs publicités à la suite
onTooLongSession	lorsque la session est trop longue, l'utilisateur doit redémarrer l'application pour obtenir des publicités

TIP

Si vous souhaitez afficher votre alerte personnalisée, vous pouvez vous abonner à onBannerNotFound, onNonStopShow ou onTooLongSession.
Sinon, nous afficherons l'alerte par défaut.
L'alerte est affichée dans la langue de l'utilisateur ou en anglais
et ressemble à ceci 👇

callback

Fonction qui sera invoquée lorsqu'un événement du type spécifié se produit.

Valeur de retour

None(undefined)

removeEventListener

Se désabonne à l'event avec le callback déterminé

Syntaxe

AdController.removeEventListener('onReward', rewardFunction);

Paramètres

Les mêmes que dans addEventListener

Valeur de retour

None(undefined)