跳过主要内容
@capgo/capacitor-rudderstack 数据分析 开源

RudderStack Capacitor插件

RudderStack数据分析、身份识别、屏幕跟踪和Capacitor的交付控制

安装

bun add @capgo/capacitor-rudderstack bunx cap sync
npm、pnpm或yarn
  • npm install @capgo/capacitor-rudderstack
  • pnpm add @capgo/capacitor-rudderstack
  • yarn add @capgo/capacitor-rudderstack

指南

如何在 Capacitor 中使用 RudderStack

在设备上测试

下载 Capgo 应用,然后扫描二维码 code

RudderStack 插件预览二维码 code

使用 @capgo/capacitor-rudderstack

Capacitor API 是公共接口的镜像 rudder-sdk-cordova.

安装

bun add @capgo/capacitor-rudderstack
bunx cap sync

bunx cap sync 复制插件的本机 code 到您的本机项目中。每次升级插件后都重新运行它。

导入

import { nativePlugin } from '@capgo/capacitor-rudderstack';

快速了解 API

方法 描述
initialize 初始化 RudderStack 客户端。
identify 发送一个针对指定用户 ID 的 identify 调用。
group 发送一个针对指定组 ID 的 group 调用。
track 发送一个针对指定事件名称的 track 调用。
screen 发送一个针对指定屏幕名称的 screen 调用。
alias 将当前用户别名更改为一个新标识符。
reset 重置当前 RudderStack 身份状态。
flush 立即发送排队的事件。
putDeviceToken 设置 RudderStack 将向支持的目的地转发的推送令牌。
setAdvertisingId 查看源定义以了解当前行为。
putAdvertisingId 设置一个自定义广告 ID 值。
setAnonymousId 查看源定义以了解当前行为。
putAnonymousId 设置一个自定义匿名ID值。
optOut 切换RudderStack跟踪选项。

示例

initialize()

初始化 RudderStack 客户端。

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.initialize('write-key-123');

identify()

初始化RudderStack客户端。

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.identify('user-id-123');

group()

发送一个针对提供的用户ID的identify调用。

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.group('group-id-123');

track()

发送一个针对提供的组ID的group调用。

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.track('event');

screen()

发送一个针对提供的事件名称的track调用。

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.screen('screen');

alias()

发送一个针对提供的屏幕名称的screen调用。

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.alias('new-id-123');

将当前用户别名为一个新标识符。 GitHub 仓库.

__CAPGO_KEEP_0__ 仓库

继续使用 @capgo/capacitor-rudderstack

如果您正在使用 使用 @capgo/capacitor-rudderstack 规划仪表板和 API 运行,连接它到 @capgo/capacitor-rudderstack 查看 @capgo/capacitor-rudderstack 的实现细节 开始 查看开始的实现细节 API 概述 为 API 的实现细节概述 简介 为简介的实现细节概述,并 API 的关键 为 API 的关键的实现细节概述。

常见问题

RudderStack 插件常见问题

如何在 Capacitor 应用中安装 RudderStack 插件?

运行 "bun add @capgo/capacitor-rudderstack" (或 "npm install @capgo/capacitor-rudderstack" ),然后运行 "bunx cap sync" 以便 iOS 和 Android 项目捕获 native code。从 "@capgo/capacitor-rudderstack" 导入您的应用 code。

是否@capgo/capacitor-rudderstack与React、Vue和Angular兼容?

是。RudderStack 是一个 Capacitor 包,因此它与任何在 Capacitor 内部运行的 Web 框架兼容,包括 Ionic、React、Vue、Angular、Svelte 和普通 JavaScript。

Which Capacitor version does @capgo/capacitor-rudderstack support?

Capgo 插件遵循 Capacitor 的主要版本:使用与您的 Capacitor 主要版本匹配的插件主要版本(例如插件 v8 与 Capacitor 8)。在 GitHub README 中的兼容性表格列出了维护的版本。

是否@capgo/capacitor-rudderstack 免费且开源?

Yes. The source code is public on GitHub at https://github.com/Cap-go/capacitor-rudderstack/ and the package is free to install from npm. Bug reports and pull requests are welcome.

是否可以在不经过 App Store 审核的情况下更新使用 RudderStack 的 code?

安装或升级插件会改变本机 code,因此需要新建一个应用商店包。随后,调用插件的 JavaScript、HTML 和 CSS 变更可以立即通过 Capgo 实时更新。

不必等待应用程序审查就可以将RudderStack的更改部署

在您的商店构建中安装插件后,Capgo即刻推送您的JavaScript、HTML和CSS更改到用户中。

开始使用Capgo