menu
Is this helpful?

# プリセットApp Push実装ガイド

# Android Push統合ガイド

# FCM Push

# 1.1 "Push ID" を送信

  • TEのログインまたはアカウント切り替え後に、FCMのTokenをアップロードしてください。
//TE 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);
        }
 });
  • FCM Token変更時，ユーザープロパティも同時変更：
@Override
public void onNewToken(@NonNull String token) {
    JSONObject properties = new JSONObject();
    properties.put("fcm_token",token);
    instance.user_set(properties);
}

# 1.2 プッシュのクリックイベントを収集

ユーザーが通知をクリックしたときにプッシュのクリックイベントをアップロードし、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 プッシュメッセージ処理

  • 一般パラメータ：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"
        }
    }
}

# 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("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("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;
    }

}

# iOS Push

# 2.1 "Push ID" を送信

  • TEのログインまたはアカウント切り替え後に、FCMのTokenをアップロードしてください。
NSString *appid = @"appid";
NSString *url = @"url";
TDConfig *config = [TDConfig new];
config.appid = appid;
config.configureURL = url;
ThinkingAnalyticsSDK *instance = [ThinkingAnalyticsSDK startWithConfig:config];

[[FIRMessaging messaging] tokenWithCompletion:^(NSString *token, NSError *error) {
      if (error != nil) {
        NSLog(@"Error getting FCM registration token: %@", error);
      } else {
        NSLog(@"FCM registration token: %@", token);
        [instance user_set:@{@"fcm_token": token}];
      }
}];

# 2.2 プッシュのクリックイベントを収集

// Handle notification messages after display notification is tapped by the user.
- (void)userNotificationCenter:(UNUserNotificationCenter *)center
didReceiveNotificationResponse:(UNNotificationResponse *)response
         withCompletionHandler:(void(^)(void))completionHandler {
    NSDictionary *userInfo = response.notification.request.content.userInfo;

    // クリックイベントを送信するMyClassは例の名前です。- trackAppOpenNotificationメソッドの定義は以下に示します。
    [MyClass trackAppOpenNotification:userInfo];
    
    completionHandler();
}

# 2.3 プッシュメッセージ処理

  • 一般パラメータ：handleTEPushActionメソッドを呼び出します。
  • パススルーパラメータ：handleTEPassThroughActionメソッドを呼び出します。
// Handle notification messages after display notification is tapped by the user.
- (void)userNotificationCenter:(UNUserNotificationCenter *)center
didReceiveNotificationResponse:(UNNotificationResponse *)response
         withCompletionHandler:(void(^)(void))completionHandler {
    NSDictionary *userInfo = response.notification.request.content.userInfo;
    
    // 一般パラメータを処理する場合、以下の方法を呼び出します。MyClassは例示の名前です。handleTEPushAction:メソッドの定義は以下に定義されています。
    [MyClass handleTEPushAction:userInfo];
    
    // パススルーパラメータを処理する場合、以下の方法を呼び出します。MyClassは例示の名称です。handleTEPassThroughAction：メソッドの定義は以下に示されています。
    [MyClass handleTEPassThroughAction:userInfo];
    
    completionHandler();
}

# 付録：

# クライアントが受け取ったプッシュパラメータの例

{
    "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"
        }
    }
}

# trackAppOpenNotification

+ (void)trackAppOpenNotification:(NSDictionary *)userInfo{
    NSMutableDictionary *pushProperties = [NSMutableDictionary dictionary]; // track dictionary
    @try {
        NSData *jsonData = [userInfo[@"te_extras"] dataUsingEncoding:NSUTF8StringEncoding];
        NSError *error;
        NSDictionary *sfDictionary = [NSJSONSerialization JSONObjectWithData:jsonData options:NSJSONReadingMutableContainers error:&error];
        if (!error && [sfDictionary isKindOfClass:NSDictionary.class]) {
            pushProperties[@"#ops_receipt_properties"] = sfDictionary[@"#ops_receipt_properties"];
        }
        [[ThinkingAnalyticsSDK sharedInstance]track:@"ops_push_click" properties:pushProperties];
        [[ThinkingAnalyticsSDK sharedInstance]flush];
    } @catch (NSException *exception) {
        
    }
}

# handleTEPushAction

+ (void)handleTEPushAction:(NSDictionary *)userInfo{
    NSMutableDictionary *pushProperties = [NSMutableDictionary dictionary]; // track dictionary
    @try {
        NSString *jsonString = userInfo[@"te_extras"];
        NSData *jsonData = [jsonString dataUsingEncoding:NSUTF8StringEncoding];
        NSError *error;
        NSDictionary *sfDictionary = [NSJSONSerialization JSONObjectWithData:jsonData options:NSJSONReadingMutableContainers error:&error];
        if (!sfDictionary || error) {
            return;
        }
        NSString *sf_landing_type = sfDictionary[@"ops_loading_type"];
        if ([sf_landing_type isEqualToString:@"OPEN_APP"]) {
            // open App　
        }
        else if ([sf_landing_type isEqualToString:@"OPEN_URL"]) {
            // open URL
           NSString *url = sfDictionary[@"ops_url"];
        }
        else if ([sf_landing_type isEqualToString:@"CUSTOMIZED"]) {
           // カスタムメッセージの処理
           NSString *customized = sfDictionary[@"ops_customized"];
        }
        
    } @catch (NSException *exception) {
        
    }
}

# handleTEPassThroughAction

