Node SDK

Este SDK Node.js é projetado para rastrear interações do usuário, como cliques, impressões, conversões e outros eventos, em suas aplicações web

Começar

Para começar a rastrear usando o Node SDK da Offer18, você precisará integrar o SDK ao seu aplicativo web como um módulo Node.

Encontre a versão estável mais recente do pacote Node

https://www.npmjs.com/package/offer18-sdkwww.npmjs.com

Instalação

Você pode instalar o pacote usando npm:

npm install offer18-sdk

ou

npm i offer18-sdk

Uso

Importar

import Offer18SDK from 'offer18-sdk';

Inicializar

const Offer18WebSDK = new Offer18SDK();

Métodos disponíveis

// Inicializar Conversão
Offer18WebSDK.initializeConversion('YOUR-CLICK-ID-PARAMETER');

// Registrar Clique
Offer18WebSDK.trackClick(options);

// Registrar Impressão
Offer18WebSDK.trackImpression(options);

// Registrar Conversão
Offer18WebSDK.trackConversion(options);

// Redefinir Cookies
Offer18WebSDK.clearCookies();

// Ativar Logger
Offer18WebSDK.activateDebugMode();

Fluxo de conversão

O fluxo de conversão é a sequência em que apenas conversões serão rastreadas pelo Node SDK. Para implementar o fluxo de conversão, após inicializar o SDK, você precisa adicionar métodos na seguinte ordem::

Posicionamento: Carregamento da página ou após o componente ser montado

Offer18WebSDK.initializeConversion('YOUR-CLICK-ID-PARAMETER');

então

Posicionamento: Página de agradecimento/Página de sucesso do pedido

Offer18WebSDK.trackConversion(options);

Saiba mais sobre YOUR-CLICK-ID-PARAMETER & opções em Visão geral do método

Fluxo do SDK

O fluxo do SDK é a sequência que permite aos usuários rastrear todo o processo de conversão no Node SDK, incluindo rastreamento de impressões, cliques e conversões. Após inicializar o SDK, você precisa adicionar métodos na seguinte ordem:

Posicionamento: Carregamento da página ou após o componente ser montado

Offer18WebSDK.trackImpression(options)

então

Posicionamento: Pode ser colocado em todas as páginas (no carregamento da página ou após o componente ser montado)

Offer18WebSDK.trackClick(options);

então

Posicionamento: Página de agradecimento/Página de sucesso do pedido

Offer18WebSDK.trackConversion(options);

Saiba mais sobre opções em Visão geral do método

Visão geral do método

initializeConversion('YOUR-CLICK-ID-PARAMETER')

Este método é usado para inicializar a conversão. Você precisa adicionar este método no carregamento da página ou após o componente ser montado.

Substitua YOUR-CLICK-ID-PARAMETER com a chave de parâmetro que é usada para aceitar o valor do {tid} token na URL da oferta.

trackClick(options)

Este método é utilizado para rastrear cliques.

  • Parâmetros:

    • opções (object): Opções de configuração.

Parâmetro
Tipo
Descrição

trackingURL

string

Obrigatório: URL de rastreamento que pode ser extraída do painel da Offer18

keymapping

array

Um array de parâmetros da Offer18 e parâmetros nativos no formato <OFFER18-PARAMETER>:<YOUR-PARAMETER>. O usuário pode substituir <OFFER18-PARAMETER> com parâmetros da Offer18 como aff_sub1, aff_sub2 e <YOUR-PARAMETER> pelos parâmetros do usuário nos quais ele obtém valores da sua rede.

Código de exemplo 

Offer18WebSDK.trackClick({
    trackingURL: 'https://example.o18.click/c?o=0000000&m=0000',
    keymapping: ['a:<YOUR-PARAMETER>']
});

trackImpression(options)

Este método é utilizado para rastrear impressões.

  • Parâmetros:

    • opções (object): Opções de configuração.

Parâmetro
Tipo
Descrição

