SDK para Node

Este SDK de Node.js está diseñado para rastrear interacciones de usuarios, como clics, impresiones, conversiones y otros eventos, en sus aplicaciones web.

Comenzar

Para comenzar a rastrear usando el SDK de Node de Offer18, necesitarás integrar el SDK en tu aplicación web como un módulo de Node.

Encuentra la versión estable más reciente del paquete de Node

Logonpm: offer18-sdknpm

Instalación

Puedes instalar el paquete usando npm:

npm install offer18-sdk

o

npm i offer18-sdk

Uso

Importar

import Offer18SDK from 'offer18-sdk';

Inicializar

const Offer18WebSDK = new Offer18SDK();

Métodos disponibles

// Inicializar Conversión
Offer18WebSDK.initializeConversion('YOUR-CLICK-ID-PARAMETER');

// Registrar Clic
Offer18WebSDK.trackClick(options);

// Registrar Impresión
Offer18WebSDK.trackImpression(options);

// Registrar Conversión
Offer18WebSDK.trackConversion(options);

// Restablecer Cookies
Offer18WebSDK.clearCookies();

// Habilitar Registrador
Offer18WebSDK.activateDebugMode();

Flujo de conversión

El flujo de conversión es la secuencia en la cual solo las conversiones serán rastreadas por el SDK de Node. Para implementar el flujo de conversión, después de inicializar el SDK, necesitas agregar métodos en el siguiente orden::

Colocación: Carga de página o después de que el componente se monte

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

luego

Colocación: Página de agradecimiento/Página de éxito de pedido

Offer18WebSDK.trackConversion(options);

Saber más sobre YOUR-CLICK-ID-PARAMETER & opciones en Resumen del método

Flujo del SDK

El flujo del SDK es la secuencia que permite a los usuarios rastrear todo el proceso de conversión en el SDK de Node, incluyendo el rastreo de impresiones, clics y conversiones. Después de inicializar el SDK, necesitas agregar métodos en el siguiente orden:

Colocación: Carga de página o después de que el componente se monte

Offer18WebSDK.trackImpression(options)

luego

Colocación: Puede colocarse en todas las páginas (en la carga de la página o después de que el componente se monte)

Offer18WebSDK.trackClick(options);

luego

Colocación: Página de agradecimiento/Página de éxito de pedido

Offer18WebSDK.trackConversion(options);

Saber más sobre opciones en Resumen del método

Resumen del método

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

Este método se usa para inicializar la conversión. Debes agregar este método ya sea en la carga de la página o después de que el componente se monte.

Reemplaza YOUR-CLICK-ID-PARAMETER con la clave de parámetro que se usa para aceptar el valor desde el {tid} token en la URL de la oferta.

trackClick(options)

Este método se utiliza para rastrear clics.

  • Parámetros:

    • opciones (object): Opciones de configuración.

Parámetro
Tipo
Descripción

trackingURL

cadena

Obligatorio: URL de rastreo que puede extraerse del panel de Offer18

keymapping

matriz

Una matriz de parámetros de Offer18 y parámetros nativos en el formato <OFFER18-PARAMETER>:<YOUR-PARAMETER>. El usuario puede reemplazar <OFFER18-PARAMETER> con Parámetros de Offer18 como aff_sub1, aff_sub2 y <YOUR-PARAMETER> con sus parámetros en los cuales el usuario está obteniendo valores de su red.

Código de ejemplo 

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

trackImpression(options)

Este método se utiliza para rastrear impresiones.

  • Parámetros:

    • opciones (object): Opciones de configuración.

Parámetro
Tipo
Descripción

impressionURL

cadena

Obligatorio: URL de rastreo que puede extraerse del panel de Offer18

keymapping

matriz

Una matriz de parámetros de Offer18 y parámetros nativos en el formato <OFFER18-PARAMETER>:<YOUR-PARAMETER>. El usuario puede reemplazar <OFFER18-PARAMETER> con Parámetros de Offer18 como aff_sub1, aff_sub2 y <YOUR-PARAMETER> con sus parámetros en los cuales el usuario está obteniendo valores de su red.

Código de ejemplo 

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

trackConversion(options)

Este método se utiliza para rastrear conversiones.

  • Parámetros:

    • opciones (object): Opciones de configuración.

Parámetro
Tipo
Descripción

domain

cadena

Obligatorio: Dominio de postback del usuario.

accountId

cadena

Obligatorio: id de cuenta de Offer18 del usuario.

offerId

cadena

Obligatorio: Id de la campaña.

cupón

cadena

El código de cupón puede usarse aquí.

postbackType

cadena

Puede ser 'iframe' o 'pixel', el valor predeterminado es 'iframe'.

isGlobalPixel

boolean

El usuario puede configurar un píxel global estableciendo esto en true, el valor predeterminado es false.

allowMultiConversion

boolean

El usuario puede permitir MultiConversion estableciendo esto en true, el valor predeterminado es false.

conversionData

objeto

Este objeto contiene los parámetros que pueden usarse para obtener valores de la red.

conversionData Objeto

Parámetro
Tipo
Descripción

event

cadena

Nombre del evento (Por favor especifica el evento)

payout

cadena

Monto de la comisión (Por favor especifica el monto de la comisión)

venta

cadena

Monto de la venta (Por favor especifica el monto de la venta)

currency

cadena

Código de moneda

adv_sub1

cadena

Sub parámetro del anunciante 1

adv_sub2

cadena

Sub parámetro del anunciante 2

adv_sub3

cadena

Sub parámetro del anunciante 3

adv_sub4

cadena

Sub parámetro del anunciante 4

adv_sub5

cadena

Sub parámetro del anunciante 5

Código de ejemplo

Offer18WebSDK.trackConversion({
        domain: '',
        accountId: '',
        offerId: '',
        coupon:'',
        postbackType: '', // 'iframe' o 'pixel'
        isGlobalPixel: false, // true o false
        allowMultiConversion: false, // true o false
        conversionData: {
            event: '', // Nombre del evento (Por favor especifique el evento)
            payout: '', // Monto de la comisión (Por favor especifique el monto de la comisión)
            sale: '', // Monto de la venta (Por favor especifique el monto de la venta)
            currency: '',
            adv_sub1: '',
            adv_sub2: '',
            adv_sub3: '',
            adv_sub4: '',
            adv_sub5: '',
        }
    });

clearCookies()

Este método se utiliza para eliminar todas las cookies de primera parte añadidas por este paquete.

activateDebugMode()

Este método se utiliza para habilitar el registrador. Los registros de cada acción realizada por este paquete serán visibles en la consola de herramientas de desarrollador del navegador. Debes agregar este método inmediatamente después de inicializar el SDK

Compatibilidad del SDK de Node con frameworks y bibliotecas de frontend

Los siguientes frontend frameworks y bibliotecas son compatibles con los SDKs de Node y pueden usarlos sin problemas vía 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

AnteriorSDK para AndroidSiguienteRastrear el recorrido del usuario

Última actualización

¿Te fue útil?