从旧版 Analytics 升级到 UGS Analytics

背景

Unity Gaming Services(Unity 游戏服务)于 2021 年 10 月推出,这是一个端到端平台,提供灵活的解决方案,可帮助您构建、管理和拓展游戏。

Analytics 是一种数据可视化和后台工具,可帮助您了解和分析所有游戏数据。此工具可独立使用(类似于旧版 Analytics),也可与其他 UGS 产品一起使用以获得更多功能。您可以使用 Analytics 分析您的游戏从开发到生产阶段的整个过程。

Unity Analytics 可供免费开始使用,并提供慷慨的免费套餐,超出此套餐后则按增量付费,即只需按使用量付费,请参阅我们的 Analytics 定价

您可以参加我们关于 UGS Analytics 的 Unity Learn 课程,了解更多关于 UGS Analytics 的信息。

从此处开始使用

对旧版 Analytics 用户的影响

为了将更多资源投入到我们的 UGS Analytics 平台上,Unity 不再投资旧版 Analytics,并自 2023 年 6 月起停止了对后台的访问。新项目会在新的 Unity Gaming Services(Unity 游戏服务)Analytics 平台中创建;对于现有项目,我们建议参考本指南进行迁移。

我们已尽最大努力尽可能简化现有客户的过渡过程,先前提供了一个数据管线,旨在确保您的指标和 KPI 在过渡期间保持稳定。先前,我们提供了一个数据管线来确保在此过程中指标和 KPI 的稳定性。但是,从 2024 年 4 月 15 日开始,该管线会停止将新数据从旧版 Analytics 平台传送到 UGS Analytics 后台。

Unity Analytics 将根据我们的数据保留政策保留 13 个月的历史数据,供您参考。要继续有效地分析玩家数据,将 Analytics SDK 集成到项目中至关重要。我们强烈建议您尽快执行此操作,以便您的玩家群有充足的时间更新到最新的游戏版本。这一主动步骤将能确保在逐步淘汰旧版数据管线时保留尽可能多的玩家数据。请参阅计费以了解 MAU 定价。

如需有关安装 Analytics SDK 的指导,请参阅下面的分步指南。如需更多有关过渡的信息,请阅读我们的常见问题解答

开始使用 UGS

步骤 1:关联您的项目

需要在 Unity 编辑器中将您的本地项目版本与 Unity Project ID 关联。

  1. 转到 Edit(编辑)> Project Settings(项目设置)> Services(服务)
  2. 使用您现有的凭据登录。
  3. 从下拉列表中选择您的项目并选择 Link project ID(关联项目 ID)

步骤 2:安装 UGS Analytics SDK

要安装 Unity 最新的 UGS Analytics SDK,请使用最新的 Unity 编辑器版本并执行以下步骤:

  1. 在 Unity 编辑器中,打开 Window(窗口)> Package Manager(包管理器)
  2. 在 Package Manager(包管理器)中,选择 Unity Registry(Unity 注册表)列表视图。
  3. 在包列表中搜索“Analytics”(而不是“Analytics Library”)。
  4. 选择该软件包,然后选择 Install(安装)

请参阅 Package Manager(包管理器)文档

如需更多详细信息,请参阅 SDK 初始设置

初始化 UGS Analytics SDK 后,会在首次运行 UGS Analytics SDK 时自动发送 newPlayer 事件,在每次游戏运行时自动发送 gameStarted 和 clientDevice 事件,每分钟发送一次 gameRunning 事件。请参阅标准事件

事件在触发后大约 15 分钟显示在后台的 Event Browser(事件浏览器)中。所有其他 Analytics 功能中的指标和事件最多可能需要 2 小时才能显示,首次触发时,会每小时刷新一次。如需更多调试信息,请参阅此处

注意:为了在旧版和新版 Analytics 平台之间实现数据连续性,我们建议使用新版 UGS Analytics SDK 提供的 userID。此 userID 在两个 Analytics 平台之间共享,供旧版数据管线用于避免事件重复。当 UGS Analytics SDK 发送 userID 事件时,该用户会在旧版数据管线中被列入黑名单。这意味着,如果仍有事件进入旧版 Analytics,这些事件将被处理并正常显示在旧版 Analytics 后台上,但不会通过此旧版数据管线传递到 UGS Analytics 中。

步骤 3:创建自定义事件

在 Event Manager(事件管理器)中创建每个自定义事件以匹配记录的事件:

  1. 转到 Unity Dashboard(Unity 后台)中 Analytics 下的 Event Manager(事件管理器)
  2. 创建自定义事件并确保名称匹配。
  3. 创建并分配参数,确保定义所有参数,以免事件被归类为无效。

注意:在游戏代码中创建但未在 Event Manager(事件管理器)中定义的自定义事件将被视为无效事件,不会跟踪数据。这些事件会显示在 Event Browser(事件浏览器)中。

步骤 4:更改事件记录方法

更新您的游戏代码以使用此处详述的“AnalyticsService.Instance.CustomData”方法记录自定义事件。

更改前:

public class GameLoginMonoBehaviour : MonoBehaviour
{
    public void OnGameOver()
    {
        int totalPotions = 5;
        int totalCoins = 100;
#if ENABLE_CLOUD_SERVICES_ANALYTICS
        Analytics.CustomEvent("gameOver", new Dictionary<string, object>
        {
            { "potions", totalPotions },
            { "coins", totalCoins }
        });
#endif
    }
}

更改后:

// Create parameter custom event (Same as Legacy Analytics)
public class GameLoginMonoBehaviour : MonoBehaviour
{
    public void OnGameOver()
    {
        int totalPotions = 5;
        int totalCoins = 100;
		// The 'gameOver' event will get queued up and sent with the
        // regular 60 second upload
        AnalyticsService.Instance.CustomData("gameOver", new Dictionary<string, object>
        {
            { "potions", totalPotions },
            { "coins", totalCoins }
        }); 

		// Optional - You can call Events.Flush() to send the event
		// immediately else it will be cached and sent with the next 
		// scheduled upload within the next 60 seconds
		Events.Flush();
    }
}

自定义事件在 Event Browser(事件浏览器)中进行验证,或在新的 Data Explorer(数据资源管理器)中进行分析。如果需要多次测试大量事件,可以创建一个测试环境,让实时环境仅保留玩家的数据。请点击此处阅读有关环境的更多信息。