vue-sdk-ios 1.1.0

vue-sdk-ios 1.1.0

×

由 Jiju S Jacob维护，Vue.AI SDK.

vue-sdk-ios 1.1.0

  • 由
  • Mad Street Den Inc.

Vue SDK

目录

概述

VueSDK 是一个库/SDK，提供构建和集成 Vue.AI 提供的所有功能和工具所需的函数和实用工具。要了解可用的详细用例集合 - 请点击此链接

快速开始指南

1. 安装 Vue SDK

初始化库需要您项目的令牌。您可以从项目设置中获取项目令牌。

使用 CocoaPods

  1. 如果您是第一次使用 CocoaPods，请使用 gem install cocoapods 安装 CocoaPods。否则，继续到步骤 3。
  2. 运行 pod setup 以创建本地的 CocoaPods 规范镜像。
  3. 在您的 Xcode 项目目录中运行 pod init，编辑生成的 Podfile，并添加以下行：pod 'vue-sdk-ios'。
  4. 在 Xcode 项目目录中运行 pod install。CocoaPods 应下载并安装 VUE SDK 库，并创建一个新的 Xcode 工作空间。在 Xcode 中打开此工作空间或通过在终端中输入 open *.xcworkspace 打开。

2. 初始化 VueSDK

将 vue_sdk_ios 导入到 AppDelegate.swift 中，并在 application:didFinishLaunchingWithOptions: 中初始化 VueSDK。

import vue_sdk_ios

func application(_ application: UIApplication,
                 didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
    ...
    VueSDK.initialize(token: "YOUR_TOKEN",baseUrl: "GIVEN_VUE_BASE_URL")
    ...
}

3. 发现事件

为了保证事件跟踪的准确性和完整性，建议在 SDK 集成中调用 track 函数之前调用 discoverEvents 函数。discoverEvents 函数检索跟踪事件的相关信息，例如事件名称、属性和默认属性。此步骤允许您填充必要的数据并相应地配置事件跟踪。

VueSDK.mainInstance().discoverEvents(success: { (response) in
            //Handle success
        }, failure: { error in
            //Handle failure
        })

4. 跟踪事件

要使用我们的 SDK 跟踪自定义事件，您可以利用 track 函数。此函数允许您捕获应用中的特定动作或交互，并收集用于分析的有价值数据。

以下是使用 track 函数的示例

VueSDK.mainInstance().track(
    eventName: "YOUR_CUSTOM_EVENT_NAME",
    properties: ["YOUR_KEY" : "YOUR_VALUE"],
    correlationID: "UNIQUE_CORRRELATION_ID",
    sdkConfig: VueSDKConfig(medium: "",url: "",platform: "",referrer: "")
 );

注意： correlationId 是一个可选参数，允许您为事件提供唯一的关联 ID。请确保每个页面（搜索和跟踪 API 调用）的 correlationId 在整个唯一

SDK 在跟踪事件时自动包含一些属性。这些属性对于全面的事件跟踪至关重要，并为用户交互提供了宝贵的见解。以下是由 SDK 自动添加的属性。通过为 track 函数显式提供 SDK 配置参数，用户可以覆盖每个属性的值

密钥 描述 示例值
platform 用户的平台 ios
medium 请求发送的介质 application
referrer 与平台的相同值，用于移动应用 ios
url 应用程序的包ID com.example.myapp

5. 获取推荐

SDK 中的 getRecommendation 函数允许您根据特定的搜索标准和属性获取推荐。此函数提供了一种方便的方式获取推荐并以异步方式接收结果。

1. 通过页面获取推荐

 VueSDK.mainInstance().getRecommendationsByPage(
    pageReference: "YOUR_PAGE_NAME",
    properties: RecommendationRequest(
        catalogs: [:]
    ),
    correlationID: "UNIQUE_CORRRELATION_ID",
    sdkConfig: VueSDKConfig(medium: "",url: "",platform: "",referrer: "")
) { response, error in
    if error != nil {
        // Handle Error case
    } else {
        // Handle Success case
    }
}