+ (void)handleTEPassThroughAction:(NSDictionary *)userInfo{
    NSMutableDictionary *pushProperties = [NSMutableDictionary dictionary]; // track dictionary
    @try {
        NSString *jsonString = userInfo[@"te_extras"];
        NSData *jsonData = [jsonString dataUsingEncoding:NSUTF8StringEncoding];
        NSError *error;
        NSDictionary *sfDictionary = [NSJSONSerialization JSONObjectWithData:jsonData options:NSJSONReadingMutableContainers error:&error];
        if (!sfDictionary || error) {
            return;
        }
        NSString *params = sfDictionary[@"passthrough_params"];
        //paramsはパラメータをパススルーします。次に具体的な業務ロジックを実装します。
    } @catch (NSException *exception) {
        
    }
}

# Unity

# 3.1 "Push ID" を送信

  • TEのログインまたはアカウント切り替え後に、FCMのTokenをアップロードしてください。
//TE SDK 初期化
ThinkingAnalyticsAPI.StartThinkingAnalytics("APP_ID", "SERVER_URL");
//アカウントID設定
ThinkingAnalyticsAPI.Login("ACCOUNT_ID");
//FCM tokenをTEに送信
Firebase.Messaging.FirebaseMessaging.GetTokenAsync().ContinueWith(task => {
    var result = task.Result;
    ThinkingAnalyticsAPI.UserSet(new Dictionary<string, object>() { 
        { "fcm_token", task.Result } 
    });
});
  • FCM Token変更時，ユーザープロパティも同時変更：
private void Start()
{
    // FCM token更新委託イベントの登録
    Firebase.Messaging.FirebaseMessaging.TokenReceived += OnTokenReceived;
    Firebase.Messaging.FirebaseMessaging.MessageReceived += OnMessageReceived;
}

public void OnTokenReceived(object sender, Firebase.Messaging.TokenReceivedEventArgs token)
{
    //FCM tokenをTEに送信
    ThinkingAnalyticsAPI.UserSet(new Dictionary<string, object>() { 
        { "fcm_token", token.Token } 
    });
}

# 3.2. プッシュのクリックイベントを収集

ユーザーがプッシュをクリックしたときにプッシュクリックイベントをアップロードし、onCreateまたはonNewIntentでプッシュパラメーターを取得することができます。

private void Start()
{
    // FCM メッセージ委託イベントの登録
    Firebase.Messaging.FirebaseMessaging.MessageReceived += OnMessageReceived;
}

public void OnMessageReceived(object sender, Firebase.Messaging.MessageReceivedEventArgs e)
{
    // プッシュイベント送信 （TETrackMessageReceivedを参照）
    this.TETrackMessageReceived(e.Message.Data);
}

# 3.3. プッシュメッセージ処理

  • 一般パラメータ：handleTEPushActionメソッドを呼び出します。
  • パススルーパラメータ：handleTEPassThroughActionメソッドを呼び出します。
private void Start()
{
    // FCM メッセージ委託イベントの登録
    Firebase.Messaging.FirebaseMessaging.MessageReceived += OnMessageReceived;
}

public void OnMessageReceived(object sender, Firebase.Messaging.MessageReceivedEventArgs e)
{
    //一般パラメータ （TEHandlePushActionを参照）
    this.TEHandlePushAction(e.Message.Data);
    //パススルーパラメータ
    this.TEHandlePassThroughAction(e.Message.Data);
}

# 付録：

# クライアントが受け取ったプッシュパラメータの例

{
    "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"
        }
    }
}

# TETrackMessageReceived

private void TETrackMessageReceived(IDictionary<string, string> data)
{
    //FCM message を TE システムに
    Dictionary<string, object> te_extras = ThinkingAnalytics.Utils.TD_MiniJSON.Deserialize(data["te_extras"]);
    Dictionary<string, object> properties = new Dictionary<string, object>();
    if (te_extras.ContainsKey("#ops_receipt_properties"))
    {
        properties.Add("#ops_receipt_properties", te_extras["#ops_receipt_properties"]);
    }
    ThinkingAnalytics.ThinkingAnalyticsAPI.Track("ops_push_click", properties);
    ThinkingAnalytics.ThinkingAnalyticsAPI.Flush();
}

# TEHandlePushAction

private void TEHandlePushAction(IDictionary<string, string> data)
{
    Dictionary<string, object> te_extras = ThinkingAnalytics.Utils.TD_MiniJSON.Deserialize(data["te_extras"]);
    string type = te_extras["ops_loading_type"].ToString();
    if ("OPEN_APP".Equals(type))
    {
        // TODO アプリのメッセージを開く処理　→Appを起動してください
    }
    else if ("OPEN_URL".Equals(type))
    {
        string url = te_extras["ops_url"].ToString();
        if (!string.IsNullOrEmpty(url))
        {
            // TODO URLを処理する　→URLの処理をしてください
        }
    }
    else if ("CUSTOMIZED".Equals(type))
    {
        string custom = te_extras["ops_customized"].ToString();
        if (!string.IsNullOrEmpty(custom))
        {
            // TODO カスタムメッセージを処理　→ カスタムメッセージを処理してください
        }
    }
}

# TEHandlePassThroughAction

private void TEHandlePassThroughAction(IDictionary<string, string> data)
{
    Dictionary<string, object> te_extras = ThinkingAnalytics.Utils.TD_MiniJSON.Deserialize(data["te_extras"]);
    string params = te_extras["passthrough_params"].ToString();
    //paramsはパラメータをパススルーします。次に具体的な業務ロジックを実装します。
}

← 条件、First or last、指標値タグ →