@goplayerzero/sdk-web

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

The official PlayerZero Web SDK

原始使用文档
文档目录10 节
  1. Installation
  2. Initialize the SDK
  3. PlayerZero API
  4. Examples
  5. Using the SDK
  6. Identify a User
  7. Track custom analytics events
  8. Generate a DevTools URL
  9. Additional Information
  10. Support

PlayerZero Web SDK

The PlayerZero Web SDK enables you to integrate PlayerZero into your website or web application. With this SDK, you can manage PlayerZero initialization, identify users, track custom analytics events, generate DevTools links, and more. For comprehensive API documentation, visit PlayerZero Docs.


Installation

Install the SDK using your preferred package manager:

npm

npm i @goplayerzero/sdk-web --save

with yarn

yarn add @goplayerzero/sdk-web

Initialize the SDK

Calling init() more than once after successful initialization will trigger console warnings. To check if PlayerZero has already been initialized, use PlayerZero.isInitialized().

PlayerZero API

  • PlayerZero.init(apiToken: string, options: {endpoint?: string, privacyFnUrl?: string}) - Initialize PlayerZero with your API Token and optional configuration. The API Token can be found on PlayerZero's Project Settings under the Web SDK area.
  • PlayerZero.isInitialized(): Boolean - Returns true if PlayerZero is initialized.
  • PlayerZero.identify(userId: string, metadata: Record<string, unknown>) - Identify the current user and associate metadata.
  • PlayerZero.setUserVars(metadata: Record<string, unknown>) - Update user properties and metadata without resetting the identity.
  • PlayerZero.track(event: string, metadata?: Record<string, unknown>) - Track a custom analytics event with optional metadata.
  • PlayerZero.prompt() - Prompt the user to interact with their DevTools report.
  • PlayerZero.devtoolsUrl(): Promise<string> - Generate a DevTools URL for the current session.
  • PlayerZero.kill() - Immediately shut down PlayerZero. This action is irreversible for the session.

Examples

React

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

Angular - 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>');
  }
}

Vue

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

Vue 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');

Using the SDK

Once PlayerZero is initialized, you can make calls to the PlayerZero SDK.

Identify a User

Associate a user and their metadata with PlayerZero:

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

Track custom analytics events

Send custom events to PlayerZero for analytics:

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

Generate a DevTools URL

Create a DevTools URL for the current session:

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

Additional Information

  • For advanced configuration and troubleshooting, refer to the official documentation.
  • If you need to stop PlayerZero during a session, call PlayerZero.kill(). Note that reinitialization is not possible after calling this method.

Support

For questions or support, please contact PlayerZero Support.

版本与发布记录

@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 是什么?

The official PlayerZero Web 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 和提交记录判断。