@ riastools/ 像素
Xylabs ESB 事件客户端
安装
使用 npm :
npm install {{name}}
使用线条 :
yarn add {{name}}
使用 pnpm :
pnpm add {{name}}
使用包子 :
bun add {{name}}
许可证
见 自由主义 用于许可证权利和限制的文件(LGPL-3.0-只).
参考文献
软件包
像素
### .temp-typedoc
### classes
### <a id="PixelApi"></a>PixelApi
HTTP客户端用于向XY Labs像素API发送跟踪事件.
构造器
构造器
new PixelApi(baseUri?): PixelApi;
参数
基地乌里?
string =: 'prod'
回返
PixelApi
方法
音轨事件( )
trackEvents(events): Promise<any>;
发送一系列用户事件到跟踪API.
参数
事件
[UserEvent[ . ]#./界面/用户活动
提交的活动
回返
Promise<any> 翻译:
API的响应数据
### <a id="Referrer"></a>Referrer
在会话和本地存储中跟踪并坚持文件推荐人.
构造器
构造器
new Referrer(): Referrer;
回返
Referrer
属性
当地
local: string;
第二届会议
session: string;
方法
改为 Json ()
toJson():
| {
local: string;
session: string;
}
| undefined;
返回作为 JSON 对象的参考数据,或者如果两个值均为空则未定义.
回返
| {
local数字 : string· ;
session数字 : string· ;
{\fn黑体\fs22\bord1\shad0\3aHBE\4aH00\fscx67\fscy66\2cHFFFFFF\3cH808080}你觉得呢
| undefined
带有本地和会话引用字符串或未定义的对象
### <a id="UniqueUserId"></a>UniqueUserId
生成并坚持本地Storage中唯一的用户标识符.
构造器
构造器
new UniqueUserId(): UniqueUserId;
回返
UniqueUserId
属性
编号
id: string;
方法
转到 String ()
toString(): string;
返回作为字符串的唯一用户ID.
回返
string
### <a id="UserEventHandler"></a>UserEventHandler
处理用户跟踪事件的抽象基础类.
由
类型参数
TData 发件人
TData 扩展 EmptyObject
构造器
构造器
new UserEventHandler<TData>(): UserEventHandler<TData>;
回返
UserEventHandler<TData> 翻译:
方法
漏斗启动( S)
abstract funnelStarted<T>(fields): Promisable<void>;
跟踪漏斗启动的事件.
类型参数
T级
T 扩展 object
参数
字段
回返
Promisable<void> 翻译:
测试开始( C)
abstract testStarted<T>(fields): Promisable<void>;
跟踪一个测试启动的事件.
类型参数
T级
T 扩展 object
参数
字段
回返
Promisable<void> 翻译:
用户 Click ()
abstract userClick<T>(fields): Promisable<void>;
跟踪用户点击事件.
类型参数
T级
T 扩展 object
参数
字段
UserClickFields | T
回返
Promisable<void> 翻译:
视图
abstract viewContent<T>(fields): Promisable<void>;
跟踪视图内容事件.
类型参数
T级
T 扩展 object
参数
字段
回返
Promisable<void> 翻译:
### <a id="UtmFields"></a>UtmFields
从查询字符串追踪 UTM 活动参数, 本地Storage 中的持续历史 .
构造器
构造器
new UtmFields(): UtmFields;
回返
UtmFields
属性
字段
fields: Record<string, string>[] = [];
方法
获取Utm记录( )
getUtmRecord(): Record<string, string> | null;
从当前 URL 查询字符串中解析 UTM 参数 .
回返
Record<string, (中文(简体) ), string> null
UTM 密钥值对的记录, 如果不存在则无效
转到 String ()
toString(): string;
返回作为 JSON 字符串的 UTM 字段历史 .
回返
string
更新()
update(): Record<string, string>[];
检查新的 UTM 值的查询字符串,如果更改,将其附加到历史中.
回返
Record<string, (中文(简体) ), string>[] 翻译:
当前 UTM 字段数组, 如果为空则未定义
### <a id="XyPixel"></a>XyPixel
Singleton像素跟踪器,用于排队并发送用户事件到XY Labs跟踪API.
属性
api 密码
static api: PixelApi;
数字
cid: string;
电子邮件?
optional email?: string;
电子邮件- hash?
optional email_hash?: string | null;
外科医生?
optional exids?: ExIds;
像素盾 ?
optional pixelId?: string;
队列
queue: UserEvent[] = [];
访问者
实例
获取签名
get static instance(): XyPixel;
返回单通 XyPixel 实例,如果尚未初始化,则投掷.
回返
XyPixel
方法
输入( i)
static init(pixelId): XyPixel;
以给定的像素ID初始化 XyPixel 单通.
参数
像素Id
string
此跟踪实例的像素标识符
回返
XyPixel
新建的 XyPixel 实例
选择 Api ()
static selectApi(api): void;
替换用于发送事件的默认像素Api实例.
参数
api 密码
要使用的像素Api 实例
回返
void
标识( )
identify(email?): void;
与这个像素实例相关联的电子邮件地址.
参数
电子邮件?
string
用于识别用户的电子邮件地址
回返
void
发送( )
send<T>(
event,
fields?,
eventId?): Promise<void>;
排入一个跟踪事件并试图将队列冲到 API 中 .
类型参数
T级
T 扩展 Record<string, (中文(简体) ), unknown> 翻译:
参数
事件
string
事件名称
字段吗?
T
可选事件指定字段
事件吗?
string
可选唯一事件标识符
回返
Promise<void> 翻译:
### <a id="XyUserEventHandler"></a>XyUserEventHandler
通过 XyPixel 单通发送跟踪事件的具体事件处理器 .
扩展
UserEventHandler<T> 翻译:
类型参数
T级
T 扩展 EmptyObject =: EmptyObject
构造器
构造器
new XyUserEventHandler<T>(): XyUserEventHandler<T>;
回返
XyUserEventHandler<T> 翻译:
覆盖
UserEventHandler。 。 。 .constructor
方法
漏斗启动( S)
funnelStarted(fields): Promise<void>;
通过像素 API 发送一个漏斗启动事件 .
参数
字段
回返
Promise<void> 翻译:
覆盖
UserEventHandler。 。 。 .funnelStarted
购买()
purchase(fields): Promise<void>;
通过像素 API 发送购买事件 .
参数
字段
PurchaseFields | T
回返
Promise<void> 翻译:
测试开始( C)
testStarted(fields): Promise<void>;
通过像素 API 发送一个测试启动的事件 .
参数
字段
回返
Promise<void> 翻译:
覆盖
UserEventHandler。 。 。 .testStarted
用户 Click ()
userClick(fields): Promise<void>;
通过像素 API 发送用户点击事件.
参数
字段
UserClickFields | T
回返
Promise<void> 翻译:
覆盖
UserEventHandler。 。 。 .userClick
视图
viewContent(fields): Promise<void>;
通过像素 API 发送一个视图内容事件.
参数
字段
回返
Promise<void> 翻译:
覆盖
UserEventHandler。 。 。 .viewContent
### interfaces
### <a id="CommonFields"></a>CommonFields
在所有跟踪活动类型中共享共同域.
由
属性
漏斗吗?
optional funnel?: string;
测试数据?
optional testData?: string;
### <a id="FunnelStartedFields"></a>FunnelStartedFields
漏斗启动跟踪事件的字段 .
扩展
属性
漏斗吗?
optional funnel?: string;
继承自
CommonFields。 。 。 .funnel
测试数据?
optional testData?: string;
继承自
CommonFields。 。 。 .testData
名称
name: string;
### <a id="PurchaseFields"></a>PurchaseFields
购买跟踪活动的字段.
扩展
属性
漏斗吗?
optional funnel?: string;
继承自
CommonFields。 。 。 .funnel
测试数据?
optional testData?: string;
继承自
CommonFields。 。 。 .testData
编号
id: string;
名字吗?
optional name?: string;
价钱?
optional price?: number;
价值?
optional value?: number;
### <a id="TestStartedFields"></a>TestStartedFields
用于测试启动跟踪事件的字段(如A/B测试).
扩展
属性
漏斗吗?
optional funnel?: string;
继承自
CommonFields。 。 。 .funnel
测试数据?
optional testData?: string;
继承自
CommonFields。 。 。 .testData
名称
name: string;
### <a id="UserClickFields"></a>UserClickFields
用户点击跟踪事件的字段 .
扩展
属性
漏斗吗?
optional funnel?: string;
继承自
CommonFields。 。 。 .funnel
测试数据?
optional testData?: string;
继承自
CommonFields。 。 。 .testData
元素Name
elementName: string;
元素类型
elementType: string;
意图?
optional intent?: string;
安置吗?
optional placement?: string;
### <a id="UserEvent"></a>UserEvent
代表一个发送到像素API的单一用户跟踪事件.
属性
数字
cid: string;
创建时间( t) ?
optional create_time?: number;
电子邮件?
optional email?: string;
电子邮件- hash?
optional email_hash?: string;
活动?
optional event?: string;
事件编号 ?
optional event_id?: string;
外科医生?
optional exids?: ExIds;
字段吗?
optional fields?: Record<string, unknown>;
主持人?
optional host?: string;
路径名 ?
optional pathname?: string;
像素吗?
optional pixel?: string;
接收时间?
optional receive_time?: number;
裁判员?
optional referrer?: object;
当地
local: string;
第二届会议
session: string;
摆脱?
optional rid?: string;
系统?
optional system?: ParsedResult;
欧德?
optional uid?: string;
是吗?
optional utm?: Record<string, string>[] | Record<string, string[]>;
### <a id="ViewContentFields"></a>ViewContentFields
视图内容跟踪事件的字段 .
扩展
属性
漏斗吗?
optional funnel?: string;
继承自
CommonFields。 。 。 .funnel
测试数据?
optional testData?: string;
继承自
CommonFields。 。 。 .testData
名称
name: string;
路径
path: string;
### <a id="XyLabsTrackingEventJson"></a>XyLabsTrackingEventJson
JSON结构用于存储或传输的XY实验室跟踪事件.
属性
数字
cid: string;
创建时间( t) ?
optional create_time?: number;
电子邮件?
optional email?: string;
电子邮件- hash?
optional email_hash?: string;
活动?
optional event?: string;
事件编号 ?
optional event_id?: string;
外科医生?
optional exids?: Record<string, string>;
字段吗?
optional fields?: Record<string, unknown>;
主持人?
optional host?: string;
脚?
optional ip?: string;
路径名 ?
optional pathname?: string;
像素吗?
optional pixel?: string;
接收时间?
optional receive_time?: number;
摆脱?
optional rid?: string;
系统?
optional system?: unknown;
欧?
optional ua?: string;
欧德?
optional uid?: string;
是吗?
optional utm?: Record<string, string>[] | Record<string, string[]>;
### interfaces
### <a id="UserEventSystem"></a>UserEventSystem
interface UserEventSystem
从用户代理字符串中解析出浏览器/OS/引擎信息.
属性
浏览器?
optional browser: UserEventSystemBrowser;
发动机?
optional engine: UserEventSystemEngine;
欧斯?
optional os: UserEventSystemOS;
平台吗 ?
optional platform: UserEventSystemPlatform;