メインコンテンツまでスキップ

Egret

最終更新 2026/10/07
ヒント

接続する前に、まず接続前の準備をお読みください。

Egret SDKの対応プラットフォーム：HTML5、iOS、Android、WeChatミニゲーム、Baiduミニゲーム、Xiaomiクイックゲーム、OPPOミニゲーム、vivoミニゲーム、QQミニゲーム、360ミニゲーム、ByteDanceミニゲーム、Huaweiクイックゲーム、Alipayミニゲーム、Taobaoクリエイティブインタラクティブミニプログラム、Facebook。

最新バージョン: v3.0.2

更新日: 2024-02-09

リソースのダウンロード: ソースコード、SDKダウンロード

注意

このドキュメントはv3.0.0以降のバージョンに適用されます。以前のバージョンについては、Egret接続ガイド（V2）、SDKダウンロード（v2.2.4）を参照してください

1. SDKの統合​

Egret SDKをダウンロードして解凍します。

SDKライブラリの導入手順は、他のサードパーティライブラリの導入と同じです。egretProperties.jsonでこのライブラリを導入し、エンジンをコンパイルします。

{
     "name": "ta_egret_sdk",
     "path": "./libs/ta_egret_sdk"
}

プロジェクトに導入した後、エンジンをコンパイルするとSDKライブラリを使用できます。

2. 初期化​

AE SDKを導入すると、コード内でTDAnalyticsを使用できます:

// AE SDKの設定オブジェクト
var config = {
  appId: "YOUR_APPID", // プロジェクトのAPP ID
  serverUrl: "YOUR_SERVER_URL", // 送信先URL
  autoTrack: {
    appLaunch: true, // ta_mg_launchを自動収集
    appShow: true, // ta_mg_showを自動収集
    appHide: true // ta_mg_hideを自動収集
  }
};
// 初期化
TDAnalytics.init(config);

AEの設定オブジェクトのパラメーターは次のとおりです：

  • appId: プロジェクトのAPP IDです。必須です。AEの「プロジェクト管理」ページで確認できます

  • serverUrl: データの送信先URLです。必須です

    • クラウドサービスを利用している場合は、次を入力します: https://global-receiver-ta.thinkingdata.cn
    • プライベートデプロイ版を利用している場合は、送信先URLを運用担当者に確認してください

  • autoTrack：任意です。自動収集機能を有効にするかどうかを表し、各要素はそれぞれ次の自動収集イベントを表します。デフォルトではすべて無効です：

    • appLaunch：ミニゲームの初期化を自動収集
    • appShow：ミニゲームの起動、またはバックグラウンドからフォアグラウンドへの移行を自動収集
    • appHide：ミニゲームのフォアグラウンドからバックグラウンドへの移行を自動収集し、今回のアクセス（起動からバックグラウンドへの移行まで）の時間を記録
注意

データを送信する前に、WeChat公式プラットフォームまたはその他のプラットフォームの開発設定で、データ転送URLをサーバードメインのrequestリストに追加してください。

3. よく使う機能​

よく使う機能を使用する前に、まずユーザー識別ルールを確認することをお勧めします。SDKはデフォルトで乱数を生成してゲストIDとし、ゲストIDをローカルに永続的に保存します。ユーザーがログインするまでは、ゲストIDが識別IDとして使われます。注意:ゲストIDは、ユーザーがキャッシュを削除したり、デバイスを変更したりすると変わります。

3.1 アカウントIDの設定​

ユーザーがログインする際にloginを呼び出して、ユーザーのアカウントIDを設定できます。AEプラットフォームはアカウントIDを識別IDとして使用し、設定したアカウントIDはlogoutを呼び出すまで保持されます。loginを複数回呼び出すと、以前のアカウントIDが上書きされます。

// ユーザーのログイン時の一意の識別子。このデータは送信データの#account_idに対応し、この場合#account_idの値はTAになります
TDAnalytics.login("TA");

このメソッドはログインイベントを送信しません

3.2 共通イベントプロパティの設定​

