6Labs >

适用于 Unity 的 6Labs SDK

本节介绍如何将 6Labs SDK 集成到您的 Unity 应用中。

前提条件

  • 需要 Unity 2021 LTS 或更高版本。旧版本可能可以运行,但不受积极支持。
  • 仅限 Apple 平台 — 请确保开发机器上已安装以下工具:
    • Xcode 26.2 或更高版本
    • CocoaPods 1.12.0 或更高版本
  • 您的 Unity 项目必须满足以下最低部署目标:
    • iOS — iOS 15 或更高版本
    • tvOS — tvOS 15 或更高版本
    • Android — API 级别 23(Android 6.0 Marshmallow)或更高版本

1. 下载并导入模块

6Labs SDK 以 Unity 包文件 SixLabsSDK-1.1.10.unitypackage 的形式提供。

按照以下步骤将该模块添加到您的 Unity 项目中:

  1. 下载 SDK 安装包 (包含最新版本的 6Labs Unity SDK)。
  2. 将安装包导入到您的 Unity 项目中:
    • 在 Unity 编辑器中点击 Assets > Import Package > Custom Package.
    • 从系统中选择已下载的 .unitypackage 文件。
    • 点击 Import 完成导入。

2. 开始观察游戏

调用 Init() 方法初始化 SDK,并开始观察游戏,如下所示:

using SixLabs.SDK;

SixLabsSDK.Instance.Init( inGameId: "<optional_player_in_game_id>",
developerPayload: "<optional_developer_payload_here>"
);

重要说明

  • 如果未传递 inGameId,观察到的会话可能会被丢弃,并且不会用于 AI 分析。缺少该字段时,无法将会话归属到玩家,而这是生成后续洞察所必需的。
  • 在开始观察游戏之前,请确保已获得用户同意。SDK不会自动请求权限,相关的授权流程需要在您的游戏逻辑中自行实现。
  • 作为推荐的最佳实践,您可以在游戏的EULA(最终用户许可协议)或隐私政策中说明游戏观察相关内容。
  • 请确保您的应用已为目标平台启用所需的网络访问权限。
  • 该SDK无法在Unity Editor中运行。要进行正确测试,您需要创建特定平台的构建并在真实设备上运行。

方法说明

以下为 Init() 方法的参考信息。

方法签名

public void Init(string inGameId = null, string developerPayload = null)

参数说明

参数 类型 必填 说明
inGameId string 游戏内的用户唯一标识。如果未传入该参数,则默认使用空字符串。
developerPayload string 与会话关联的可选开发者自定义元数据。该值会随会话请求原样转发,可用于附加自定义追踪信息或上下文信息。提供更丰富的 developerPayload 可以显著提升 AI 驱动的分析能力和会话理解效果。
示例:

  • 用户获取渠道
  • 活动 Campaign ID
  • 用户分群(例如:新用户 / 回访用户 / 付费用户)
  • A/B 测试变体(例如:variant_a、variant_b)— 将用户划分为不同的队列,并在 6Labs 控制台中对比各队列的游戏数据。
  • 内部追踪标识

3. 高级控制

在大多数集成场景中,只需调用 Init() 即可开始观察游戏。

如果需要更精细地控制游戏观察的开始或结束时间,开发者也可以直接使用 StartSession()StopSession() 方法。

3.1 开始观察

当需要显式控制游戏观察的开始时,可以调用 StartSession() 方法。

SixLabsSDK.Instance.StartSession( inGameId: "<optional_player_in_game_id>",
developerPayload: "<optional_developer_payload_here>"
);

方法签名

public void StartSession(string inGameId = null, string developerPayload = null)

参数说明

参数 类型 必填 说明
inGameId string 游戏内的用户唯一标识。如果未传入,则默认为空字符串。
developerPayload string 与会话关联的可选开发者自定义元数据。该值会随会话请求原样转发,可用于附加自定义追踪信息或上下文信息。提供更丰富的 developerPayload 可以显著提升 AI 驱动的分析能力和会话理解效果。

3.2 停止观察

调用 StopSession() 方法停止游戏观察。

SixLabsSDK.Instance.StopSession();

重要说明

  • 该方法用于停止游戏观察。
  • 之后可以再次调用 StartSession() 开始新的观察。
×

目录

适用于 Unity 的 6Labs SDK

目录

文档版本 1.0

Text copied to clipboard
Link copied to clipboard
有疑问?请通过以下方式联系我们: dev-support@6labs.ai