深入解析PlayFab Events API - Structed博客

事件API是一种全新的API，用于将遥测和播放流事件发送到PlayFab，以便进行后续分析或支持反应式编程（事件驱动架构）。相比传统的客户端分析API，事件API在功能和效率上都有显著提升，同时也保留了对遗留API的兼容性。

传统API的局限性

传统的客户端分析API设计初衷是为了方便客户端应用程序的使用，提供了许多便捷的端点，用于将与特定上下文（如玩家、角色等）相关的数据发送到PlayStream。然而，这种API存在以下局限性：

• 单事件限制：每次调用只能接收一个事件。
• 性能瓶颈：受限于API速率和客户端HTTP开销，接收能力有限。
• 功能缺失：不支持遥测事件和实体编程模型。

事件API的优势

事件API克服了传统API的所有限制，提供了以下改进：

• 批量处理：支持在单次请求中批处理多个事件，大幅提升事件摄取效率。
• 成本节约：减少客户端带宽使用，尤其适合移动场景。
• 功能扩展：支持遥测事件和实体编程模型。

其中，使用遥测事件带来的成本节约是事件API的最大亮点。

PlayStream与Telemetry的区别

PlayStream和Telemetry共享相同的设计理念，均可视为与特定实体（如标题播放器、角色等）相关的事件，并以键值对列表作为有效载荷。两者的主要区别在于事件到达后的处理方式：

• 遥测事件：仅被摄入数据湖，用于后续分析。
• PlayStream事件：支持实时反应，可用于事件驱动架构和反应式编程。

示例：发送遥测事件

以下是一个发送遥测事件的代码示例：

func_on_WriteTelemetryDirectButton_pressed():
    var payload = {"操作": "_on_WriteTelemetryDirectButton_pressed"}
    PlayFabManager.events.write_title_player_telemetry_event(event_NAME_ELEMETRY, payload)

在Unity中的实现：

EventModels.WriteEventsRequest request = new EventModels.WriteEventsRequest();
request.Events = new List();

// 一些元数据（必需）
EventModels.EventContents eventInfo = new EventModels.EventContents();
eventInfo.Name = "unity_client_api_error_occurred";
eventInfo.EventNamespace = eventNamespace;
eventInfo.Entity = entityKey;
eventInfo.OriginalTimestamp = DateTime.UtcNow;

// 自定义有效载荷
var payload = new Dictionary();
payload["ErrorCode"] = errorCode;
payload["ErrorType"] = type;
eventInfo.Payload = payload;

request.Events.Add(eventInfo);
var result = await eventsApi.WriteTelemetryEventsAsync(request);

PlayStream事件的实时反应能力

PlayStream事件的独特之处在于其支持实时反应。通过PlayFab的分析功能，您可以在事件发生后立即采取行动。例如：

• 设置规则触发Azure函数或赠送物品。
• 使用PlayStream事件实现比赛历史记录等功能。

此外，PlayFab内置了许多触发事件，例如用户登录事件，这些数据不仅可用于分析，还可用于自动化或用户细分。

数据分析功能

通过事件API获取的数据可以用于多种分析场景：

遥测分析

利用ViewModel的内置分析功能，您可以分析玩家行为或系统性能。如果需要更高级的分析功能，还可以将数据导出到外部系统。

标题概述

在Game Manager的标题概述页面，您可以看到基于内置事件的仪表板，实时监控PlayStream事件的分布和位置。

仪表板与趋势分析

Game Manager的仪表板部分提供了趋势分析功能，帮助您了解游戏表现的关键趋势。

数据浏览器

Game Manager集成了Azure数据浏览器，支持基本UI分析和高级KQL查询。此外，您还可以通过事件导出或数据连接将原始事件数据导出到其他分析系统。

自动化功能

PlayFab的自动化功能允许您对PlayStream事件做出反应，而无需额外编写代码。通过设置规则，您可以指定事件类型、条件和操作。例如：

• 在玩家注册后发送欢迎邮件。
• 使用CloudScript函数触发后端代码执行。

总结

事件API通过支持批量处理、遥测事件和实体编程模型，显著提升了PlayFab的事件处理能力，同时降低了成本和带宽使用。结合PlayStream的实时反应能力和强大的数据分析功能，开发者可以更高效地构建事件驱动的游戏架构。

无论是分析玩家行为、优化系统性能，还是实现自动化操作，事件API都为开发者提供了强大的工具支持。

原文链接: https://blog.structed.me/posts/playfab-events-api