快速入门

安装

bun add @capgo/capacitor-rudderstack
bunx cap sync

导入

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

API概述

initialize

初始化 RudderStack 客户端。

方法保留 Cordova 签名，因此第二个参数可以是配置对象或 Rudder 选项对象。

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

await nativePlugin.initialize('value');

identify

为提供的用户 ID 发送身份验证调用。

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

await nativePlugin.identify('value');

group

发送一个群组呼叫给指定的群组 ID。

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

await nativePlugin.group('value');

track

发送一个跟踪呼叫给指定的事件名称。

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

await nativePlugin.track('value');

screen

发送一个屏幕呼叫给指定的屏幕名称。

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

await nativePlugin.screen('value');

alias

将当前用户别名为新标识符。

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

await nativePlugin.alias('value');

reset

重置当前RudderStack身份状态。

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

await nativePlugin.reset();

flush

立即刷新队列事件。

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

await nativePlugin.flush();

putDeviceToken

设置推送令牌，RudderStack将其转发到支持的目的地。

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

await nativePlugin.putDeviceToken('value');

setAdvertisingId

查看当前合同的源定义。

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

await nativePlugin.setAdvertisingId('value');

putAdvertisingId

设置自定义广告 ID 值。

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

await nativePlugin.putAdvertisingId('value');

setAnonymousId

查看当前合同的源定义。

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

await nativePlugin.setAnonymousId('value');

putAnonymousId

设置自定义匿名 ID 值。

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

await nativePlugin.putAnonymousId('value');

optOut

开关 RudderStack 跟踪关闭。

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

await nativePlugin.optOut(true);

类型参考

RudderConfiguration

rudder栈的底层native SDK支持的配置键

export interface RudderConfiguration {
  /**
   * RudderStack data plane URL.
   */
  dataPlaneUrl?: string;

  /**
   * Number of events to batch before a flush.
   */
  flushQueueSize?: number;

  /**
   * Database row threshold that triggers pruning on Android and iOS.
   */
  dbCountThreshold?: number;

  /**
   * Server config refresh interval in hours.
   */
  configRefreshInterval?: number;

  /**
   * RudderStack log verbosity.
   */
  logLevel?: RudderLogLevelValue;

  /**
   * Sleep timeout / sleep count used by the native SDK.
   */
  sleepTimeOut?: number;

  /**
   * Android only. Lets the native SDK collect the advertising identifier automatically.
   */
  autoCollectAdvertId?: boolean;

  /**
   * Tracks `Application Installed`, `Application Updated`, and `Application Opened` automatically.
   */
  trackLifecycleEvents?: boolean;

  /**
   * RudderStack control plane URL.
   */
  controlPlaneUrl?: string;

  /**
   * Enables automatic screen tracking where supported by the native SDK.
   */
  recordScreenViews?: boolean;

  /**
   * Ignored in this Capacitor port.
   *
   * The Cordova SDK uses this field to bootstrap native destination factories from companion plugins.
   * Those extension packages are not implemented in this first Capacitor release.
   */
  factories?: any[];
}

RudderOptions

rudder栈每次调用选项

export interface RudderOptions {
  /**
   * External identifiers forwarded with the event.
   */
  externalIds?: Record<string, string>;

  /**
   * Destination enablement flags keyed by integration name.
   */
  integrations?: Record<string, boolean>;
}

RudderTraits

rudder栈接受的特征载荷 identify 和 group.

export type RudderTraits = Record<string, any>;

RudderProperties

接受的属性载荷 track 和 screen.

export type RudderProperties = Record<string, any>;

PluginVersionResult

插件版本载荷

export interface PluginVersionResult {
  /**
   * Version identifier returned by the platform implementation.
   */
  version: string;
}

RudderLogLevelValue

为迁移方便而暴露的RudderStack日志级别值

export type RudderLogLevelValue = 0 | 1 | 2 | 3 | 4 | 5;

真实来源

本页面由插件生成 src/definitions.ts当公共API在上游发生变化时，请重新运行同步