辅助电容插件
Appcues Capacitor 插件允许您将 Appcues 体验整合到您的iOS和Android设备的Ionic apps中.
这个电容器是一个Ionic应用程序中本地的Appcues SDKs之间的桥梁,它向Appcues API发送用户属性和事件,并检索和使Appcues内容基于这些属性和事件.
开始
先决条件
最新的软件包版本需要Capacitor 8. 使用 @appcues/[email protected] 7号电容.
机器人
你的申请 build.gradle 必须有一个 compileSdkVersion 第36个+和 minSdkVersion 您的项目应该使用Android Gradle插件(AGP)的8.13+版本.
android {
compileSdkVersion 36
defaultConfig {
minSdkVersion 24
}
}
由于Jetpack Compose的SDK用法,AGP 8应用程序必须应用 kotlin-android 应用程序中的插件 build.gradle。AGP 9+默认启用内置的克特林,不应应用.
plugins {
id 'com.android.application'
id 'kotlin-android' // AGP 8 only
}
iOS系统
您的应用程序必须瞄准iOS 15+. 必要时更新iOS项目xcodeproj,以设定部署目标.
安装
在您的应用的根目录中, 运行 :
npm install @appcues/capacitor
npx cap sync
注意: 您不需要手动更新您的 Pod 文件以添加 Appcues .
一次性设置
初始化 SDK
当您的应用启动时, 应用 SDK 应该初始化 .
import { Appcues } from '@appcues/capacitor';
Appcues.initialize({
accountId: 'APPCUES_ACCOUNT_ID',
applicationId: 'APPCUES_APPLICATION_ID',
});
初始化 SDK 需要您提供两个值,即 Appcues 账户ID 和 Appcues 移动应用程序ID 。 这些值可以从您的 应用程序设置。请参考关于 正在工作室注册您的移动应用程序 更多信息.
配置主机环境
默认情况下,Appcues SDK将向美国(美国)托管环境发送数据,不需要额外的配置. 要指定不同的托管环境,请通过一个配置 apiBasePath 财务报告和审定财务报表 settingsHost 选项.
欧盟托管环境配置
Appcues.initialize({
accountId: 'APPCUES_ACCOUNT_ID',
applicationId: 'APPCUES_APPLICATION_ID',
config: {
apiBasePath: 'https://api.eu.appcues.net',
settingsHost: 'https://fast.eu.appcues.com',
},
});
支持构建器预览和屏幕抓取
在安装过程中,遵循下列步骤: 配置 URL 方案。这对于完整的 Appcues 构建器体验、支持体验预览、屏幕捕获和调试是必要的.
启用推动通知
IOS和Android的原生项目中, 请参考当地文献: iOS系统 财务报告和审定财务报表 机器人 更多细节。 这个 example 本寄存器中的目录包含一个包括推取通知支持的参考执行.
识别用户
为了在正确的时间瞄准正确的用户内容,需要识别用户并发送有关他们的Appcues数据. 一个用户被识别出一个独特的ID.
// Identify a user
Appcues.identify({ userId: 'my-user-id' });
// Identify a user with property
Appcues.identify({ userId: 'my-user-id', properties: { company: 'Appcues' } });
在识别用户后,您可以选择将该用户与组关联.
// Associate a user with a group, optionally including group properties
Appcues.group({ groupId: 'group-id', properties: { plan: 'standard' } });
为了确保基于组信息最准确的内容针对性,建议在新用户确定后立即提供组信息.
跟踪屏幕和事件
事件是您的用户在您的应用程序中接受的“ 动作”, 从点击某个按钮到查看某个特定的屏幕都可以是任何东西 。 一旦安装并初始化了 Appcues Capacitor 插件,您就可以开始使用下列方法跟踪屏幕和事件:
// Track event
Appcues.track({ name: 'Sent Message' });
// Track event with property
Appcues.track({ name: 'Deleted Contact', properties: { id: 123 } });
// Track screen
Appcues.screen({ title: 'Contact List' });
// Track screen with property
Appcues.screen({ title: 'Contact List', properties: { reference: 'abc' } });
悬疑工具提示
Anchored 工具提示使用元素瞄准来直接指向应用程序中的特定视图. 关于如何配置您应用程序对元素目标视图的更多信息,请参见: Anchored 工具提示指南。 。 。 .
页:1
有关这一电容器的更多技术文件载于 文档自动生成的文件 这里。 。 。 .
实例
这个 example 此寄存器中的目录包含完整的例子 iOS/Android app,用于为正确安装和使用 Appcues API提供参考.
捐款
见 贡献指南 学习如何为发展做好准备以及如何为该项目作出贡献.
许可证
这个项目根据麻省理工学院的许可证获得许可。 见 自由主义 更多信息.