Android SDK API

SDKインターフェースの説明

• MTMAApi、SDKのすべてのインターフェースを含む。

MA機能の有効化

サポートされるバージョン

サポート開始バージョン：5.0.0

インターフェース定義

• start(UserIdentity userIdentity, CallBack callBack)
  • インターフェースの説明：
    • MA機能の使用を開始します。有効化時にユーザー識別情報を同時に設定できます。
  • パラメータの説明：
    • userIdentity：呼び出し識別子。設定しない場合はnullを指定できます。
      • setUserId(String userId)：userId、一意のログインユーザー識別子をここで設定します。
      • setAnonymousId(String anonymousId)：anonymousId、ユーザーがログインしていないが他の識別可能な情報を提供している場合、匿名IDとして設定できます（例：メールアドレスや第三者が生成した識別ID）。
    • callBack：結果データのコールバック。
  • 戻り値の説明：
    onCallBack(int code, String message)
    • code：戻り値コード。0は成功を示し、-1は失敗を示します。具体的な理由はmessageパラメータの説明を参照してください。
    • message：理由の説明。

呼び出し例

              
                              MTMAApi.getInstance(this).start(new CallBack() {
                    @Override
                    public void onCallBack(int code, String message) {
                        Log.e(TAG, "start code:" + code);
                        Log.e(TAG, "startmessage:" + message);

                    }
                });

            

ユーザー識別の設定

ユーザーがログインまたは関連情報を提供した際に、このインターフェースを設定することをお勧めします。これにより、ユーザーに一致するEUIDを取得できます。

サポートされるバージョン

サポート開始バージョン：5.0.0

インターフェース定義

• _setUserIdentity(UserIdentity userIdentity, CallBack callBack) _
  • インターフェースの説明：
    • ユーザー識別を設定します（例：ユーザーの会員カード番号）。
  • パラメータの説明：
    • userIdentity：呼び出し識別子。
      • setUserId(String userId)：userId、一意のログインユーザー識別子をここで設定します。
      • setAnonymousId(String anonymousId)：anonymousId、ユーザーがログインしていないが他の識別可能な情報を提供している場合、匿名IDとして設定できます（例：メールアドレスや第三者が生成した識別ID）。
    • callBack：インターフェースのコールバック。
  • 戻り値の説明：
    onCallBack(int code, String message)
    • code：戻り値コード。0は成功を示し、-1は失敗を示します。具体的な理由はmessageパラメータの説明を参照してください。

呼び出し例

              
                              UserIdentity userIdentity = new UserIdentity();
                userIdentity.setUserId("Your userId");
                userIdentity.setAnonymousId("Your AnonymousId");
                MTMAApi.getInstance(this).setUserIdentity(userIdentity, new CallBack() {
                    @Override
                    public void onCallBack(int code, String message) {
                        MTCommonLog.e(TAG, "setUserIdentity code:" + code);
                        MTCommonLog.e(TAG, "setUserIdentity message:" + message);
                    }
                });

            

ユーザー連絡先情報の設定

ユーザーの連絡先情報が変更された場合、このインターフェースを使用してユーザーの「連絡先情報」を更新できます。

サポートされるバージョン

サポート開始バージョン：5.0.0

インターフェース定義

• setUserContact(JSONObject contacts, CallBack callBack)
  • インターフェースの説明：
    • ユーザーの「連絡先情報」を設定します。
  • パラメータの説明：
    • contacts：複数の連絡先情報を設定します。keyは連絡先情報の名前、valueは連絡先情報の値です。現在、4種類の連絡先情報をサポートしています：email、mobile_phone、landline_phone、whatsapp_phone。
    • callBack：インターフェースのコールバック。
  • 戻り値の説明：
    onCallBack(int code, String message)
    • code：戻り値コード。0は成功を示し、-1は失敗を示します。具体的な理由はmessageパラメータの説明を参照してください。
    • message：理由の説明。

