You need to enable JavaScript to run this app.
文档中心
增长分析(私有化)

增长分析(私有化)

复制全文
下载 pdf
服务端接入
Node.js SDK
复制全文
下载 pdf
Node.js SDK

DataFinder为您提供Node.js SDK,便于您对一些非网页进行埋点,例如Chrome插件进行埋点等场景。本文为您介绍Node.js SDK集成的操作指导。

准备工作

获取Appid

在开始集成前,首先需要在集团中拥有一个应用,进行SDK集成前,您需要获取对应应用的appid、app key、schema等信息。
私有化场景下您可以在「项目中心」->「项目管理」->「项目详情」-> 接入应用的「详情」->「应用ID」中可查看您的appid、app key、schema,详情请参见项目详情与应用列表
Image

获取上报地址

私有化部署场景下,您需要获取部署私有化环境时,自行规划配置的数据上送地址,如您不清楚此地址,请联系您的项目经理或客户成功经理。

集成SDK

step1:安装SDK

npm i @datarangers/sdk-node 
npm i @datarangers/node-plugin-http

step2:初始化 SDK

import { DataRangersSDK } from "@datarangers/sdk-node"; 
import { httpPlugin } from '@datarangers/node-plugin-http'; 

const sdk = new DataRangersSDK({ 
    app_id: 1234, // 传⼊申请的项⽬ appid ,必须是数字 
    logLevel: "verbose", // 开启本地⽇志打印,默认值为 silent 
    }); 

参数

配置说明

app_id

配置为您在DataFinder上创建应用时生成的应用标识ID,详情请参见上文的 获取Appid 章节。

logLevel

配置是否开启本地日志打印,取值枚举值如下。

  • "verbose" : 全量打印
  • "error" : 只打印错误信息
  • "silent" (默认值): 不打印⽇志

step3:设置数据上报地址

初始化SDK后,需要设置数据上报地址后,才可以上报埋点。

sdk.use(
   httpPlugin(
     {
        channel_domain: "https://***.****.com" // 设置上报域名,私有化环境下,您需要联系项目经理获取数据上报地址
     }
   )
);

step4:设置公共属性

需要设置登录⽤⼾id时,或者有全局的公共属性时,则可以使⽤config进⾏配置。

sdk.config({
  user: {
    user_unique_id: "xxx", // 设置全局的用户uuid
  },
  header: {
      os_name: 'xxx', // 设置、修改公共属性
  },
  custom: {
      key: 123 // 设置自定义公共属性
  }
});

step5:上报埋点

上报单个埋点

// 上报埋点
sdk.collect(
  "event_1", //埋点名称
  {
    event_param_a: 123,   //埋点属性
  }
);

批量上报埋点

批量上报埋点,即传⼊⼀个埋点数组即可。

// 批量上报埋点
sdk.collect([
  {
    name: "event_2",
    params: {
      event_param_b: 234,
    },
  },
  {
    name: "event_3",
    params: {
      event_param_c: 567,
    },
  },
]);
最近更新时间:2025.07.23 17:01:46
这个页面对您有帮助吗?
有用
有用
无用
无用