ZEPETO 分析

10min

ZEPETO分析是一个使统计API易于使用的包。
目前，Google Analytics可用。
👍 支持Google Analytics v4规范
﻿
步骤 1 : 安装
窗口 → 包管理器 → 请先安装ZEPETO.World包1.21.14版本。
之后，安装ZEPETO分析包。
﻿
﻿
步骤 2 : 创建Google Analytics数据流
📘 Google Analytics
https://analytics.google.com/﻿
创建Google Analytics帐户后，您必须创建一个数据流以在World中使用。（平均需要1天激活初始帐户。）
建议您为每个WorldId创建和管理一个数据流。
ZEPETO分析使用httpService发送数据，因此请确保选择“web”平台。
﻿
﻿
请在您写入URL的地方写下WorldId。
﻿
﻿
数据流创建完成后，您可以验证测量 ID。
﻿
﻿
要生成 API 密钥值，您必须输入测量协议 API 密钥菜单。
﻿
﻿
在右侧按下创建按钮后，完成昵称输入以生成密钥值。
﻿
﻿
请复制测量 ID 和密钥值以进行下一个过程。
﻿
步骤 3 : 如何使用
在层次窗口中，单击 ZEPETO → Zepeto Analytics 选项卡。
﻿
﻿
一个名为 Zepeto Analytics 的对象会自动创建，如下所示：
ZepetoAnalyticsComponent 是负责在场景中发送统计信息的组件。
在检查器窗口中，您可以输入发送统计信息所需的设置。
ZepetoAnalytics
﻿
﻿
请选择 Google Analytics 作为分析类型，并输入 API 密钥和测量 ID。
﻿
﻿
当您播放添加了 ZEPETO Analytics 组件的场景时，累计停留时间值会自动累积到 Google Analytics 中。
您可以从报告 > 实时概览菜单查看参与时间值。（报告项目（不包括实时选项卡）需要一定时间才能反映。）
如果场景发生变化并且组件被删除，统计数据将不会被发送。因此，如果您想保留它，请处理为不销毁。
❗️ 注意
如果您在编辑器测试期间检查调试模式，数据将不会发送到仪表板。
当您想堆叠数据时，请确保调试模式已关闭。
﻿
﻿
添加自定义事件
您可以基于自定义事件堆叠统计数据。
下面是一个示例代码，当您按下按钮时，它会向 Google Analytics 仪表板发送自定义事件。
TypeScript
import { ZepetoScriptBehaviour } from 'ZEPETO.Script';
import { AnalyticsType, ZepetoAnalyticsComponent } from 'ZEPETO.Analytics';
import { Button } from 'UnityEngine.UI';

export default class CustomEvent extends ZepetoScriptBehaviour {

    public zepetoAnalytics: ZepetoAnalyticsComponent;
    public myButton: Button;

    Start() {
        this.myButton.onClick.AddListener(() => {

            // 当按钮被点击时，一个随机事件被发送到 Google Analytics
            const ga = this.zepetoAnalytics.Analytics(AnalyticsType.GoogleAnalytics);

            interface CustomEvent {
                param_01 : string;
                param_02 : number;
            }

            const _event : CustomEvent = {
                param_01 : "param_string_val_01",
                param_02 : 3,
            }
            ga.LogEvent<CustomEvent>("custom_sub_param", _event);
        });
    }
}
import { ZepetoScriptBehaviour } from 'ZEPETO.Script';
import { AnalyticsType, ZepetoAnalyticsComponent } from 'ZEPETO.Analytics';
import { Button } from 'UnityEngine.UI';

export default class CustomEvent extends ZepetoScriptBehaviour {

    public zepetoAnalytics: ZepetoAnalyticsComponent;
    public myButton: Button;

