# React Native
最新バージョン:2.3.0
更新時間:2021-08-10
ダウンロード:SDK (opens new window)
# SDK 実装
react-native-thinking-data 自動と手動の 2 つの実装方法があり、自動実装が推奨されます。
# 1.1 自動実装
# 1. npm インストール react-native-thinking-data
npm install react-native-thinking-data --save
# 2. link react-native-thinking-data
react-native link react-native-thinking-data(React Native versions earlier than 0.60)
cd ios&&pod install(React Native version 0.60 or later)
# 1.2 手動実装
# 1. npm インストール react-native-thinking-data
npm install react-native-thinking-data --save
# 2. Android&iOS 設定
- iOS
- In XCode, in the project navigator, right click
Libraries
➜Add Files to [your project's name]
- Go to
node_modules
➜react-native-thinking-data
and addRNThinkingData.xcodeproj
- In XCode, in the project navigator, select your project. Add
libRNThinkingData.a
to your project'sBuild Phases
➜Link Binary With Libraries
- Run your project (
Cmd+R
)
- Android
- Open up
android/app/src/main/java/[...]/MainActivity.java
- Add
import cn.thinking.RNThinkingDataPackage;
to the imports at the top of the file - Add
new RNThinkingDataPackage()
to the list returned by thegetPackages()
method
- Append the following lines to
android/settings.gradle
:
include ':react-native-thinking-data'
project(':react-native-thinking-data').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-thinking-data/android')
- Insert the following lines inside the dependencies block in
android/app/build.gradle
:
compile project(':react-native-thinking-data')
インポートが完了した後、SDK を ReactNative で使用できます
# SDK 初期設定
初期設定デモコード:
import thinkingdata, { AutoTrackEventType } from "react-native-thinking-data";
thinkingdata.init({ appid: "xxx", serverUrl: "https://xxx" });
パラメータ説明:
APPID
: プロジェクトの APPID、TE プロジェクト管理画面にて取得可能SERVER_URL
: データ送信 URL- SaaS の場合はプロジェクト管理 → データアクセス URL にて確認してください
- プライベート構築の場合は、データ送信 URL を指定することが可能
Android 9.0+はデフォルトで HTTP リクエストが制限されているため、HTTPS を利用してください。
# メイン機能
メイン機能を利用する前に、ユーザー識別ルールを確認してくだ;
SDK はゲスト ID を自動で作成し、ローカルで保存される;ユーザーがログインする前に、ゲスト ID を身分識別 ID として使われます。
注意:ゲスト ID はユーザーがアプリを再インストール時にリセットされます。
# 3.1 アカウント ID を設置
ユーザーがログインする時に、login
を呼び出して、ユーザーのアカウント ID を設定できます。TE プラットフォームはアカウント ID を身分識別 ID としてlogout
を呼び出しする前までに保留します。login
を数回呼び出すと、前のアカウント ID が上書きされます。
thinkingdata.login("TE");
login
複数回呼び出すことができ、呼び出しごとに、アカウント ID が以前に保存された ID と一致するかどうかが判断されます。一致する場合、呼び出しは無視され、一致しない場合は、以前の ID が上書きされます。
この方法ではログインイベントを送信されません
# 3.2 共通イベントプロパティ設定
共通イベントプロパティは全てのイベントに含まれるプロパティとなります。setSuperProperties
を呼び出しして設定することできます。イベント送信する前に、共通イベントプロパティを設定しておいてください。
例えば:プレイヤーのレベル、戦闘力、所持資源などのプロパティ
thinkingdata.setSuperProperties({
channel: "te", //string
age: 1, //number
isSuccess: true, //boolean
birthday: new Date(), //time
object: {
key: "value",
}, //object
object_arr: [{ key: "value" }], //array object
arr: ["value"], //array
});
共通イベントプロパティはキャッシュに保存され、ページをアクセスする度に呼び出す必要はありません。もし呼び出す場合はsetSuperProperties
:以前設定した共通イベントプロパティは上書きされます。
- Key は当プロパティの名称で string タイプで、英文字と数字、 "_"を含め、最大 50 文字。TE システムは一律で小英文字に統一されます
- Value は当プロパティの値で、String, Number, Bloon, Time, object, array, list object を対応しております。
イベントプロパティ、ユーザープロパティは共通イベントプロパティと一致する必要があります。
# 3.3 自動収集イベントの On/Off
クライアント SDK は一部イベントを自動収集することが可能で、実際業務状況に応じて on/off にしてください。以下は参考となります。詳しくは自動収集ガイド
thinkingdata.enableAutoTrack([AutoTrackEventType.APP_END, AutoTrackEventType.APP_START, AutoTrackEventType.APP_INSTALL)
# 3.4 イベント送信
track
を呼び出してイベントの送信を行います。事前にデータプランをご用意の上、送信してください。以下はモデルコードとなります。例:アイテム購入
thinkingdata.track(
"product_buy", //event name
{ product_name: "tv" } //event properties
);
# 3.5 ユーザープロパティ設定
一般のユーザープロパティに関しては、user_set
を利用して設定することができますが、 UserSet
は元の値を上書きされます。本来該当プロパティに値がない場合は、プロパティが新規作成されます。以下はコード例となります。
//the username now is TA
thinkingdata.userSet({ username: "TA" });
//the username now is TE
thinkingdata.userSet({ username: "TE" });
# コード例のまとめ
以下のコード例で全ての操作が含まれます、以下の順で利用推奨しております:
import thinkingdata, { AutoTrackEventType} from "react-native-thinking-data";
if (Authorized Privacy policy)
{
//SDK init
thinkingdata.init({appid: "xxx",serverUrl: "https://xxx",});
//if the user has logged in, the account ID of the user could be set as the unique identifier
thinkingdata.login("TA")
//After setting super properties, each event would have super properties
ta.setSuperProperties({
'channel': 'ta',//string
'age': 1,//number
'isSuccess': true,//boolean
'birthday': new Date(),//time
'object': {'key': 'value'},//object
'object_arr': [{ 'key': 'value'}],//array object
'arr': ['value']//array
})
//Enable auto-tracking
thinkingdata.enableAutoTrack([AutoTrackEventType.APP_INSTALL,AutoTrackEventType.APP_START, AutoTrackEventType.APP_END])
//upload events
thinkingdata. track(
"product_buy",//event name
{product_name:"tv"}//event properties
)
//Set user properties
thinkingdata.userSet({ username:"TE"})
}