2. 通过模块获取推荐

 VueSDK.mainInstance().getRecommendationsByModule(
    moduleReference: "YOUR_MODULE_NAME",
    properties: RecommendationRequest(
        catalogs: [:]
    ),
    correlationID: "UNIQUE_CORRRELATION_ID",
    sdkConfig: VueSDKConfig(medium: "",url: "",platform: "",referrer: "")
) { response, error in
    if error != nil {
        // Handle Error case
    } else {
        // Handle Success case
    }
}

3. 通过策略获取推荐

VueSDK.mainInstance().getRecommendationsByStrategy(
    strategyReference: "YOUR_STRATEGY_NAME",
    properties: RecommendationRequest(
        catalogs: [:]
    ),
    correlationID: "UNIQUE_CORRRELATION_ID",
    sdkConfig: VueSDKConfig(medium: "",url: "",platform: "",referrer: "")
) { response, error in
    if error != nil {
        // Handle Error case
    } else {
        // Handle Success case
    }
}

注意： correlationId 是一个可选参数，允许您为搜索请求提供唯一的关联ID。确保 correlationId 在搜索和跟踪 API 调用中跨页面都是唯一的。

以下是 SDK 自动为 getRecommendations 函数添加的属性。通过显式提供 getRecommendations 函数的 SDK 配置参数，用户可以覆盖每个属性的值。

密钥 描述 示例值
platform 用户的平台 ios
medium 请求发送的介质 application
referrer 与平台的相同值，用于移动应用 ios
url 应用程序的包ID com.example.myapp

6. 设置用户

SDK 中的 setUser 函数允许您在用户登录后将其与随后的 API 调用相关联。此用户 ID 用于跟踪特定于用户的事件和行为，提供个性化的体验和准确的分析。

 VueSDK.mainInstance().setUser(userId: "YOUR_USER_ID")

7. 重置用户

SDK 中的 resetUser 函数允许您在用户从应用程序中注销时清除用户信息并重置 SDK 状态。这确保任何特定于用户的数据和跟踪都被清除，并且不再与用户相关联。

 VueSDK.mainInstance().resetUser()

8. 设置 BloxUUID

SDK 中的 setBloxUUID 函数允许您设置 blox UUID，该 UUID 用作 getRecommendations 和 track 函数的参数。如果在未设置 bloxUUID 的情况下，SDK 将在 SDK 函数调用时内部生成一个随机的 UUID，并且会保持此值直到调用 setBloxUUID。

 VueSDK.mainInstance().setBloxUUID(bloxUUID: "BLOX_UUID")

注意： 提供的 BloxUUID 将存储在应用程序的缓存中，并在应用程序的生命周期内保持。

9. 获取 BloxUUID

SDK 中的 getBloxUUID 函数返回 SDK 中配置的 blox UUID。

 VueSDK.mainInstance().getBloxUUID()

注意： 如果在整个应用程序的生命周期中没有调用 setBloxUUID 或 SDK 函数，getBloxUUID 函数将返回 null 值。

10. VueSDK 调试和日志记录

SDK 提供了内部日志记录功能以用于调试目的。默认情况下，日志记录功能是关闭的。

要启用内部日志记录，将 isLoggingEnabled 设置为 true

VueSDK.mainInstance().isLoggingEnabled = true

完整代码示例

以下是一个示例代码，它涵盖了本快速入门指导中的所有内容。

import vue_sdk_ios

func application(_ application: UIApplication,
                 didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
    ...

    VueSDK.initialize(token: "YOUR_TOKEN",baseUrl: "GIVEN_VUE_BASE_URL");

    VueSDK.mainInstance().track(
 	eventName: "YOUR_CUSTOM_EVENT_NAME",
 	Properties: ["YOUR_KEY" : "YOUR_VALUE"]
    );

    VueSDK.mainInstance().getRecommendationsByPage(
        pageReference: "YOUR_PAGE_NAME",
        properties: RecommendationRequest(
            catalogs: [:]
        ),
        correlationID: "UNIQUE_CORRRELATION_ID"
    ) { response, error in
        if error != nil {
            // Handle Error case
        } else {
            // Handle Success case
        }
    }

    ...
}

我想了解更多！

有任何疑问？请与技术支持团队 联系，以快速与智力高超的人进行交流。