For the complete documentation index, see llms.txt. This page is also available as Markdown.

SDK de Node

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

Comenzar

Para empezar a realizar el seguimiento usando el SDK de Node de Offer18, deberás integrar el SDK en tu aplicación web como un módulo de Node.

Encuentra la última versión estable del paquete de Node


Instalación

Puedes instalar el paquete usando npm:

o


Uso

Importar

Inicializar

Métodos disponibles


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 añadir métodos en el siguiente orden::

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

luego

Ubicación: página de agradecimiento/página de éxito del pedido

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 seguimiento de impresiones, clics y conversiones. Después de inicializar el SDK, necesitas añadir métodos en el siguiente orden:

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

luego

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

luego

Ubicación: página de agradecimiento/página de éxito del pedido

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 añadir este método ya sea al cargar la página o después de que el componente se monte.

Reemplaza YOUR-CLICK-ID-PARAMETER con la clave del 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 (objeto): Opciones de configuración.

Parámetro
Tipo
Descripción

trackingURL

cadena

Obligatorio: URL de seguimiento que se puede extraer del panel de Offer18

keymapping

array

Un arreglo de parámetros de Offer18 y parámetros nativos en el formato <PARÁMETRO-OFFER18>:<TU-PARÁMETRO>. El usuario puede reemplazar <PARÁMETRO-OFFER18> con parámetros de Offer18 como aff_sub1, aff_sub2 y <TU-PARÁMETRO> con sus parámetros en los que el usuario está obteniendo valores de su red.

Código de ejemplo

trackImpression(options)

Este método se utiliza para rastrear impresiones.

  • Parámetros:

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

Parámetro
Tipo
Descripción

impressionURL

cadena

Obligatorio: URL de seguimiento que se puede extraer del panel de Offer18

keymapping

array

Un arreglo de parámetros de Offer18 y parámetros nativos en el formato <PARÁMETRO-OFFER18>:<TU-PARÁMETRO>. El usuario puede reemplazar <PARÁMETRO-OFFER18> con parámetros de Offer18 como aff_sub1, aff_sub2 y <TU-PARÁMETRO> con sus parámetros en los que el usuario está obteniendo valores de su red.

Código de ejemplo

trackConversion(options)

Este método se utiliza para rastrear conversiones.

  • Parámetros:

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

Parámetro
Tipo
Descripción

dominio

cadena

Obligatorio: dominio de postback del usuario.

accountId

cadena

Obligatorio: ID de la cuenta Offer18 del usuario.

offerId

cadena

Obligatorio: ID de la campaña.

cupón

cadena

El código de cupón se puede usar aquí.

postbackType

cadena

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

isGlobalPixel

booleano

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

allowMultiConversion

booleano

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

conversionData

objeto

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

conversionData Objeto

Parámetro
Tipo
Descripción

evento

cadena

Nombre del evento (especifica el evento)

payout

cadena

Monto del pago (especifica el monto del pago)

sale

cadena

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

currency

cadena

Código de moneda

adv_sub1

cadena

Subparámetro 1 del anunciante

adv_sub2

cadena

Subparámetro 2 del anunciante

adv_sub3

cadena

Subparámetro 3 del anunciante

adv_sub4

cadena

Subparámetro 4 del anunciante

adv_sub5

cadena

Subparámetro 5 del anunciante

Código de ejemplo

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 añadir este método inmediatamente después de inicializar el SDK

Compatibilidad del SDK de Node con frameworks y bibliotecas de frontend

Los siguientes frameworks y bibliotecas de frontend son compatibles con los SDK de Node y pueden usarlos sin problemas a través de npm:

Última actualización