玩家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 支持。 。 。 .