应用反应原生模块
Appcues React Introduct 模块允许您将 Appcues 体验整合到您的 React Introduct 应用程序中,用于iOS和Android设备.
这个本地模块是本地Appcues SDKs在React Introduction应用程序中的桥梁,它向Appcues API发送用户属性和事件,并检索和使Appcues内容基于这些属性和事件.
开始
先决条件
原生反应 - 您的应用程序应当使用 React Native 0.73 或以上版本。 使用"博览会"的应用程序应当使用"50"或"50"以上版本. 从4.4.0版本开始,"新架构"得到充分的支持.
机器人 - 你的应用程序 build.gradle 必须有一个 compileSdk 第35个+和 minSdk ,并使用Android Gradle插件(AGP) 8.6+(建议8.8.2+).
android {
compileSdk 35
defaultConfig {
minSdk 21
}
}
AGP 版本 < 8.8.2 (反应原生版本 < 0.79),您可能需要添加 随行 给您的 gradle.properties数字 :
android.experimental.lint.version = 8.8.2
iOS系统 - 您的应用程序必须针对 iOS 11+ 安装 SDK, 而 iOS 13+ 来渲染 Appcues 内容 。 必要时更新iOS项目xcodeproj,以设定部署目标. 在申请中 Podfile,至少包括此最小版本.
# Podfile
platform :ios, '11.0'
安装
在您的应用程序中添加 Appcues React 本地模块依赖性 。 标准安装或通过分块插件使用都有选择.
标准安装
- 在您的应用程序的根目录中安装 Appcues React 本地模块
npm install --save @appcues/react-native # OR yarn add @appcues/react-native - 根据你的申请
ios文件夹,运行pod install
注意: 您不需要手动更新您的 Pod 文件以添加 Appcues .
部分
应用程序支持与 Session 合并 分析-反应-内在 软件包。 要安装断面,请使用 部件应用程序插件。 。 。 .
一次性设置
初始化 SDK
当您的应用启动时, 应用 SDK 应该初始化 .
import * as Appcues from '@appcues/react-native';
await Appcues.setup('APPCUES_ACCOUNT_ID', 'APPCUES_APPLICATION_ID');
初始化 SDK 需要您提供两个值,即 Appcues 账户ID 和 Appcues 移动应用程序ID 。 这些值可以从您的 应用程序设置。请参考关于 正在工作室注册您的移动应用程序 更多信息。 由于反应原生桥是同步的 setup 调用在调用后续 SDK 函数之前应当解决.
配置主机环境
默认情况下,Appcues SDK将向美国(美国)托管环境发送数据,不需要额外的配置. 要指定不同的托管环境,请通过 apiHost 财务报告和审定财务报表 settingsHost 选项.
欧盟托管环境配置
await Appcues.setup('APPCUES_ACCOUNT_ID', 'APPCUES_APPLICATION_ID', {
apiHost: 'https://api.eu.appcues.net',
settingsHost: 'https://fast.eu.appcues.com',
});
支持构建器预览和屏幕抓取
在安装过程中,遵循下列步骤: 配置 URL 方案。这对于完整的 Appcues 构建器体验、支持体验预览、屏幕捕获和调试是必要的.
启用推动通知
在 React Industrial app中,在iOS和Android的原生项目中配置了推进通知. 请参考当地文献: iOS系统 财务报告和审定财务报表 机器人 更多细节。 这个 example 本寄存器中的目录包含一个包括推取通知支持的参考执行. 关于世博会的应用软件,请参见 应用- expo- 模块 以整合推进通知.
识别用户
为了在正确的时间瞄准正确的用户内容,需要识别用户并发送有关他们的Appcues数据. 一个用户被识别出一个独特的ID.
// Identify a user
Appcues.identify('my-user-id');
// Identify a user with property
Appcues.identify('my-user-id', { Company: 'Appcues' });
在识别用户后,您可以选择将该用户与组关联.
// Associate a user with a group, optionally including group properties
Appcues.group('group-id', { 'Plan Tier': 'standard' });
为了确保基于组信息最准确的内容针对性,建议在新用户确定后立即提供组信息.
跟踪屏幕和事件
事件是您的用户在您的应用程序中接受的“ 动作”, 从点击某个按钮到查看某个特定的屏幕都可以是任何东西 。 一旦安装并初始化了 Appcues React Natural 模块,您就可以使用以下方法开始跟踪屏幕和事件:
// Track event
Appcues.track('Sent Message');
// Track event with property
Appcues.track('Deleted Contact', { ID: 123 });
// Track screen
Appcues.screen('Contact List');
// Track screen with property
Appcues.screen('Contact Details', { 'Contact Reference': 'abc' });
悬疑工具提示
Anchored 工具提示使用元素瞄准来直接指向应用程序中的特定视图. 关于如何配置您应用程序对元素目标视图的更多信息,请参见: Anchored 工具提示指南。 。 。 .
内在经验
添加 AppcuesFrameView 在应用程序布局中支持嵌入式体验内容的示例,并采用非模式演示文稿。 有关如何配置应用程序布局以使用帧视图的更多信息,请参见: 配置一个配置FrameView。 。 。 .
页:1
有关该模块的更多技术文件载于 docs 目录。完整的文件可在 https://docs.appcues.com/ (中文(简体) )
实例
这个 example 此寄存器中的目录包含完整的例子 iOS/Android app,用于为正确安装和使用 Appcues API提供参考.
捐款
见 贡献指南 学习如何为发展做好准备以及如何为该项目作出贡献.
许可证
这个项目根据麻省理工学院的许可证获得许可。 见 自由主义 更多信息.