SDK de 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.

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

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

---

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.initializeUrlParam('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();

// Activar registrador
Offer18WebSDK.activateDebugMode();

---

Flujo de conversión

El flujo de conversión es la secuencia en la que 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::

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

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

entonces

Ubicació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:

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

Offer18WebSDK.trackImpression(options)

entonces

Ubicación: Se puede colocar en todas las páginas (en la carga de la página o después de que el componente se monte)

Offer18WebSDK.trackClick(options);

entonces

Ubicació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 utiliza 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 del {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	string	Obligatorio: URL de seguimiento que puede extraerse del panel de Offer18
keymapping	array	Un arreglo 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 de los cuales el usuario obtiene 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	string	Obligatorio: URL de seguimiento que puede extraerse del panel de Offer18
keymapping	array	Un arreglo 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 de los cuales el usuario obtiene 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
dominio	string	Obligatorio: Dominio de postback del usuario.
accountId	string	Obligatorio: Id de cuenta de Offer18 del usuario.
offerId	string	Obligatorio: Id de la campaña.
cupón	string	Aquí se puede usar el código de cupón.
postbackType	string	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	object	Este objeto contiene los parámetros que pueden usarse para obtener valores de la red.

conversionData Objeto

Parámetro	Tipo	Descripción
evento	string	Nombre del evento (Por favor especifica el evento)
payout	string	Monto del pago (Por favor especifica el monto del pago)
sale	string	Monto de la venta (Por favor especifica el monto de la venta)
moneda	string	Código de moneda
adv_sub1	string	Parámetro sub del anunciante 1
adv_sub2	string	Parámetro sub del anunciante 2
adv_sub3	string	Parámetro sub del anunciante 3
adv_sub4	string	Parámetro sub del anunciante 4
adv_sub5	string	Parámetro sub del anunciante 5

Código de ejemplo

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 se utiliza para eliminar todas las cookies de primera parte agregadas 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 desarrollo del navegador. Debes agregar este método inmediatamente después de inicializar el SDK

Compatibilidad del SDK de Node con frameworks y bibliotecas frontend

Los siguientes frameworks y bibliotecas son compatibles con los SDKs de Node y pueden usarse 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