    Start() {
        this.myButton.onClick.AddListener(() => {

            // 当按钮被点击时，一个随机事件被发送到 Google Analytics
            const ga = this.zepetoAnalytics.Analytics(AnalyticsType.GoogleAnalytics);

            interface CustomEvent {
                param_01 : string;
                param_02 : number;
            }

            const _event : CustomEvent = {
                param_01 : "param_string_val_01",
                param_02 : 3,
            }
            ga.LogEvent<CustomEvent>("custom_sub_param", _event);
        });
    }
}
﻿
﻿
确保在编写脚本后连接 Zepeto Analytics 组件。
下面的截图是一个配置好的组件示例，以使示例脚本正常工作。
﻿
﻿
从报告 > 实时概览菜单中，您可以看到自定义事件的值实时堆叠。
﻿
﻿
启用调试模式
Google Analytics 验证您发送的 CustomEvent 的 Payload Body。（如果无效，将不会发送）
检查调试模式可以轻松查看您在控制台窗口中发送的 Payload 的验证结果。
❗️ 注意
如果您在编辑器测试期间检查调试模式，数据将不会发送到仪表板。
当您想要堆叠数据时，请确保调试模式已关闭。
﻿
﻿
如果您创建的自定义事件不符合您的 Google 规范，则在调试模式下验证将失败。
﻿
﻿
有关 Google 规范和调试模式的信息，请访问：
📘  有关 Google 规范和调试模式的信息，请访问：
有关 Google 规范和调试模式的信息，请访问：
﻿
Google Analytics
﻿https://developers.google.com/analytics/devguides/collection/protocol/ga4/sending-events?hl=en&client_type=gtag﻿
Google Analytics 开发工具
﻿https://ga-dev-tools.web.app/ga4/event-builder/﻿
﻿
ZepetoBaseAnalytics API
功能
描述
LogEvent
允许您将自定义事件发送到链接的 Google Analytics 仪表板。

支持单个参数（字符串、数字、布尔值）和通用有效负载。

对于通用格式的有效负载，仅允许 Google Analytics 转移的表单可以被传输。

﻿https://developers.google.com/analytics/devguides/collection/protocol/ga4/validating-events?client_type=gtag

SetAnalyticsCollectionEnabled
启用/禁用 ZEPETO Analytics 组件的事件传输功能。可用于动态控制。

默认情况下，启用时 Analytics 组件为 True，禁用时为 False。

（基本停留时间从 ZEPETO Analytics 组件启用时自动记录。）
SendDuration
对于特定事件名称，您可以传输以毫秒（ms）为单位的停留时间。

可用于手动记录特定事件的参与时间。（独立于自动测量的停留时间。）

例如）用于手动记录“我在特定区域停留了 3 秒（3000 ms）”
SetUserProperty
对于您正在发送的事件，您可以添加自定义用户属性。
https://developers.google.com/analytics/devguides/collection/protocol/ga4/user-properties?hl=en&client_type=gtag

SetUserID
对于您正在发送的事件，您可以设置 Google Analytics 的 UserID 以进行区分。后续数据将在 Google Analytics 仪表板的用户部分单独收集。
﻿https://support.google.com/analytics/answer/9213390

默认情况下，每个用户通过映射到 (GA4) 会话单位在 ZEPETO UserId 单位中自动收集。
﻿

功能	描述
LogEvent	允许您将自定义事件发送到链接的 Google Analytics 仪表板。支持单个参数（字符串、数字、布尔值）和通用有效负载。对于通用格式的有效负载，仅允许 Google Analytics 转移的表单可以被传输。 https://developers.google.com/analytics/devguides/collection/protocol/ga4/validating-events?client_type=gtag
SetAnalyticsCollectionEnabled	启用/禁用 ZEPETO Analytics 组件的事件传输功能。可用于动态控制。默认情况下，启用时 Analytics 组件为 True，禁用时为 False。（基本停留时间从 ZEPETO Analytics 组件启用时自动记录。）
SendDuration	对于特定事件名称，您可以传输以毫秒（ms）为单位的停留时间。可用于手动记录特定事件的参与时间。（独立于自动测量的停留时间。）例如）用于手动记录“我在特定区域停留了 3 秒（3000 ms）”
SetUserProperty	对于您正在发送的事件，您可以添加自定义用户属性。 https://developers.google.com/analytics/devguides/collection/protocol/ga4/user-properties?hl=en&client_type=gtag
SetUserID	对于您正在发送的事件，您可以设置 Google Analytics 的 UserID 以进行区分。后续数据将在 Google Analytics 仪表板的用户部分单独收集。 https://support.google.com/analytics/answer/9213390 默认情况下，每个用户通过映射到 (GA4) 会话单位在 ZEPETO UserId 单位中自动收集。

更新日期 11 Oct 2024

此页面是否对您有帮助？