Analytics 事件参数

Note: Gaming Services Analytics is now available as a preview package. Gaming Services Analytics is an improved offering that allows you to easily understand game performance and player behaviors so you can make strategic decisions. See the documentation.

标准事件和自定义事件都允许将其他信息作为事件的一部分发送到 Analytics 服务。标准事件和自定义事件之间的唯一区别是大多数标准事件都具有必需或可选参数，这些参数优先于任何自定义参数。

Pass your custom parameters to the appropriate AnalyticsEvent function in the form of a Dictionary<string, object> instance. The keys of this dictionary are the parameter names, and the values are the parameter values. When creating this dictionary, maintain consistent key names and data types for each parameter in your event data, both within a single version of your game as well as from version to version. For example, don’t send a level name parameter as a number sometimes and as a string at other times. Doing this can make your data difficult to interpret.

注意：自定义参数字典的键名称不要以前缀 “unity” 开头（这是为内部 Unity Analytics 事件保留的）。

Unity 会将发送到 Analytics 服务的值序列化。即使添加到字典的数据类型是字符串，它也会将数字字符解析为数字。换言之，将字符串 “51” 添加到参数字典等同于添加数字 51。

最多可以为每个事件传输十个参数。对于标准事件，此限制包括必需参数和需要赋值的任何可选参数（未用的可选参数不计入此限制）。此外，传递给事件的单个键名称和字符串值的长度不得超过 100 个字符，并且所有键名称和字符串值的总长度不得超过 500 个字符。

为了提高效率，可以将参数字典实例创建为类成员，并在每次分发事件时重复使用该字典。重复使用字典对象可避免每次发送事件时分配内存。因此会减少 C# 垃圾回收器需要清理的内存分配。在场景中分发事件的频度越高，该做法越有用。以下示例定义了一个分发自定义事件的类。该类将参数字典定义为实例变量，并在每次发送事件时设置参数值。

using System.Collections.Generic;
using UnityEngine;
using UnityEngine.Analytics;

public class MyCustomAnalyticsEvent : MonoBehaviour {
    private const string Name = "my_custom_event";

    private Dictionary<string, object> parameters 
        = new Dictionary<string, object>();

    void Start(){
        // 使用默认值定义参数
        parameters.Add("character_class", "Unknown");
        parameters.Add("health", 0);
        parameters.Add("xp", 0);
        parameters.Add("world_x", 0);
        parameters.Add("world_y", 0);
        parameters.Add("world_z", 0);
    }

    public bool Dispatch(string characterClass, 
                         int health, 
                         int experience, 
                         Vector3 location){
                         
        // 为特定事件设置参数值
        parameters["character_class"] = characterClass;
        parameters["health"] = health;
        parameters["xp"] = experience;
        parameters["world_x"] = location.x;
        parameters["world_y"] = location.y;
        parameters["world_z"] = location.z;

        // 发送事件
        AnalyticsResult result 
            = AnalyticsEvent.Custom(Name, parameters);
        if(result == AnalyticsResult.Ok){
            return true;
        } else {
            return false;
        }
    }
}

这一做法也可用于随标准事件一起发送的自定义参数。

• 2018–03–02 页面已发布

• 截至 2018–03–02，服务与 Unity 5.2 之后的版本兼容，但是版本兼容性可能会发生变化

• 5.2 中的新功能