共通イベントプロパティとは、すべてのイベントに付与されるプロパティのことです。setSuperPropertiesを呼び出して共通イベントプロパティを設定できます。イベントを送信する前に、共通イベントプロパティを設定しておくことを推奨します。ユーザーの会員レベルや流入チャネルなどの重要なプロパティは、すべてのイベントに設定する必要があります。その場合は、これらのプロパティを共通イベントプロパティとして設定できます。

var superProperties = {
    channel : "ta", //文字列
    age : 1,//数値
    isSuccess : true,//ブール値
    birthday :  new Date(),//時間
    object : { key : "value" },//オブジェクト
    object_arr : [ { key : "value" } ],//オブジェクトグループ
    arr : [ "value" ]//配列
};
TDAnalytics.setSuperProperties(superProperties);//共通イベントプロパティを設定

共通イベントプロパティはキャッシュに保存されるため、起動するたびに呼び出す必要はありません。setSuperPropertiesを呼び出して以前に設定済みの共通イベントプロパティを送信した場合は、以前のプロパティが上書きされます。

  • Keyはプロパティの名前で、文字列型です。英字で始まり、数字、英字、アンダースコア"_"のみを含めることができます。最大長は50文字です。英字の大文字と小文字は区別されず、AEではすべて小文字に変換されます
  • Valueはプロパティの値で、文字列、数値、ブール値、時間、オブジェクト、オブジェクトグループ、配列に対応しています

イベントプロパティとユーザープロパティの要件は、共通イベントプロパティと同じです

3.3 イベントの送信​

trackを呼び出してイベントを送信できます。事前に整理したトラッキングドキュメントに従って、イベントのプロパティと送信条件を設定することをお勧めします。ここでは、ユーザーが商品を購入する場合を例にします：

TDAnalytics.track({
    eventName: "product_buy", // イベント名
    properties: {
        product_name: "商品名"
    } //イベントプロパティ
});

イベント名は文字列型で、英字で始まり、数字、英字、アンダースコア"_"を含めることができます。最大長は50文字です。

3.4 ユーザープロパティの設定​

一般的なユーザープロパティは、userSetを呼び出して設定できます。このインターフェースで送信したプロパティは、既存のプロパティ値を上書きします。そのユーザープロパティが以前に存在しない場合は新しく作成され、タイプは渡されたプロパティのタイプと同じになります。ここでは、ユーザー名の設定を例にします：

//この時点でusernameはTA
TDAnalytics.userSet({
    properties: {
        username: "TA"
    }
});
//この時点でusernameはAE
TDAnalytics.userSet({
    properties: {
        username: "AE"
    }
});

4. ベストプラクティス​

次のサンプルコードには、上記のすべての操作が含まれています。次の手順で使用することをお勧めします:

var TDAnalytics = require("./tdanalytics.mg.egret.min.js");
var config = {
  appId: "YOU-APP-ID", // プロジェクトのAPP ID
  serverUrl: "https://youserverurl.com", // データの送信先URL
  autoTrack: {
    appLaunch: true, // ta_mg_launchを自動収集
    appShow: true, // ta_mg_showを自動収集
    appHide: true // ta_mg_hideを自動収集
  }
};
// 初期化
TDAnalytics.init(config);
// ユーザーのログインの一意な識別子です。このデータは送信データの#account_idに対応し、この場合#account_idの値はTAになります
TDAnalytics.login("TA");
//共通イベントプロパティを設定
var superProperties = {
    channel : "ta", //文字列
    age : 1,//数値
    isSuccess : true,//ブール値
    birthday :  new Date(),//時間
    object : { key : "value" },//オブジェクト
    object_arr : [ { key : "value" } ],//オブジェクトグループ
    arr : [ "value" ]//配列
};
TDAnalytics.setSuperProperties(superProperties);
//イベントを送信
TDAnalytics.track({
    eventName: "product_buy", // イベント名
    properties: {
        product_name: "商品名"
    } //イベントプロパティ
});
//ユーザープロパティを設定
TDAnalytics.userSet({
    properties: { 
        username: "AE" 
    }
});
このページは役に立ちましたか？
このページの内容