呼び出し例

              
                              JSONObject contacts = new JSONObject();
                try {
                    contacts.put("key1", "cc");
                    contacts.put("key2", "dd");
                } catch (JSONException e) {
                    e.printStackTrace();
                }
                MTMAApi.getInstance(this).setUserContact(contacts, new CallBack() {
                    @Override
                    public void onCallBack(int code, String message) {
                        Log.e(TAG, "setUserContact code:" + code);
                        Log.e(TAG, "setUserContact message:" + message);
                    }
                });

            

EUIDの取得

サポートされるバージョン

サポート開始バージョン：5.0.0

インターフェース定義

• getEuid()
  • インターフェースの説明：
    • euidを取得します。一意のユーザーIDを表します。

呼び出し例

              
              MTMAApi.getInstance(this).getEuid();

            

データアップロードのレポート間隔の設定

setMaxEventCacheCountインターフェースと一緒に有効になります。いずれかの条件が満たされるとレポートがトリガーされます。

サポートされるバージョン

サポート開始バージョン：5.0.0

インターフェース定義

• setReportInterval(int interval)
  • インターフェースの説明：
    • データアップロードのレポート間隔を設定します。このインターフェースを呼び出さない場合、イベントデータはデフォルトで10秒ごとにレポートされます。
    • レポート間隔はメモリに保存され、アプリケーションの各ライフサイクルで呼び出す必要があります。
  • パラメータの説明
    • interval：レポート間隔（単位：秒）。

呼び出し例

              
                  MTMAApi.getInstance(this).setReportInterval(10);

            

イベントキャッシュエントリの上限設定

setReportIntervalインターフェースと一緒に有効になります。いずれかの条件が満たされるとレポートがトリガーされます。

サポートされるバージョン

サポート開始バージョン：5.0.0

インターフェース定義

• setMaxEventCacheCount(int count)
  • インターフェースの説明：
    • イベントキャッシュエントリの上限を設定します。デフォルトは50件で、最大500件を超えることはできません。
    • キャッシュ数が超過した場合、すべてのデータがレポートされます。
  • パラメータの説明
    • count：イベントキャッシュエントリの上限。

呼び出し例

              
                  MTMAApi.getInstance(this).setMaxEventCacheCount(50);

            

セッションタイムアウト時間の設定

サポートされるバージョン

サポート開始バージョン：5.0.0

インターフェース定義

• setNoActiveSessionEndDurationTime(int duration)
  • インターフェースの説明：
    • アプリがバックグラウンドに移行した際、セッションタイムアウト時間が計測を開始します。設定した時間（デフォルト30分）を超えると、このセッションは終了します。
  • パラメータの説明
    • duration：タイムアウト時間（単位：秒）。

呼び出し例

              
                  MTMAApi.getInstance(this).setNoActiveSessionEndDurationTime(5*60);

            

UTMプロパティの設定

サポートされるバージョン

サポート開始バージョン：5.0.0

インターフェース定義

• setUtmProperties(UtmProperties utmProperties)
  • インターフェースの説明：
    • UTMプロパティを設定します。開発者がユーザーがどの広告からアプリに遷移したかを認識できる場合、UTM情報を設定することをお勧めします。このパラメータはイベントレポート時に送信されます。
  • パラメータの説明：
    • utmProperties：UTMプロパティオブジェクト。
    • • utm_source：広告キャンペーンのソース。
    • • utm_medium：広告キャンペーンの媒体。
    • • utm_term：広告キャンペーンのキーワード。
    • • utm_content：広告キャンペーンの内容。
    • • utm_campaign：広告キャンペーンの名前。

呼び出し例

              
                              UtmProperties utmProperties = new UtmProperties();
                utmProperties.setUtmSource("Your utm_source");
                utmProperties.setUtmCampaign("Your utm_campaign");
                utmProperties.setUtmContent("Your utm_content");
                utmProperties.setUtmId("Your utm_id" );
                utmProperties.setUtmMedium("Your utm_medium");
                utmProperties.setUtmTerm("Your utm_term");
                MTMAApi.getInstance(this).setUtmProperties(utmProperties);