@goplayerzero/sdk-web

中文文档
0.3.0发布于 2025/08/21MITTypeScriptES Module近 30 天下载 1万

官方 PlayerZero 网络 SDK

中文使用文档
文档目录10 节
  1. 安装
  2. 初始化 SDK
  3. 玩家Zero API
  4. 实例
  5. 使用 SDK
  6. 识别用户
  7. 跟踪自定义分析事件
  8. 生成 DevTools URL
  9. 补充资料
  10. 支助

玩家Zero网络 SDK

PlayerZero Web SDK使您能够将PlayerZero整合到您的网站或网络应用程序中. 通过这个SDK,你可以 管理 PlayerZero 初始化,识别用户,跟踪自定义分析事件,生成 DevTools 链接等. 对于 综合API文件, 访问 玩家Zero Docs。 。 。 .


安装

使用您首选的软件包管理器安装 SDK :

无

npm i @goplayerzero/sdk-web --save

用纱线

yarn add @goplayerzero/sdk-web

初始化 SDK

通话 init() 成功初始化后不止一次会触发控制台警告. 检查玩家Zero是否 已经初始化, 使用 PlayerZero.isInitialized()。 。 。 .

玩家Zero API

  • PlayerZero.init(apiToken: string, options: {endpoint?: string, privacyFnUrl?: string}) - 初始化 PlayerZero 与 您的 API 键和可选配置。 API Token 可见于 玩家Zero的游戏 Project Settings 下划线 Web SDK 区域.
  • PlayerZero.isInitialized(): Boolean - 回归 true 如果 PlayerZero 已经初始化.
  • PlayerZero.identify(userId: string, metadata: Record<string, unknown>) - 确定目前的用户和联系人 元数据.
  • PlayerZero.setUserVars(metadata: Record<string, unknown>) - 更新用户属性和元数据而无需重置 身份证明.
  • PlayerZero.track(event: string, metadata?: Record<string, unknown>) - 以可选方式跟踪自定义分析事件 元数据.
  • PlayerZero.prompt() - 促使用户与他们的DevTools报告互动.
  • PlayerZero.devtoolsUrl(): Promise<string> - 为当前会话创建 DevTools URL .
  • PlayerZero.kill() - 立即关闭PlayerZero。 这一行动对本届会议来说是不可逆转的.

实例

反应

import React from 'react';
import ReactDOM from 'react-dom';
import './index.css';
import App from './App';
import PlayerZero from '@goplayerzero/sdk-web';

PlayerZero.init('<your project id here>');

ReactDOM.render(<App/>, document.getElementById('root'));

角质 - main.ts

import { Component } from '@angular/core';
import PlayerZero from '@goplayerzero/sdk-web';
import { environment } from '../environments/environment';

@Component({
  selector: 'app-root',
  templateUrl: 'app.component.html',
  styleUrls: ['./app.component.scss']
})
export class AppComponent {

  constructor() {
    PlayerZero.init('<your project id here>');
  }
}

阴道

import Vue from 'vue';
import App from './App.vue';
import PlayerZero from '@goplayerzero/sdk-web';

PlayerZero.init('<your project id here>');
Vue.prototype.$PlayerZero = PlayerZero;

new Vue({
  render: h => h(App)
}).$mount('#app');

第3组

import { createApp } from 'vue'
import App from './App.vue'
import PlayerZero from '@goplayerzero/sdk-web';

PlayerZero.init('<your project id here>');

const app = createApp(App);
app.config.globalProperties.$PlayerZero = PlayerZero;
app.mount('#app');

使用 SDK

PlayerZero初始化后,可以给PlayerZero SDK打电话.

识别用户

将用户及其元数据与 PlayerZero 关联:

PlayerZero.identify(
  'userId',
  {
    name: 'Billy Joel',
    email: '[email protected]',
    group: 'Pied Piper'
  }
);

跟踪自定义分析事件

将自定义事件发送给 PlayerZero 进行分析 :

PlayerZero.track(
  'checkout',
  { item: 'chocolate' }
);

生成 DevTools URL

为当前会话创建 DevTools URL :

PlayerZero.devtoolsUrl().then(url => console.log('PlayerZero Devtools URL', url));

补充资料

  • 关于高级配置和故障排除,参见 正式文件。 。 。 .
  • 如果您在会话中需要停止PlayerZero,请拨打PlayerZero.kill (). 请注意,不可能重新启动 后称此法.

支助

问题或支助,请联系 玩家Zero 支持。 。 。 .

版本与发布记录

@goplayerzero/sdk-web 共发布 6 个版本,首次发布于 2022/10/19;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.3.0latest2025/08/211.2 年前
0.2.02025/01/191.8 年前
0.1.12024/06/032 年前
0.1.02024/05/122 年前
0.0.32022/10/194 年前
0.0.22022/10/194 年前

关于 @goplayerzero/sdk-web 的常见问题

@goplayerzero/sdk-web 是什么?

官方 PlayerZero 网络 SDK

如何安装 @goplayerzero/sdk-web?

在项目目录运行 npm install @goplayerzero/sdk-web,或使用 pnpm add / yarn add / bun add。

@goplayerzero/sdk-web 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@goplayerzero/sdk-web 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@goplayerzero/sdk-web 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=16.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@goplayerzero/sdk-web 可以商用吗?

@goplayerzero/sdk-web 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@goplayerzero/sdk-web 的下载量有多少?

根据 npm 官方下载统计,@goplayerzero/sdk-web 在 2026/10/17 – 2026/11/15 这 30 天内被下载 10,129 次,日均约 338 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@goplayerzero/sdk-web 还在维护吗?

最新版本 0.3.0 发布于 2025/08/21(1.2 年前);至今共发布 6 个版本,其中过去 12 个月发布了 0 个;首次发布于 2022/10/19。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。