impressionURL

string

Obrigatório: URL de rastreamento que pode ser extraída do painel da Offer18

keymapping

array

Um array de parâmetros da Offer18 e parâmetros nativos no formato <OFFER18-PARAMETER>:<YOUR-PARAMETER>. O usuário pode substituir <OFFER18-PARAMETER> com parâmetros da Offer18 como aff_sub1, aff_sub2 e <YOUR-PARAMETER> pelos parâmetros do usuário nos quais ele obtém valores da sua rede.

Código de exemplo 

Offer18WebSDK.trackImpression({
    impressionURL: 'https://example.o18.click/i?o=0000000&m=0000',
    keymapping: ['a:<YOUR-PARAMETER>']
});

trackConversion(options)

Este método é utilizado para rastrear conversões.

  • Parâmetros:

    • opções (object): Opções de configuração.

Parâmetro
Tipo
Descrição

domain

string

Obrigatório: Domínio de postback do usuário.

accountId

string

Obrigatório: id da conta Offer18 do usuário.

offerId

string

Obrigatório: Id da campanha.

cupom

string

Código de cupom pode ser usado aqui.

postbackType

string

Pode ser 'iframe' ou 'pixel', o valor padrão é 'iframe'.

isGlobalPixel

boolean

O usuário pode configurar pixel global definindo isto como true, o valor padrão é false.

allowMultiConversion

boolean

O usuário pode permitir MultiConversion definindo isto como true, o valor padrão é false.

conversionData

objeto

Este objeto contém os parâmetros que podem ser usados para obter valores da rede.

conversionData Objeto

Parâmetro
Tipo
Descrição

event

string

Nome do evento (Por favor especifique o evento)

payout

string

Valor de pagamento (Por favor especifique o valor do pagamento)

sale

string

Valor da venda (Por favor especifique o valor da venda)

currency

string

código da moeda

adv_sub1

string

Parâmetro sub do anunciante 1

adv_sub2

string

Parâmetro sub do anunciante 2

adv_sub3

string

Parâmetro sub do anunciante 3

adv_sub4

string

Parâmetro sub do anunciante 4

adv_sub5

string

Parâmetro sub do anunciante 5

Código de exemplo

Offer18WebSDK.trackConversion({
        domain: '',
        accountId: '',
        offerId: '',
        coupon:'',
        postbackType: '', // 'iframe' or 'pixel'
        isGlobalPixel: false, // true or false
        allowMultiConversion: false, // true or false
        conversionData: {
            event: '', // Event Name (Please specify the event)
            payout: '', // Payout Amount (Please specify the payout amount)
            sale: '', // Sale Amount (Please specify the sale amount)
            currency: '',
            adv_sub1: '',
            adv_sub2: '',
            adv_sub3: '',
            adv_sub4: '',
            adv_sub5: '',
        }
    });

clearCookies()

Este método é utilizado para remover todos os cookies de primeira parte adicionados por este pacote.

activateDebugMode()

Este método é utilizado para ativar o logger. Logs de cada ação realizada por este pacote serão visíveis no console das ferramentas de desenvolvedor do navegador. Você precisa adicionar este método imediatamente após inicializar o SDK

Compatibilidade do Node SDK com frameworks e bibliotecas frontend

Os seguintes frontend frameworks e bibliotecas são compatíveis com os Node SDKs e podem usá-los perfeitamente via npm:

Next.js, Nuxt.js, SvelteKit, Gatsby, Remix, RedwoodJS, Blitz.js, Astro, Eleventy (11ty), React Static, Gridsome, VuePress, Quasar Framework, Razzle, Preact CLI, NestLand, Hydrogen, Marko, Inferno, Vite, React, Vue.js, Svelte, Preact, SolidJS, Alpine.js, Lit, Stencil.js, Hyperapp, Riot.js, Mithril.js

AnteriorAndroid SDKPróximoRastrear Jornada do Usuário

Atualizado

Isto foi útil?