客户端 SDK

API 参考

Audiencelab React SDK API 参考

API 参考

initializeAudiencelab(apiKey: string): Promise<{ token: string, metrics: any }>

使用您的 API 密钥初始化 Audiencelab SDK。

参数类型描述
apiKeystringGeeklab Audiencelab 服务的 API 密钥

返回一个 Promise,解析为包含以下内容的对象:

  • token: 生成的会话令牌
  • metrics: 初始指标数据

sendCustomPurchaseEvent(id: string, name: string, value: number, currency: string, status: string, tr_id?: string): Promise<any>

发送自定义购买事件。

参数类型描述
idstring购买商品的 ID
namestring购买商品的名称
valuenumber购买的价值
currencystring货币代码(例如,"USD")
statusstring购买状态("completed""success""failed"
tr_idstring可选的购买交易 ID

返回一个 Promise,在事件发送时解析。


sendCustomAdEvent(adId: string, name: string, source: string, watchTime: number, reward: boolean, mediaSource: string, channel: string, value: number, currency: string): Promise<any>

发送自定义广告事件。自动跟踪并在事件负载中包含 total_ad_value(所有广告价值的累计总和)。

参数类型描述
adIdstring广告的 ID
namestring广告的名称
sourcestring广告的来源
watchTimenumber观看时间(秒)
rewardboolean广告是否有奖励
mediaSourcestring媒体来源(例如,"admob")
channelstring渠道(例如,"paid")
valuenumber与广告相关的价值
currencystring货币代码(例如,"USD")

返回一个 Promise,在事件发送时解析。

事件负载自动包含 total_ad_value,表示自应用安装以来所有广告价值的累计总和。该值使用 localStorage 存储,并在会话之间持续存在。


sendCustomPurchaseEvent(id: string, name: string, value: number, currency: string, status: string, tr_id?: string): Promise<any>

发送自定义购买事件。自动跟踪并在事件负载中包含 total_purchase_value(所有购买价值的累计总和),但仅在状态为 "completed""success" 时递增。

参数类型描述
idstring购买商品的 ID
namestring购买商品的名称
valuenumber购买的价值
currencystring货币代码(例如,"USD")
statusstring购买状态("completed""success""failed"
tr_idstring可选的购买交易 ID

返回一个 Promise,在事件发送时解析。

事件负载自动包含 total_purchase_value,表示自应用安装以来所有购买价值的累计总和(仅包括已完成/成功的购买)。该值使用 localStorage 存储,并在会话之间持续存在。


sendCustomEvent(eventName: string, params: { value?: string; id?: string; [key: string]: string }): Promise<any>

发送自定义事件以跟踪任何用户操作或游戏事件。

参数类型描述
eventNamestring标识此自定义事件的唯一键或名称(例如,'level_complete')
paramsobject包含事件附加参数的对象

params 对象可以包括:

  • value(可选):与事件关联的主要值(例如,分数、金额、结果)
  • id(可选):事件的唯一标识符,用于幂等性
  • 其他键值对(可选,最多允许 2 个)

返回一个 Promise,在事件发送时解析。


getTotalAdValue(): Promise<number>

检索用户当前的累计广告价值。

返回一个 Promise,解析为表示用户自应用安装以来观看的所有广告的总价值的数字。


getTotalPurchaseValue(): Promise<number>

检索用户当前的累计购买价值。

返回一个 Promise,解析为表示用户自应用安装以来进行的所有购买的总价值的数字(仅包括已完成/成功的购买)。