电容 PostHog 插件

非官方电容插件 邮箱[^1]

使用大小写

PostHog插件一般用来理解用户如何与应用程序互动,例如:

• 产品分析: 抓取自定义事件并屏幕视图以分析用户如何通过您的应用程序移动.
• 用户识别: 识别有明显身份的用户,指定别名,并将其活动与团体联系起来.
• 地物标志:通过在运行时检查特征标志及其有效载荷,逐步推出特征.
• 会话重放: 记录用户会话,以了解使用模式并调试问题.
• 跟踪错误: 手动或自动抓取例外以监视应用程序的稳定性.

兼容性

安装

你可以用我们的 AI 辅助设置 以安装插件. 添加数据 超级技能 至您的 AI 工具,使用以下命令:

npx skills add capawesome-team/skills --skill capacitor-plugins

然后使用下列提示:

 Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-posthog` plugin in my project.

如果你喜欢 手动设置,通过运行以下命令来安装插件,并遵循下面的平台特定指令:

npm install @capawesome/capacitor-posthog posthog-js
npx cap sync

机器人

变量

如果需要, 您可以在您的应用程序中定义以下工程变量 variables.gradle 要更改依赖的默认版本的文件 :

• $androidxCoreKtxVersion 版本 androidx.core:core-ktx (默认 : 1.13.1(中文(简体) )
• $posthogVersion 版本 com.posthog:posthog-android (默认 : 3.27.2(中文(简体) )

如果您在工程中遇到其它插件的依赖性冲突, 这会有所帮助 .

配置

实例

单位 capacitor.config.json数字 :

{
  "plugins": {
    "Posthog": {
      "apiKey": 'phc_g8wMenebiIQ1pYd5v9Vy7oakn6MczVKIsNG5ZHCspdy',
      "apiHost": 'https://eu.i.posthog.com',
      "host": 'https://eu.i.posthog.com',
      "uiHost": 'https://eu.posthog.com',
      "enableSessionReplay": undefined,
      "sessionReplayConfig": undefined,
      "captureApplicationLifecycleEvents": undefined,
      "autoCaptureExceptions": undefined
    }
  }
}

单位 capacitor.config.ts数字 :

/// <reference types="@capawesome/capacitor-posthog" />

import { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    Posthog: {
      apiKey: 'phc_g8wMenebiIQ1pYd5v9Vy7oakn6MczVKIsNG5ZHCspdy',
      apiHost: 'https://eu.i.posthog.com',
      host: 'https://eu.i.posthog.com',
      uiHost: 'https://eu.posthog.com',
      enableSessionReplay: undefined,
      sessionReplayConfig: undefined,
      captureApplicationLifecycleEvents: undefined,
      autoCaptureExceptions: undefined,
    },
  },
};

export default config;

演示

这里有一个实例: robingenz/电容器-插管-demo

使用量

以下例子显示如何设置SDK,抓取事件,跟踪屏幕视图,识别用户,与一组联系用户,管理超级属性,重置用户,并冲出队列事件.

设置 SDK

打电话 setup(...) 在任何其他方法之前。 或者,在Android和iOS上,您可以在 Capacitor 配置文件中配置插件(参见 配置)),在这种情况下,你决不能称这种方法:

import { Posthog } from '@capawesome/capacitor-posthog';

const setup = async () => {
  await Posthog.setup({
    apiKey: 'YOUR_API_KEY',
    apiHost: 'https://eu.i.posthog.com',
  });
};

捕获事件

抓取带有可选属性的自定义事件 :

import { Posthog } from '@capawesome/capacitor-posthog';

const capture = async () => {
  await Posthog.capture({
    event: 'event',
    properties: {
      key: 'value',
    },
  });
};

音轨屏幕视图

发送带有屏幕标题的屏幕事件 。 仅在Android和iOS上提供:

import { Posthog } from '@capawesome/capacitor-posthog';

const screen = async () => {
  await Posthog.screen({
    screenTitle: 'screen',
    properties: {
      key: 'value',
    },
  });
};

识别用户

识别当前拥有不同ID和设定人物属性的用户。 您也可以使用 : alias(...)数字 :

import { Posthog } from '@capawesome/capacitor-posthog';

const identify = async () => {
  await Posthog.identify({
    distinctId: 'distinct-id',
    userProperties: {
      key: 'value',
    },
  });
};

const alias = async () => {
  await Posthog.alias({
    alias: 'new-distinct-id',
  });
};

与一组联系的用户

将当前用户的事件与一个团体,例如公司或团队联系起来:

import { Posthog } from '@capawesome/capacitor-posthog';

const group = async () => {
  await Posthog.group({
    type: 'group',
    key: 'key',
    groupProperties: {
      key: 'value',
    },
  });
};

管理超级属性

登记每个事件发送的超级财产,并在不再需要时取消登记:

import { Posthog } from '@capawesome/capacitor-posthog';

const register = async () => {
  await Posthog.register({
    key: 'super-property',
    value: 'super-value',
  });
};

const unregister = async () => {
  await Posthog.unregister({
    key: 'super-property',
  });
};

重置用户

重置当前用户的ID和匿名ID, 例如在登录后 :

import { Posthog } from '@capawesome/capacitor-posthog';

const reset = async () => {
  await Posthog.reset();
};

Flush 队列事件

手动冲洗队列中的所有事件 。 仅在Android和iOS上提供:

import { Posthog } from '@capawesome/capacitor-posthog';

const flush = async () => {
  await Posthog.flush();
};

API 密码

• alias(...)
• capture(...)
• captureException(...)
• flush()
• getDistinctId()
• getFeatureFlag(...)
• getFeatureFlagPayload(...)
• getSessionId()
• group(...)
• identify(...)
• isFeatureEnabled(...)
• isOptOut()
• optIn()
• optOut()
• register(...)
• reloadFeatureFlags()
• reset()
• screen(...)
• setPersonProperties(...)
• setup(...)
• startSessionRecording()
• stopSessionRecording()
• unregister(...)
• 接口
• 类型异名

别名(...)

alias(options: AliasOptions) => Promise<void>

向当前用户指定另一个不同的ID .

自: 6.0.0 (单位:千美元)

抓取(...)

capture(options: CaptureOptions) => Promise<void>

抓住一个事件.

自: 6.0.0 (单位:千美元)

抓取例外(...)

captureException(options: CaptureExceptionOptions) => Promise<void>

抓住一个例外.

自: 8.5.0 (中文(简体) )

冲号( )

flush() => Promise<void>

将队列中的所有事件浮出水面 .

仅在Android和iOS上提供.

自: 6.0.0 (单位:千美元)

获取 DistinctId ()

getDistinctId() => Promise<GetDistinctIdResult>

获取当前识别身份.

回返情况: Promise<GetDistinctIdResult>

自: 8.2.0 (中文(简体) )

获取 FeatureFlag (...)

getFeatureFlag(options: GetFeatureFlagOptions) => Promise<GetFeatureFlagResult>

获取特征旗的值 .

回返情况: Promise<GetFeatureFlagResult>

自: 7.0.0 (单位:千美元)

获取 FeatureFlagPayload (...)

getFeatureFlagPayload(options: GetFeatureFlagPayloadOptions) => Promise<GetFeatureFlagPayloadResult>

获取特性旗的有效载荷.

回返情况: Promise<GetFeatureFlagPayloadResult>

自: 7.1.0 (中文(简体) )

获取会议( )

getSessionId() => Promise<GetSessionIdResult>

获取当前会话编号 .

回返情况: Promise<GetSessionIdResult>

自: 8.6.0 (简体中文)

组(...)

group(options: GroupOptions) => Promise<void>

把那个用户的事件和一群人联系起来.

自: 6.0.0 (单位:千美元)

标识(...)

identify(options: IdentifyOptions) => Promise<void>

识别当前用户 .

自: 6.0.0 (单位:千美元)

feature 启用(...)

isFeatureEnabled(options: IsFeatureEnabledOptions) => Promise<IsFeatureEnabledResult>

检查是否启用了特性旗 .

回返情况: Promise<IsFeatureEnabledResult>

自: 7.0.0 (单位:千美元)

optout () (中文(简体) )

isOptOut() => Promise<IsOptOutResult>

检查用户是否选择了不抓取 .

回返情况: Promise<IsOptOutResult>

自: 8.1.0 联合国

选择IN( )

optIn() => Promise<void>

选择到事件捕获.

自: 8.1.0 联合国

选择退出( C)

optOut() => Promise<void>

选择退出事件捕获.

在网络上与 cookielessMode: 'on_reject'切换到无饼干匿名追踪. 在iOS/Android上:完全停止所有事件捕获.

自: 8.1.0 联合国

注册(...)

register(options: RegisterOptions) => Promise<void>

登记一个新的超级财产。 每次活动都会送出这个地产.

自: 6.0.0 (单位:千美元)

重新装入FeatureFlags ()

reloadFeatureFlags() => Promise<void>

重新装入特性旗 .

自: 7.0.0 (单位:千美元)

重设( c)

reset() => Promise<void>

重置当前用户的ID和匿名ID.

自: 6.0.0 (单位:千美元)

屏幕(...)

screen(options: ScreenOptions) => Promise<void>

发送屏幕事件 .

仅在Android和iOS上提供.

自: 6.0.0 (单位:千美元)

设置个人财产(...)

setPersonProperties(options: SetPersonPropertiesOptions) => Promise<void>

设置当前用户关联人的属性 .

自: 8.6.0 (简体中文)

设置(...)

setup(options: SetupOptions) => Promise<void>

以提供的选项设置 PostHog SDK .

请注意:在任何其他方法之前,应先使用这种方法. 或者,在Android和iOS上,您可以在 您的电容配置文件 。 在这种情况下,你决不能叫这个方法.

自: 6.0.0 (单位:千美元)

开始记录( C)

startSessionRecording() => Promise<void>

开始录音.

自: 7.3.0 (单位:千美元)

停止记录( )

stopSessionRecording() => Promise<void>

停止录音.

自: 7.3.0 (单位:千美元)

未注册(...)

unregister(options: UnregisterOptions) => Promise<void>

删除一个超级属性 .

自: 6.0.0 (单位:千美元)

接口

非选项

抓取选项

捕获例外选项

堆叠外观

获取 DistinctId 结果

获取FeatureFlagResult 标签

获取 FeatureFlag 选项

获取FeatureFlagPayload 最终结果

获取 FeatureFlagPayload 选项

获取会议结果

组合选项

识别选项

能够实现的结果

是否允许选择

异地输出结果

注册选项

屏幕选项

设置个人财产选项

设置选项

会话重放选项

未注册选项

类型异名

JsonType (英语)

string | number | boolean | null | { [key: string]: JsonType; } | JsonType[]

高级

反向代理服务器

对于 PostHog 管理倒置代理, 设置 apiHost 转到您的代理 URL并 uiHost 到您的 PostHog 应用程序主机( S)https://us.posthog.com 或者说 https://eu.posthog.com) (中文(简体) ). host 仍作为折旧的别名支持 apiHost。 。 。 . uiHost 仅在网上提供.

财务问题

我一定要打电话给 setup 使用插件前的方法 ?

是的,那个 setup(...) 方法应在任何其他方法之前调用。 或者,在Android和iOS上,您可以在 Capacitor 配置文件中配置插件(参见 配置) (中文(简体) ). 那样的话,你就不能叫 setup(...) 方法.

二者有何区别 apiHost 财务报告和审定财务报表 host 选项?

这个 host 选项是用于 apiHost。两者都指向您 PostHog 实例的 API 主机或反向代理机。 如果提供了两种选择, apiHost 优先,所以新项目只应使用 apiHost。 。 。 .

我如何使用带有反向代理的插件?

设定 apiHost 选项 uiHost 选项到您的 PostHog 应用程序主机, 例如 https://us.posthog.com 或者说 https://eu.posthog.com。注意: uiHost 仅在网上提供。 见 反向代理服务器 详细情况.

我该如何重新播放会话?

设定 enableSessionReplay 选项到 true 输入 setup(...) 方法或控制器配置文件中,并用 sessionReplayConfig 选项。 您也可以开始并停止手动录制 startSessionRecording() 财务报告和审定财务报表 stopSessionRecording() 方法。 。 .

用户如何选择不跟踪?

打电话 optOut() 停止事件捕获的方法和 optIn() 重新启用的方法。 您可以检查当前状态 isOptOut() 或默认选择用户退出 optOut 设置选项。 在网络上与 cookielessMode: 'on_reject',选择退出开关进行无饼干匿名跟踪,而不是完全停止捕获.

我能用这个插件吗? 有Ionic、React、Vue或Angular?

是的,插件是框架不可知的。 它在任意网络框架的Capacitor app中工作,包括有Angular,React,或Vue的Ionic,以及平版JavaScript等项目.

相关插件

• 分析: Firebase Analytics 的非官方电容插件.
• 冰冻: Crisp直播和客户支持平台的非官方Capacitor插件.
• 窗体砖:非官方的Capacitor插件,用于Formbricks运行应用中调查.
• 格拉法纳·法罗: Grafana 的非官方电容插件 法罗监视你的应用.
• TikTok 应用事件: TikTok App Events SDK 的非官方 Capacitor 插件.

通讯

随时更新有关卡帕韦索姆、Capacitor和Ionic生态系统的最新消息和最新消息,因为我们 《卡帕索克通讯》。 。 。 .

更改日志

见 变动情况。 。 。 .

许可证

见 自由主义。 。 。 .

[^1]: 本项目不附属于PostHog公司或其任何子公司或子公司,不由它们认可、赞助或批准.