Appcues NativeScript 插件

Appcues NativeScript 插件允许您将 Appcues 体验集成到您的 iOS 和 Android 设备中。

Appcues NativeScript 插件

🚀 开始使用

先决条件

Android - 您的应用程序的 App_Resources/Android/app.gradle 必须有 33+ 的 compileSdkVersion 和 21+ 的 minSdkVersion

android {
    compileSdkVersion 33

    defaultConfig {
        minSdkVersion 21
    }
}

iOS - 您的应用程序必须针对 iOS 11+ 来安装 SDK，针对 iOS 13+ 来渲染 Appcues 内容。如果需要，更新 App_Resources/iOS/build.xcconfig 来设置部署目标。在应用程序的 App_Resources/iOS/Podfile 中，至少包含以下最低版本。

# Podfile
platform :ios, '11.0'

安装

在您的应用程序根目录中运行

npm install @nstudio/nativescript-appcues

一次性设置

初始化 SDK

当您的应用程序启动时，应初始化 Appcues SDK 的一个实例。

import { Application } from '@nativescript/core';
import { AppcuesSDK } from '@nstudio/nativescript-appcues';

Application.on(Application.launchEvent, () => {
    AppcuesSDK.init('APPCUES_ACCOUNT_ID', 'APPCUES_APPLICATION_ID');
});

初始化 SDK 需要您提供两个值，一个 Appcues 账户 ID 和一个 Appcues 移动应用程序 ID。这些值可以从您的 Appcues 设置中获取。有关更多信息，请参阅在 Studio 中注册您的移动应用程序的帮助文档。

识别用户

为了在正确的时间和用户处定位内容，您需要识别用户并向 Appcues 发送有关他们的数据。用户通过一个唯一的 ID 识别。

// Identify a user
AppcuesSDK.identify('my-user-id')
// Identify a user with property
AppcuesSDK.identify('my-user-id', { company: "Appcues"})

跟踪屏幕和事件

事件是用户在您的应用程序中采取的“操作”，可以是点击某个按钮到查看特定屏幕等任何操作。一旦您安装并初始化了 Appcues NativeScript 插件，您就可以开始使用以下方法跟踪屏幕和事件

// Track event
AppcuesSDK.track("Sent Message")
// Track event with property
AppcuesSDK.track("Deleted Contact", { id: 123 })

// Track screen
AppcuesSDK.screen("Contact List")   
// Track screen with property
AppcuesSDK.screen("Contact List", { reference: "abc" })

📝 文档

API 在这里可用 here.

完整的文档可在 https://docs.appcues.com/ 上找到

🎬 示例

此存储库中的示例示例包含提供正确安装和使用 Appcues API 参考的 iOS/Android 应用程序。

📄 许可证

此项目采用 Apache 2.0 许可证。有关更多信息，请参阅 LICENSE。