ZEPETOアナリティクス

10min

ZEPETO Analyticsは、統計APIを簡単に使用できるパッケージです。
現在、Google Analyticsが利用可能です。
👍 Google Analytics v4仕様がサポートされています
﻿
ステップ 1 : インストール
ウィンドウ → パッケージマネージャ → まずZEPETO.Worldパッケージ1.21.14バージョンをインストールしてください。
その後、ZEPETO Analyticsパッケージをインストールします。
﻿
﻿
ステップ 2 : Google Analyticsデータストリームの作成
📘 Google Analytics
https://analytics.google.com/﻿
Google Analyticsアカウントを作成した後、Worldで使用するデータストリームを作成する必要があります。（初期アカウントの有効化には平均して1日かかります。）
WorldIdごとに1つのデータストリームを作成し、管理することをお勧めします。
ZEPETO Analyticsは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は、送信するカスタムイベントのペイロードボディを検証します。（無効な場合は送信されません）
デバッグモードをチェックすると、コンソールウィンドウで送信するペイロードの検証結果を簡単に確認できます。
❗️ 注意
エディターテスト中にデバッグモードをチェックすると、データはダッシュボードに送信されません。
データをスタックしたい場合は、デバッグモードがオフになっていることを確認してください。
﻿
﻿
Googleの仕様に合わないカスタムイベントを作成すると、デバッグモードで検証に失敗します。
﻿
﻿
Googleの仕様とデバッグモードに関する情報は、こちらをご覧ください：
📘  Googleの仕様とデバッグモードに関する情報は、こちらをご覧ください：
Googleの仕様とデバッグモードに関する情報は、こちらをご覧ください：
﻿
Googleアナリティクス
﻿https://developers.google.com/analytics/devguides/collection/protocol/ga4/sending-events?hl=en&client_type=gtag﻿
Googleアナリティクス開発ツール
﻿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

デフォルトでは、各ユーザーはZEPETO UserIdユニットの（GA4）セッションユニットにマッピングされて自動的に収集されます。
﻿

機能	説明
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 デフォルトでは、各ユーザーはZEPETO UserIdユニットの（GA4）セッションユニットにマッピングされて自動的に収集されます。

更新日 11 Oct 2024

このページは役に立ちましたか？

世界通貨

CLIでパッケージをビルドする