@ capgo/ 电容- rudderstack
用本地的RanderStack SDKs从您的 Capacitor app 中向 RanderStack 发送分析事件和用户身份. 一个舵手-斯德克-科尔多瓦相接口.
🤖 建筑与AI编码代理? 安装 Capgo 技能 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用
@capgo/capacitor-rudderstack在您的电容应用程序中:npx skills add Cap-go/capgo-skills。然后问你的经纪人: 添加@capgo/capor-rudderstack到我的Capacitor应用上并把它接上" 代理设置指南 • 妇女 主机磁共振
主要特点
- 设置数字 :
initialize()使用您的写键和数据平面 URL. - 跟踪数字 :
track(), (中文(简体) ),screen(), (中文(简体) ),identify(), (中文(简体) ),group()财务报告和审定财务报表alias()。 。 。 . - 身份数字 :
reset(), (中文(简体) ),putAnonymousId(), (中文(简体) ),putAdvertisingId()财务报告和审定财务报表putDeviceToken()。 。 。 . - 隐私和分娩数字 :
optOut()财务报告和审定财务报表flush()。 。 。 . - 易行移徙:遵循 Cordova 插件 API 形状.
- 平台: iOS和Android. 互联网档案馆的存檔,存档日期2013-12-22. 使用陆克星iOS和Android SDK. Web 有不发送事件的API相容根.
RuderStack分析与事件跟踪的电容插件.
此软件包是一个 Capacitor 端口,由 舵-斯德克-科尔多瓦 与原生的Android和iOS桥为Capacitor 8.
文档
这里有最完整的医生: https://capgo.app/docs/plugins/rudderstack/ 页面存档备份,存于互联网档案馆
兼容性
| 插件版本 | 电容兼容性 | 维护 |
|---|---|---|
| 联合国 | 联合国 | ✅ |
| 页:1 | 页:1 | 应要求 |
| 页:1 | 页:1 | ❌ |
说明: 此插件的主要版本沿用了Capacitor的主要版本. 使用匹配您的电容安装的版本 。 只有最新的主要版本得到积极维护.
安装
您可以使用我们的 AI 辅助设置安装插件 。 使用以下命令将 Capgo 技能添加到您的 AI 工具 :
npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins
然后使用下列提示:
Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-rudderstack` plugin in my project.
如果您更喜欢手动设置,请通过运行以下命令来安装插件,并遵循下面的平台特定指令:
bun add @capgo/capacitor-rudderstack
bunx cap sync
使用量
import { RudderStack } from '@capgo/capacitor-rudderstack';
await RudderStack.initialize('YOUR_WRITE_KEY', {
dataPlaneUrl: 'https://your-dataplane.rudderstack.com',
trackLifecycleEvents: true,
logLevel: RudderStack.LogLevel.INFO,
});
await RudderStack.identify('user_123', {
email: '[email protected]',
plan: 'pro',
});
await RudderStack.track('Checkout Started', {
value: 49,
currency: 'EUR',
});
API有意跟随Cordova插件外形,使已存在的Ruder Cordova集成可以在最小的呼叫站点变化下迁移.
行为
- Android使用RuderStack Android SDK并透过Capacitor桥将Cordova相容的分析器表面曝光.
- iOS使用RanderStack iOS SDK并配有与同为公共API相匹配的斯威夫特桥.
- Web是一个轻量级相容执行,旨在开发与API对等. 它不会将事件发送到RuderStack.
config.factories来自 Cordova 插件目前被忽略 。 本土目的地工厂配套插件不属于这个第一个Capacitor端口.
API 密码
initialize(...)identify(...)group(...)track(...)screen(...)alias(...)reset()flush()putDeviceToken(...)setAdvertisingId(...)putAdvertisingId(...)setAnonymousId(...)putAnonymousId(...)optOut(...)getPluginVersion()- 接口
- 类型异名
反映公共表面的 API rudder-sdk-cordova。 。 。 .
初始化(...)
initialize(writeKey: string, config?: RudderConfiguration | RudderOptions | undefined, options?: RudderOptions | undefined) => Promise<void>
初始化RuderStack客户端.
方法保存 Cordova 签名,因此第二个参数可以是配置对象或 a 舵手选项对象.
| 参数 | 类型 |
|---|---|
writeKey | string |
config | RudderConfiguration | RudderOptions |
options | RudderOptions |
标识(...)
identify(userId: string, traits?: RudderOptions | RudderTraits | undefined, options?: RudderOptions | undefined) => Promise<void>
为所提供的用户 ID 发送一个识别呼叫 .
| 参数 | 类型 |
|---|---|
userId | string |
traits | RudderOptions | RudderTraits |
options | RudderOptions |
组(...)
group(groupId: string, groupTraits?: RudderOptions | RudderTraits | undefined, options?: RudderOptions | undefined) => Promise<void>
发送组呼叫以获取提供的组 ID .
| 参数 | 类型 |
|---|---|
groupId | string |
groupTraits | RudderOptions | RudderTraits |
options | RudderOptions |
音轨(...)
track(eventName: string, properties?: RudderOptions | RudderProperties | undefined, options?: RudderOptions | undefined) => Promise<void>
为提供的事件名称发送音轨呼叫 .
| 参数 | 类型 |
|---|---|
eventName | string |
properties | RudderOptions | RudderProperties |
options | RudderOptions |
屏幕(...)
screen(screenName: string, properties?: RudderOptions | RudderProperties | undefined, options?: RudderOptions | undefined) => Promise<void>
为提供的屏幕名称发送屏幕呼叫.
| 参数 | 类型 |
|---|---|
screenName | string |
properties | RudderOptions | RudderProperties |
options | RudderOptions |
别名(...)
alias(newId: string, options?: RudderOptions | undefined) => Promise<void>
区分当前用户为新标识符.
| 参数 | 类型 |
|---|---|
newId | string |
options | RudderOptions |
重设( c)
reset() => Promise<void>
重置当前 RanderStack 身份状态 .
冲号( )
flush() => Promise<void>
Flushes立即排队活动.
将DeviceToken(...)放入
putDeviceToken(deviceToken: string) => Promise<void>
设置将 RudderStack 转发到支持的目的地的推动符 .
| 参数 | 类型 |
|---|---|
deviceToken | string |
设置 :
setAdvertisingId(advertisingId: string) => Promise<void>
| 参数 | 类型 |
|---|---|
advertisingId | string |
置入广告ID(...)
putAdvertisingId(advertisingId: string) => Promise<void>
设置自定义广告 id 值.
| 参数 | 类型 |
|---|---|
advertisingId | string |
设置匿名文件(...)
setAnonymousId(anonymousId: string) => Promise<void>
| 参数 | 类型 |
|---|---|
anonymousId | string |
设置匿名标识(...)
putAnonymousId(anonymousId: string) => Promise<void>
设置自定义匿名的 id 值.
| 参数 | 类型 |
|---|---|
anonymousId | string |
选择退出(...)
optOut(optOut: boolean) => Promise<void>
切换 RuderStack 跟踪选择退出 .
| 参数 | 类型 |
|---|---|
optOut | boolean |
获取 PluginVersion ()
getPluginVersion() => Promise<PluginVersionResult>
从本地执行中返回插件版本标记 .
回返情况: Promise<PluginVersionResult>
接口
舵手配置
支持基本的 RanderStack 本地 SDKs 的配置密钥 .
| Prop | 类型 | 说明 |
|---|---|---|
dataPlaneUrl | string | 陆克文Stack数据平面 URL. |
flushQueueSize | number | 冲洗前要批量的事件数 . |
dbCountThreshold | number | 数据库行阈值会触发Android和iOS上出轨. |
configRefreshInterval | number | 服务器配置按小时刷新间隔 . |
logLevel | RudderLogLevelValue | (原始内容存档于2018-10-21). RanderStack log verbosity. |
sleepTimeOut | number | 睡眠超时 / 睡眠计数由本地SDK使用. |
autoCollectAdvertId | boolean | 仅限Android. 让本地SDK自动收集广告标识符. |
trackLifecycleEvents | boolean | 音轨 Application Installed, (中文(简体) ), Application Updated,以及 Application Opened 自动. |
controlPlaneUrl | string | 舵手Stack控制平面 URL. |
recordScreenViews | boolean | 启用本地 SDK 支持的自动屏幕跟踪 . |
factories | any[] | 在此 Capacitor 端口被忽略 。 Cordova SDK利用这个领域从伴生插件中将本土目的地工厂拖出靴子. 这些扩展包没有在首次Capacitor发行中执行. |
左轮选项
(原始内容存档于2018-10-21) (英语). RanderStack per-call options.
| Prop | 类型 | 说明 |
|---|---|---|
externalIds | Record<string, string> | 与事件一起传送的外部标识符 . |
integrations | Record<string, boolean> | 按集成名称键入目标启用标记 . |
插件变压器
插件版本有效载荷 .
| Prop | 类型 | 说明 |
|---|---|---|
version | string | 版本标识符由平台执行返回. |
类型异名
舵手Loglevel Value 软件
RanderStack 为迁移方便而暴露的日志值 .
0 | 1 | 2 | 3 | 4 | 5
记录
构造 T 类型 K 的一组属性类型
{
[P in K]: T;
}
舵手拖车
被接受的特质有效载荷 identify 财务报告和审定财务报表 group。 。 。 .
Record<string, any>
舵子产品
被接受的属性有效载荷 track 财务报告和审定财务报表 screen。 。 。 .
Record<string, any>