Referência de API

Métodos do Adsgram

init

Cria um AdController, que é usado para exibir, carregar e remover anúncios.
É suficiente inicializá-lo apenas uma vez para um blockId.
Se você chamar a função init com o mesmo blockId mais de uma vez, obterá o mesmo AdController para esse blockId.

Sintaxe

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

Parâmetros

blockId

Uma string com números, por exemplo "123".
Identificador único do bloco publicitário que você obtém no painel do editor.
Você encontrará instruções detalhadas para obter o blockId na seção Obter blockId

debug Opcional

Um valor booleano, se definido como true, você receberá uma resposta do servidor com anúncios de teste e logs detalhados com o prefixo ADSGRAM DEBUG LOG serão exibidos no console do navegador para depurar a integração.

ATENÇÃO:

Não se esqueça de removê-lo ou defini-lo como false ao lançar em produção.
Não adicionamos impressões de anúncios de teste às estatísticas, portanto você não verá as estatísticas de impressões, visualizações, cliques, etc. na página da plataforma e do bloco.
A requisição para Reward Url não será enviada.

debugConsole Opcional

Um valor booleano. Por padrão true. Funciona apenas se o parâmetro debug for true.
Se for true, os logs detalhados com o prefixo ADSGRAM DEBUG LOG serão exibidos no console do navegador. Se for false, os logs não são exibidos no console, mesmo no modo de depuração.

debugBannerType Opcional

Valores possíveis: "FullscreenMedia" e "RewardedVideo".
Use este valor quando quiser obter um tipo específico de banner de teste. Funciona apenas se o parâmetro debug for true.

Valor de retorno

AdController

Métodos do AdController

show

Carrega e exibe anúncios.

Sintaxe

javascript

AdController.show();

typescript

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

Valor de retorno

Uma Promise que é resolvida se o usuário viu o anúncio até o final, caso contrário é rejeitada.
O resultado da promessa tem os seguintes tipos:

interface ShowPromiseResult {
  done: boolean; // true se o usuário viu até o final, caso contrário false
  description: string; // descrição do evento
  state: 'load' | 'render' | 'playing' | 'destroy'; // estado do banner
  error: boolean; // true se o evento foi causado por um erro, caso contrário false
}

Exemplos

Uso da API de promessas:

javascript

AdController.show().then((result) => {
  // o usuário viu o anúncio até o final
  // seu código para recompensar o usuário
}).catch((result) => {
  // o usuário obteve um erro durante a reprodução do anúncio ou pulou o anúncio
  // não fazer nada ou fazer o que quiser
})

typescript

AdController.show().then((result: ShowPromiseResult) => {
  // o usuário viu o anúncio até o final
  // seu código para recompensar o usuário
}).catch((result: ShowPromiseResult) => {
  // o usuário obteve um erro durante a reprodução do anúncio ou pulou o anúncio
  // não fazer nada ou fazer o que quiser
})

Você também pode alcançar o mesmo comportamento com await

javascript

try {
  const showPromiseResult = await AdController.show();
  // o usuário viu o anúncio até o final
  // seu código para recompensar o usuário
} catch (showPromiseResult) {
  // o usuário obteve um erro durante a reprodução do anúncio ou pulou o anúncio
  // não fazer nada ou fazer o que quiser
}

typescript

try {
  const showPromiseResult: ShowPromiseResult = await AdController.show();
  // o usuário viu o anúncio até o final
  // seu código para recompensar o usuário
} catch (showPromiseResult: ShowPromiseResult) {
  // o usuário obteve um erro durante a reprodução do anúncio ou pulou o anúncio
  // não fazer nada ou fazer o que quiser
}

Dica:

Use finally para a promessa se você precisar adicionar alguma ação adicional após o término da reprodução do anúncio, ser pulado ou ocorrer um erro.

destroy

Interrompe a reprodução do anúncio e remove os dados do banner carregado.

Sintaxe

AdController.destroy();

Valor de retorno

None(undefined)

Informação:

Normalmente você não precisa chamar isso manualmente, em caso de erro, pulo ou visualização completa do anúncio, ele será removido automaticamente.

addEventListener

Inscreve-se em um event e chama a função callback quando o event é disparado.
É usado se você precisar de um controle maior sobre a exibição de anúncios.

Sintaxe

AdController.addEventListener('onReward', () => {
    // seu código para recompensar o usuário
});

Parâmetros

event

Tipos de eventos:

Evento	Ocorre quando
onStart	é exibido o primeiro quadro do banner
onSkip	o usuário fecha o anúncio
onReward	o usuário vê o banner reward até o final
onComplete	o usuário vê o banner interstitial até o final ou o fecha
onError	o usuário obtém um erro durante a reprodução ou exibição do banner
onBannerNotFound	não há um banner para exibir
onNonStopShow	o usuário tenta ver vários anúncios seguidos
onTooLongSession	a sessão é muito longa, o usuário precisa reiniciar o aplicativo para exibir anúncios

Dica:

Se você quiser exibir seu próprio alerta, pode se inscrever em onBannerNotFound, onNonStopShow ou onTooLongSession.
Caso contrário, exibiremos um alerta padrão.
O alerta é exibido no idioma do usuário ou em inglês
e se parece assim

callback

Função que será chamada quando o evento do tipo especificado ocorrer.

Valor de retorno

None(undefined)

removeEventListener

Cancela a inscrição do event com o callback indicado

Sintaxe

AdController.removeEventListener('onReward', rewardFunction);

Parâmetros

Os mesmos que em addEventListener

Valor de retorno

None(undefined)