将自定义标记用于 PlayStream 事件

自定义标记是密钥值对的集合,用户可以选择在每个 API 请求中包含这些密钥。 它们对于用更多用户特定的元数据(如构建号、外部跟踪标识符等)来丰富标准的 PlayStream 事件非常有用。

自定义标记扩展了使用 PlayStream 事件的方式。 PlayStream 基本架构是固定的,它缺少可扩展性,但可以构建常见指标和分析。 这种架构的固定特性限制了用户以高效经济的方式自定义其数据的能力,以及收集特定数据点的能力。 自定义标记提供了一种扩展构架的方法,以实现更大的灵活性和功能。

使用自定义标记可以做什么?

使用自定义标记可以完成许多任务。 下面有一些建议,但在使用这些建议时,请自由发挥更大的创造力。

自动化

PlayStream 元数据可充当触发特定事件的条件。 当需要完成一项任务时,PlayFab 客户可以设置规则,即“如果 [自定义标记] 满足 xyz 要求,则启动操作 A”。

可集成 CloudScript 和自定义标记以实现自动化。 使用 CloudScript 操作和规则 ,可基于特定条件自动触发事件。

例如,如果你的游戏工作室为游戏投入性能市场营销,并且你正在运行各种不同的市场营销活动,以获得新的玩家,则现在可跟踪获得玩家的市场营销活动,并将该活动 ID 添加到所有 PlayStream 事件中。 然后,可使用市场活动 ID 来自动执行流程。 例如,如果广告中承诺“注册可获得 1,000 个免费金币”,请发送“新玩家”事件,并使用市场营销活动确定向该玩家提供什么奖励。 例如,如果市场营销活动 ="FREE_GOLD_COINS",则向玩家提供 1,000 个金币。

遥测

PlayStream 元数据可协助数据收集和分析。 例如,你可以将自定义标记作为非 PlayFab 服务的部分 PlayStream 事件数据发送,并且能够在它通过数据管道流时跟踪该数据。 如果你已经拥有自己的分析系统(例如,基于某些标识符),则可以通过在自定义标记中传递标识符作为 PlayStream 事件的一部分,轻松集成和合并新数据。

你可以添加市场营销活动 ID 或其他分析标识符来分析收益,确定哪个活动产生了最高的新玩家采集、收益流或客户价值。

数据流

从 API 请求接收自定义标记后,数据将成为 PlayStapi 事件的一部分,然后通过 PlaySteam 管道将其存储在 PlayFab 的后端数据中心 Kusto 中。

限制

  • 自定义标记具有以下限制:
    • 不超过 10 个密钥值对
    • 每个键字符串不能超过 64 utf8 字符
    • 每个值字符串不能超过 128 utf8 字符
    • 仅支持 API 调用(例如,Game Manager UI 不支持)

入门

以下示例请求展示如何将自定义标记添加到 JSON 请求。 CustomTags 通过流经数据管道跟踪相关 PlayStream 事件,然后可以访问这些数据并进行分析。

示例请求

POST https://titleId.playfabapi.com/Server/WritePlayerEvent
{
  "PlayFabId": "{{PlayFabId}}",
  "EventName": "player_defeated_enemy",
  "Timestamp": "2016-03-07T00:00:00Z",
  "Body": {
    "Enemy": "guardian",
    "Damage": 5,
    "Coordinates": {
      "X": 123.4,
      "Y": 543.2
    }
  },
  "CustomTags": {
    "correlation_id": "123abc",
    "build_number": "1.0.0.0",
    "platform": "iOS"
  }
}

示例响应

添加自定义标记不会更改从调用终结点收到的响应。 添加 CustomTag node 后的响应与不存在节点时收到的响应相同。