网络应用的 Appabase SDK
一个很小的 SDK ( 1 kB) 用 Aptabase 为您的网络应用程序提供设备, 一个开放源码, 用于移动、 桌面和网络应用程序的隐私第一和简单分析 .
建立反应应用程序? 使用 @aptabase/react 软件包.
👉 重要性
这个SDK是给 网络应用程序,而不是网站。 有一种微妙而重要的区别. 一个网络应用程序通常会有更多的互动性,当用户与它互动时不会导致一个完整页面再加载. 它经常被称作 单页应用程序另一方面,网站更注重内容,如营销网站、登陆网页、博客等。 虽然您肯定可以使用 Aptabase 来跟踪网站上的事件, 但请注意每个页面重载将被视为一个新会话 .
安装
使用 npm 或您喜欢的 JavaScript 软件包管理器安装 SDK
npm add @aptabase/web
使用量
首先,你需要获得你的 App Key 从Aptabase可以找到它 Instructions 菜单.
使用您的 SDK 初始化 App Key数字 :
import { init } from '@aptabase/web';
init('<YOUR_APP_KEY>'); // 👈 this is where you enter your App Key
Init 函数还支持一个可选的第二个参数,它是一个带有 appVersion 属性.
如何获得你的应用软件版本,由您决定,但一般建议使用你的捆绑器(如Webpack,Vite,Rollup等)在构建时注入数值. 或者您也可以手动传递.
之后你可以开始跟踪事件 trackEvent数字 :
import { trackEvent } from '@aptabase/web';
trackEvent('connect_click'); // An event with no properties
trackEvent('play_music', { name: 'Here comes the sun' }); // An event with a custom property
几个重要说明:
- SDK会用一些有用的信息自动增强事件,比如OS和其他属性.
- 你控制着被送到阿普塔基地的东西 此 SDK 不自动跟踪任何事件, 您需要呼叫
trackEvent手动.- 因此,一般建议在启动时至少跟踪一个事件
- 你不需要等待着
trackEvent函数,会在后台运行. - 只允许自定义属性上的字符串和数字值