Node SDK

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

开始使用

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

查找最新稳定版本的 Node 包

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

可用方法

// 初始化转化
Offer18WebSDK.initializeConversion('YOUR-CLICK-ID-PARAMETER');

// 注册点击
Offer18WebSDK.trackClick(options);

// 注册展示
Offer18WebSDK.trackImpression(options);

// 注册转化
Offer18WebSDK.trackConversion(options);

// 重置 Cookies
Offer18WebSDK.clearCookies();

// 启用日志记录器
Offer18WebSDK.activateDebugMode();

转化流程

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

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

Offer18WebSDK.initializeConversion('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} 要约 URL 中的 token 的参数键一起使用。

trackClick(options)

此方法用于跟踪点击。

参数:
- 选项 (object): 配置选项。

参数

类型

描述

trackingURL

字符串

必填: 可从 Offer18 仪表板提取的跟踪 URL

keymapping

数组

一个以格式表示的 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)

此方法用于跟踪展示。

参数:
- 选项 (object): 配置选项。

参数

类型

描述

impressionURL

字符串

必填: 可从 Offer18 仪表板提取的跟踪 URL

keymapping

数组

示例代码

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

trackConversion(options)

此方法用于跟踪转化。

参数:
- 选项 (object): 配置选项。

参数

类型

描述

domain

字符串

必填: 用户的回传域名。

accountId

字符串

必填: 用户的 Offer18 帐户 id。

offerId

字符串

必填: 活动的 Id。

coupon

字符串

这里可以使用优惠券代码。

postbackType

字符串

它可以是 'iframe' 或 'pixel'，默认值为 'iframe'。

isGlobalPixel

布尔值

用户可以通过将此项设置为 true 来配置全局像素，默认值为 false。

allowMultiConversion

布尔值

用户可以通过将此项设置为 true 来允许多次转化，默认值为 false。

conversionData

对象

此对象包含可用于从网络获取值的参数。

conversionData 对象

参数

类型

描述

event

字符串

事件名称（请指定事件）

支付金额

字符串

支付金额（请指定支付金额）

sale

字符串

销售金额（请指定销售金额）

currency

字符串

货币代码

adv_sub1

字符串

广告主子参数 1

adv_sub2

字符串

广告主子参数 2

adv_sub3

字符串

广告主子参数 3

adv_sub4

字符串

广告主子参数 4

adv_sub5

字符串

广告主子参数 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

上一页Android SDK 下一页跟踪用户旅程

最后更新于6个月前

这有帮助吗？