# Android App-push 統合
# App-pushの自動収集プラン
自動リサイクルプランは、SDK内部で各プラットフォーム(現在の段階ではFCM)のpush tokenおよびプッシュメッセージのクリックイベント(te_ops_push_click)を自動的に送信するプランです。
- データ収集SDKのバージョンを3.0.1-beta.2にアップグレードしてください。
implementation 'cn.thinkingdata.android:ThinkingAnalyticsSDK:3.0.1-beta.2'
- 自動収集のプラグインを導入します。バージョン2.1.0となります。
buildscript {
repositories {
google()
jcenter()
}
dependencies {
classpath 'cn.thinkingdata.android:android-gradle-plugin2:2.1.0'
}
}
プロジェクトの build.gradle ファイルでプラグイン関連のパラメータを設定します。
apply plugin: 'cn.thinkingdata.android'
android {
}
- 自動リサイクルプッシュリンクを起動します
val config = TDConfig.getInstance(
this,
TA_APP_ID,
TA_SERVER_URL
)
//プッシュ通知の自動回収を有効にする
config.enableAutoPush()
TDAnalytics.init(config)
- アカウントの切り替え
アカウントを切り替えた後、loginを呼び出す必要があります。SDK内部では、自動的にプッシュトークンがuser_setインタフェースを介して新しいアカウントに送信されます。
TDAnalytics.login("new_account_id")
#
# FCMプッシュ
カスタムFirebaseMessagingServiceは、コンパイル時にFirebaseMessagingServiceのonNewTokenメソッドをフックする原理であり、そのためにこのクラスを提供する必要があります。
class MyFirebaseMessagingService extends FirebaseMessagingService {
@Override
public void onNewToken(@NonNull String token) {
}
}
manifestファイルに登録します
<service
android:name="service"
android:exported="false">
<intent-filter>
<action android:name="com.google.firebase.MESSAGING_EVENT" />
</intent-filter>
</service>
# App-pushの手動収集プラン
# FCMプッシュ
# 1.1 "pushID"を送信
- ログインまたはアカウント切り替え後に、FCMのtokenをアップロードします。
//SDKの初期化
ThinkingAnalyticsSDK instance = ThinkingAnalyticsSDK.sharedInstance(this, APPID, SERVER_URL);
instance.login("user_id");
FirebaseMessaging.getInstance().getToken()
.addOnCompleteListener(new OnCompleteListener<String>() {
@Override
public void onComplete(@NonNull Task<String> task) {
if (!task.isSuccessful()) {
Log.w(TAG, "Fetching FCM registration token failed", task.getException());
return;
}
// Get new FCM registration token
String token = task.getResult();
JSONObject properties = new JSONObject();
properties.put("fcm_token",token);
instance.user_set(properties);
}
});
- FCMtokenが変更された場合、ユーザープロパティを更新します。
@Override
public void onNewToken(@NonNull String token) {
JSONObject properties = new JSONObject();
properties.put("fcm_token",token);
instance.user_set(properties);
}
# 1.2. クリックイベントの収集と送信
ユーザーがpushをクリックしたときにプッシュクリックイベントをアップロードすることができ、onCreateまたはonNewIntentでプッシュパラメータを取得できます。
public class PushOpenClickActivity extends AppCompatActivity {
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
handlePushOpen();
}
@Override
protected void onNewIntent(Intent intent) {
super.onNewIntent(intent);
handlePushOpen();
}
private void handlePushOpen() {
try {
Intent intent = getIntent();
if (intent == null) {
return;
}
Bundle bundle = intent.getExtras();
if (bundle == null) {
return;
}
String teExtras = bundle.getString("te_extras");
TEPushUtil.trackAppOpenNotification(teExtras);
} catch (Exception e) {
e.printStackTrace();
}
}
}
# 1.3. プッシュメッセージの処理
以下の2つの方法から1つを選択してください。
• 通常パラメータ:handleTEPushActionメソッドを呼び出します。
• 透過パラメータ:handleTEPassThroughActionメソッドを呼び出します。
public class PushOpenClickActivity extends AppCompatActivity {
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
handlePushOpen();
}
@Override
protected void onNewIntent(Intent intent) {
super.onNewIntent(intent);
handlePushOpen();
}
private void handlePushOpen() {
try {
Intent intent = getIntent();
if (intent == null) {
return;
}
Bundle bundle = intent.getExtras();
if (bundle == null) {
return;
}
String teExtras = bundle.getString("te_extras");
// 通常パラメータ
TEPushUtil.handleTEPushAction(teExtras);
//透過パラメータ
TEPushUtil.handleTEPassThroughAction(teExtras);
} catch (Exception e) {
e.printStackTrace();
}
}
}
# 付録
# クライアントが受け取ったプッシュパラメータの例
{
"te_extras": {
//プッシュ通知のリンク方法
"ops_loading_type": "OPEN_APP",
//透過パラメータ
"passthrough_params": {
"param1": "abc",
"param2": 101,
"param3": [{
"subText1": "xyz",
"subText2": 2
}]
},
//TEエンゲージでのチャネルレシートプロパティ
"#ops_receipt_properties": {
"ops_task_id": "0082",
"ops_project_id": 1,
"ops_task_instance_id": "0082_20230331",
"ops_push_language": "default",
"ops_task_exec_detail_id": "55"
}
}
}
# 自動収集が成功したかどうかを確認する方法はありますか?
- プッシュ通知のアクセス後、初回起動またはトークン変更時に、以下のイベントが送信されますか。
{
"#type": "user_set",
"#time": "2023-11-13 15:50:55.729",
"#distinct_id": "distinct",
"properties": {
"FCM_id": "190e35f7e15c8481caa"
},
"#uuid": "9f233c31-a664-46ff-94d6-f767a3098c3a"
}
- プッシュ通知をクリックしてアプリを起動し、te_ops_push_clickイベントが送信されるかどうかを観察し、イベントのプロパティにops_receipt_propertiesが含まれているかどうかを確認します。
{
"#type": "track",
"#time": "2023-03-16 16:08:32.191",
"#distinct_id": "90d80464-6832-43f1-80d9-bd93fc09c4fe",
"#event_name": "te_ops_push_click",
"properties": {
"#lib_version": "3.0.1-beata.1",
"#carrier": "au",
"#os": "Android",
"#device_id": "6262ca7f71e6aca3",
"#screen_height": 2400,
"#bundle_id": "jp.thinkingdata.random",
"#device_model": "M2012K11AC",
"#screen_width": 1080,
"#system_language": "jp",
"#install_time": "2023-03-10 11:24:44.285",
"#simulator": false,
"#lib": "Android",
"#manufacturer": "Galaxy",
"#os_version": "11",
"#app_version": "1.0",
"#fps": 60,
"#network_type": "WIFI",
"#ram": "2.7\/7.4",
"#disk": "4.6\/106.3",
"#device_type": "Phone",
"ops_receipt_properties": {
"ops_project_id": 1,
"ops_request_id": "3b21d2a8-8d3d-44fa-b460-3bb311ed3bcd"
},
"#zone_offset": 9
},
"#uuid": "7a977e23-b78a-4433-baae-ead17ad2fde9"
}
# trackAppOpenNotification
public static void trackAppOpenNotification(String extras) {
try {
if (TextUtils.isEmpty(extras)) {
return;
}
JSONObject jsonObject = new JSONObject(extras);
JSONObject properties = new JSONObject();
Object obj = json.opt("#ops_receipt_properties");
JSONObject ops = null;
if (obj instanceof String) {
ops = new JSONObject(( String ) obj);
} else if (obj instanceof JSONObject) {
ops = ( JSONObject ) obj;
}
properties.put("#ops_receipt_properties", ops);
ThinkingAnalyticsSDK instance = ThinkingAnalyticsSDK.sharedInstance(null, "appId", "serverUrl");
instance.track("te_ops_push_click", properties);
//すぐ送信
instance.flush();
} catch (Exception e) {
e.printStackTrace();
}
}
# handleTEPushAction
public static void handleTEPushAction(String extras) {
try {
if (TextUtils.isEmpty(extras)) {
return;
}
JSONObject jsonObject = new JSONObject(extras);
String type = jsonObject.optString("ops_loading_type");
if ("OPEN_APP".equals(type)) {
// TODO アプリを開くメッセージの処理--> Appを起動してください
} else if ("OPEN_URL".equals(type)) {
String url = jsonObject.optString("ops_url");
if (!TextUtils.isEmpty(url)) {
// TODO URLを開くメッセージの処理,--> URLを処理してください
}
} else if ("CUSTOMIZED".equals(type)) {
String custom = jsonObject.optString("ops_customized");
if (!TextUtils.isEmpty(custom)) {
// TODO カスタムメッセージの処理,--> カスタムメッセージを処理してください
}
}
} catch (Exception e) {
e.printStackTrace();
}
}
# handleTEPassThroughAction
public static void handleTEPassThroughAction(String extras) {
try {
if (TextUtils.isEmpty(extras)) {
return;
}
JSONObject jsonObject = new JSONObject(extras);
String params = jsonObject.optString("passthrough_params");
//paramsは透過パラメータであり、次に具体的なロジックの実装が続きます。
} catch (Exception e) {
e.printStackTrace();
}
}
# TEPushUtil类
public class TEPushUtil {
public static void trackAppOpenNotification(String extras) {
try {
if (TextUtils.isEmpty(extras)) {
return;
}
JSONObject jsonObject = new JSONObject(extras);
JSONObject properties = new JSONObject();
Object obj = json.opt("#ops_receipt_properties");
JSONObject ops = null;
if (obj instanceof String) {
ops = new JSONObject(( String ) obj);
} else if (obj instanceof JSONObject) {
ops = ( JSONObject ) obj;
}
properties.put("#ops_receipt_properties", ops);
ThinkingAnalyticsSDK instance = ThinkingAnalyticsSDK.sharedInstance(null, "appId", "serverUrl");
instance.track("te_ops_push_click", properties);
//すぐ送信
instance.flush();
} catch (Exception e) {
e.printStackTrace();
}
}
public static void handleTEPushAction(String extras) {
try {
if (TextUtils.isEmpty(extras)) {
return;
}
JSONObject jsonObject = new JSONObject(extras);
String type = jsonObject.optString("ops_loading_type");
if ("OPEN_APP".equals(type)) {
// TODO アプリを開くメッセージの処理--> Appを起動してください
} else if ("OPEN_URL".equals(type)) {
String url = jsonObject.optString("ops_url");
if (!TextUtils.isEmpty(url)) {
// TODO URLを開くメッセージの処理,--> URLを処理してください
}
} else if ("CUSTOMIZED".equals(type)) {
String custom = jsonObject.optString("ops_customized");
if (!TextUtils.isEmpty(custom)) {
// TODO カスタムメッセージの処理,--> カスタムメッセージを処理してください
}
}
} catch (Exception e) {
e.printStackTrace();
}
}
public static void handleTEPassThroughAction(String extras) {
try {
if (TextUtils.isEmpty(extras)) {
return;
}
JSONObject jsonObject = new JSONObject(extras);
String params = jsonObject.optString("passthrough_params");
//paramsは透過パラメータであり、次に具体的なロジックの実装が続きます。
} catch (Exception e) {
e.printStackTrace();
}
}
public static String getPushExtras(Object notificationExtras) {
String teExtras = "";
try {
if (notificationExtras != null) {
if (notificationExtras instanceof String) {
teExtras = new JSONObject((String) notificationExtras).optString("te_extras");
} else if (notificationExtras instanceof Map) {
teExtras = new JSONObject((Map) notificationExtras).optString("te_extras");
}
}
} catch (Exception e) {
e.printStackTrace();
}
return teExtras;
}
}