Node SDK

此 Node.js SDK 旨在跟踪你 Web 应用中的用户交互，如点击、展示、转化及其他事件

快速开始

要开始使用 Offer18 的 Node SDK 进行追踪，您需要将该 SDK 作为 node 模块集成到您的 Web 应用中。

查找最新稳定版的 Node Package

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

---

安装

您可以使用 npm 安装该包：

npm install offer18-sdk

或

npm i offer18-sdk

---

使用方法

导入

import Offer18SDK from 'offer18-sdk';

初始化

const Offer18WebSDK = new Offer18SDK();

可用方法

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

// Register Click
Offer18WebSDK.trackClick(options);

// Register Impression
Offer18WebSDK.trackImpression(options);

// Register Conversion
Offer18WebSDK.trackConversion(options);

// Reset Cookies
Offer18WebSDK.clearCookies();

// Enable Logger
Offer18WebSDK.activateDebugMode();

---

转化流程

转化流程是指仅通过 Node SDK 跟踪转化的顺序。要实现转化流程，在初始化 SDK 后，您需要按以下顺序添加方法：

位置：页面加载时或组件挂载后

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

然后

位置：感谢页/订单成功页

Offer18WebSDK.trackConversion(options);

了解更多关于 YOUR-CLICK-ID-PARAMETER & 选项 中的 方法概览

---

SDK 流程

SDK 流程是允许用户在 Node SDK 中跟踪整个转化过程的顺序，包括跟踪展示、点击和转化。在初始化 SDK 后，您需要按以下顺序添加方法：

位置：页面加载时或组件挂载后

Offer18WebSDK.trackImpression(options)

然后

位置：可放置在所有页面上（页面加载时或组件挂载后）

Offer18WebSDK.trackClick(options);

然后

位置：感谢页/订单成功页

Offer18WebSDK.trackConversion(options);

了解更多关于 选项 中的 方法概览

---

方法概览

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

此方法用于初始化转化。您需要在页面加载时或组件挂载后添加此方法。

将 YOUR-CLICK-ID-PARAMETER 替换为用于接收来自 {tid} offer URL 中 token 的参数键。

trackClick(options)

此方法用于跟踪点击。

• 参数:

  • 选项 （对象）：配置选项。

参数	类型	描述
trackingURL	string	必填：可从 Offer18 仪表盘提取的跟踪 URL
keymapping	array	一个包含 Offer18 参数和原生参数的数组，格式为 <OFFER18-PARAMETER>:<YOUR-PARAMETER>。用户可以将 <OFFER18-PARAMETER> 替换为 Offer18 参数，例如 aff_sub1, aff_sub2 以及 <YOUR-PARAMETER> 替换为其参数，即用户从其网络获取值的参数。

示例代码

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

trackImpression(options)

此方法用于跟踪展示。

• 参数:

  • 选项 （对象）：配置选项。

参数	类型	描述
impressionURL	string	必填：可从 Offer18 仪表盘提取的跟踪 URL
keymapping	array	一个包含 Offer18 参数和原生参数的数组，格式为 <OFFER18-PARAMETER>:<YOUR-PARAMETER>。用户可以将 <OFFER18-PARAMETER> 替换为 Offer18 参数，例如 aff_sub1, aff_sub2 以及 <YOUR-PARAMETER> 替换为其参数，即用户从其网络获取值的参数。

示例代码

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

trackConversion(options)

此方法用于跟踪转化。

• 参数:

  • 选项 （对象）：配置选项。

参数	类型	描述
domain	string	必填：用户的 postback 域名。
accountId	string	必填：用户的 Offer18 账户 ID。
offerId	string	必填：活动 ID。
coupon	string	这里可以使用优惠券代码。
postbackType	string	可以是 'iframe' 或 'pixel'，默认值为 'iframe'。
isGlobalPixel	boolean	用户可以通过将其设为 true 来配置全局像素，默认值为 false。
allowMultiConversion	boolean	用户可以通过将其设为 true 来允许多重转化，默认值为 false。
conversionData	object	此对象包含可用于从网络获取值的参数。

conversionData 对象

参数	类型	描述
event	string	事件名称（请指定事件）
payout	string	支付金额（请指定支付金额）
sale	string	销售金额（请指定销售金额）
currency	string	货币代码
adv_sub1	string	广告主子参数 1
adv_sub2	string	广告主子参数 2
adv_sub3	string	广告主子参数 3
adv_sub4	string	广告主子参数 4
adv_sub5	string	广告主子参数 5

示例代码

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()

此方法用于移除该包添加的所有第一方 cookie。

activateDebugMode()

此方法用于启用日志记录器。该包执行的每个操作的日志都将显示在浏览器开发者工具控制台中。您需要在初始化 SDK 后立即添加此方法

Node SDK 与前端框架和库的兼容性

以下前端 框架和库 与 Node SDK 兼容，并且可以通过 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