Android SDK API
SDK 介面說明
MTMAApi:MA 運行時介面。MTMAConfig:傳給start的初始化配置。
呼叫前說明
start只能在宿主應用主程序呼叫。- 除允許在初始化前設定的配置介面外,其他 MA 業務 API 只能在初始化成功後呼叫。
- 建議所有 MA 對外 API 均在主程序呼叫。非主進程不共享主進程的初始化狀態,呼叫不會轉送給主進程。
- 在非主程序呼叫業務 API 時,有回呼的介面會回傳
CODE_START_FAIL (-2),getEuid()和getMaRid()傳回空值,無回呼的業務介面不會執行。 configDebugMode、setCollectControl、setReportInterval、setMaxEventCacheCount和setNoActiveSessionEndDurationTime是進程內設定;在非主進程呼叫不會修改主進程 MA 的配置。
取得 SDK 版本
支援的版本
開始支援的版本:5.5.0
欄位定義
MTMAApi.SDK_VERSION_CODE:MA SDK 數位版本號。MTMAApi.SDK_VERSION_NAME:MA SDK 字串版本號。
int versionCode = MTMAApi.SDK_VERSION_CODE;
String versionName = MTMAApi.SDK_VERSION_NAME;
設定調試模式
支援的版本
開始支援的版本:5.5.0
介面定義
- configDebugMode(boolean enable)
- 開啟或關閉 MA SDK 偵錯日誌。
- 建議在調用
start之前設置,發布版本建議關閉。
MTMAApi.configDebugMode(true);
啟用MA功能
支援的版本
開始支援的版本:5.5.0
介面定義
- start(MTMAConfig config, MTMAInitResultCallback callback)
- 介面說明:使用 MA AppKey 初始化獨立版 MA SDK。
config:初始化配置,類型為MTMAConfig。MTMAConfig(String appKey):設定 MA AppKey。MTMAConfig(String appKey, UserIdentity userIdentity):設定 MA AppKey,並可同時設定使用者標識。config.dataCollectionEnabled(boolean enabled):可選,在MTMAConfig物件上呼叫,設定本次start時目前 MA AppKey 的資料採集開關,從 5.5.2 開始支援。true開啟,false關閉。呼叫後每次start都按傳入值生效並儲存在本機,請傳入使用者目前的同意結果,不要寫死固定值。- 詳見資料採集開關。
callback:初始化結果回呼。MTMAInitResult:isSuccess():初始化是否成功。getCode():結果碼,0表示成功。getMessage():結果描述。getEuid():初始化成功後取得的 EUID。getMaRid():初始化成功後取得的 MA RID。
呼叫範例
MTMAConfig config = new MTMAConfig("your MA AppKey");
// 可選(5.5.2 起支援):按使用者目前的同意結果設定資料採集開關;從未設定過則預設開啟
// config.dataCollectionEnabled(enabled);
MTMAApi.getInstance(this).start(config, new MTMAInitResultCallback() {
@Override
public void onResult(MTMAInitResult result) {
if (result.isSuccess()) {
String euid = result.getEuid();
String maRid = result.getMaRid();
} else {
int code = result.getCode();
String message = result.getMessage();
}
}
});
運行時切換 AppKey
上一次初始化回呼完成後,可使用新的 MTMAConfig 再次呼叫 start。切換期間其他 MA 業務 API 暫不可用。新 AppKey 初始化失敗時不會自動回退到舊 AppKey。
廢棄接口
從 5.5.0 開始,以下介面已廢棄:
start(CallBack callBack)start(UserIdentity userIdentity, CallBack callBack)
請改用 start(MTMAConfig config, MTMAInitResultCallback callback)。
設定使用者標識
建議在使用者登入、提供相關資訊時設定該接口,以獲得與該使用者匹配的 EUID
支援的版本
開始支援的版本: 5.0.0
介面定義
- _setUserIdentity(UserIdentity userIdentity, CallBack callBack) _
- 介面說明:
- 設定使用者標識,如:使用者會員卡號。
- 參數說明:
- userIdentity:呼叫標識
setUserId(String userId):移除首尾空格後不能為空,最長 255 個 Unicode 字元;不能為0、null、undefined、nan(忽略大小寫)setAnonymousId(String anonymousId):移除首尾空格後不能為空,最長 256 個 Unicode 字符setEmail(String email):不能為空,最長 256 個 Unicode 字元;必須包含且只能包含一個@,@前後都不能為空,且不能包含空格、換行或 Tab;5.5.0 開始支援setPhone(String phone):必須符合 E.164 格式,以+開頭,國家碼首位為 1–9,之後包含 1–14 位數;5.5.0 開始支持
- callBack:介面回調
- userIdentity:呼叫標識
- 回傳說明:
onCallBack(int code, String message)- code: 回傳碼,0 代表取得成功,-1 為失敗,詳見 message 參數描述
- 介面說明:
呼叫範例
UserIdentity userIdentity = new UserIdentity();
userIdentity.setUserId("your_user_id");
userIdentity.setAnonymousId("your_anonymous_id");
userIdentity.setEmail("user@example.com");
userIdentity.setPhone("+8613800138000");
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);
}
});
使用者標識欄位校驗失敗時不發送網路請求,並透過回呼傳回 code = -3。
設定使用者聯絡方式
當使用者的聯絡方式發生變更時,可使用本介面更新使用者的「聯絡方式」。
支援的版本
開始支援的版本: 5.0.0
介面定義
- setUserContact(JSONObject contacts, CallBack callBack)
- 介面說明:
- 設定使用者的「聯絡方式」。
- 參數說明:
- contacts:設定多個聯絡方式,Key 為聯絡人的名稱,value 為聯絡方式的值,目前支援 email、mobile_phone、landline_phone、whatsapp_phone 這 4 種聯絡方式
- 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();
取得 MA RID
支援的版本
開始支援的版本:5.5.0
介面定義
- getMaRid()
- 取得目前 MA RID。僅初始化成功時傳回目前值,其他狀態傳回空值。
String maRid = MTMAApi.getInstance(this).getMaRid();
設定通道聯繫ID
支援的版本
開始支援的版本:5.5.0
介面定義
- setChannelValue(long channelId, List
values, CallBack callBack) - 介面說明:設定通道聯繫ID。 AppPush 通道由 SDK 自動綁定,不需要呼叫該介面設定。
- 參數說明:
channelId:MA 控制台配置的第三方 Push 通道 ID,必須大於0。values:通道聯繫ID的值清單(例如 RID 或 Token),不能為空,清單元素也不能為空。callBack:結果回調,code == 0表示成功。
List<String> values = Collections.singletonList("push rid or token");
MTMAApi.getInstance(this).setChannelValue(136L, values, new CallBack() {
@Override
public void onCallBack(int code, String message) {
// code == 0 means success
}
});
設定上報資料間隔
和 setMaxEventCacheCount 介面共同生效,只需符合其中一個條件就會回報
支援的版本
開始支援的版本: 5.0.0
介面定義
- setReportInterval(int interval)
- 介面說明:
- 設定上報資料間隔,不呼叫該介面時,預設為 10s 上報一次事件數據
- 上報間隔記憶體緩存,需要在應用程式每次生命週期中呼叫才會生效
- 參數說明
- interval 上報間隔,單位 s(秒)
- 介面說明:
呼叫範例
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)
- 介面說明:
- 當 App 置於背景時,開始計算會話逾時時間,超過所設定的時間(預設 30 分鐘)後將會結束本次會話。
- 參數說明
- duration 超時時長,單位s(秒)
- 介面說明:
呼叫範例
MTMAApi.getInstance(this).setNoActiveSessionEndDurationTime(5*60);
設定 UTM 屬性
支援的版本
開始支援的版本: 5.0.0
介面定義
- setUtmProperties(UtmProperties utmProperties)
- 介面說明:
- 設定 UTM 屬性,若開發者能辨識使用者是從哪一個廣告跳轉訪問 App ,建議設定 UTM 訊息,我們將在事件回報時傳遞該參數
- 參數說明:
- utmProperties UTM屬性對象
- utm_source 廣告活動來源
- utm_medium 廣告活動媒介
- utm_term 廣告活動字詞
- utm_content 廣告活動內容
- utm_campaign 廣告活動名稱
- utm_id 廣告活動 ID
- 介面說明:
呼叫範例
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);
資料採集開關
支援的版本
開始支援的版本: 5.5.2
如應用需要根據使用者同意結果控制採集,可使用資料採集開關;不需要時無需任何改動,預設開啟,行為與升級前一致。
開關按 MA AppKey 分別儲存。在初始化時,請根據使用者的同意狀態對 dataCollectionEnabled 動態傳值,不要寫死配置,避免每次初始化都導致狀態被重設為寫死的值。運行中使用者改變選擇時,在初始化成功後呼叫 setDataCollectionEnabled 介面。均在主進程執行。
設定資料採集開關
介面定義
- setDataCollectionEnabled(boolean enabled)
- 介面說明:
- 設定目前 MA AppKey 的資料採集開關,在主進程、初始化成功後呼叫。
- 立即生效並儲存在本機,不等待網路完成。
- 設定的值與目前狀態相同時,不會重複執行關閉或恢復處理,也不影響啟動和會話統計。
- 重新開啟後 SDK 自動恢復採集,恢復完成前呼叫的事件、使用者屬性和 UTM 不會保留,有回呼的介面傳回 -2。
- 關閉後各介面的行為見關閉期間的行為。
- 參數說明:
enabled:true開啟,false關閉。
- 介面說明:
呼叫範例
// enabled 為應用根據使用者同意結果決定的開關狀態
MTMAApi.getInstance(this).setDataCollectionEnabled(enabled);
查詢資料採集開關
介面定義
- isDataCollectionEnabled()
- 介面說明:
- 查詢目前 MA AppKey 的資料採集開關;不發送網路請求,不觸發切換或恢復。
- 回傳說明:
true開啟,false關閉。start之前還沒有確定 AppKey:傳回預設值true,不代表任何 AppKey 的狀態,請在start之後查詢。- 非主進程傳回
false,只表示該進程不採集,不代表主進程的開關狀態。
- 介面說明:
呼叫範例
boolean enabled = MTMAApi.getInstance(this).isDataCollectionEnabled();
關閉期間的行為
關閉期間停止
| 介面 / 能力 | 關閉期間的行為 |
|---|---|
上報事件(onEvent) |
靜默丟棄,事件附帶的屬性一併丟棄。 |
| 預置事件:啟動、前後台切換、會話開始與結束、退出、應用更新、通知開關狀態、推播點擊等 | 不產生;會話停止計時,首次啟動、首日等標記不更新。 |
使用者屬性所有介面(property* 及 object_array 介面) |
不執行,回呼傳回 -8;初始化尚未完成時也傳回 -8。 |
設定 UTM 屬性(setUtmProperties) |
靜默丟棄;已快取的 UTM 在關閉時清除,開啟後不帶入。 |
| 裝置資訊:機型、系統版本、螢幕、網路、電信業者及廣告識別碼等 | 不讀取、不上報,包括 setCollectControl 可控的欄位。 |
關閉期間照常可用
| 介面 / 能力 | 關閉期間的行為 |
|---|---|
start、getEuid、getMaRid |
正常;初始化只攜帶身分註冊所需的欄位,不含裝置特徵。 |
setUserIdentity |
正常,回呼照常;不產生註冊類事件。 |
setUserContact |
正常,回呼照常。 |
setChannelValue、AppPush 自動綁定 |
正常,推播照常送達。 |
setDataCollectionEnabled、isDataCollectionEnabled |
正常。 |
setCollectControl、setReportInterval、setMaxEventCacheCount、setNoActiveSessionEndDurationTime、configDebugMode |
可以呼叫;關閉期間沒有可作用的採集,開啟後按設定執行。 |
關閉時
- 切換前已產生的資料會立即發送一次,失敗不重試,隨後清除本機快取。
- 已上報的資料不會被刪除。
關閉期間仍會發送的請求
- 初始化、身分註冊(不含裝置特徵)、配置拉取、推播通道綁定、開關狀態同步。
推播與訊息
- 推播照常送達,可開啟 App。
- 不產生推播點擊等 MA 事件,依賴 MA 行為事件的旅程條件不會命中。
- 點擊推播或應用內訊息不計入 MA 訊息轉化;關閉前的點擊記錄會被清除,開啟後不再歸因。
不受本開關控制
- 推播通道自身的送達、點擊回執。
- 獨立整合的 AppPush SDK 自身的上報。
- 應用後端呼叫的 MA REST 介面。
- 本開關不代替推播退訂。
控制台與分群
- 使用者詳情顯示「資料採集」狀態,即最近一次同步到服務端的值,可能有延遲;從未設定過開關的 AppKey 下顯示為空。
- 分群中可按「資料採集 = 關閉」圈選使用者:任一裝置為關閉即匹配,未上報狀態的裝置不匹配。
資料採集控制
setCollectControl 設定具體裝置欄位的採集許可;整體停止事件、使用者屬性、UTM 和裝置採集使用資料採集開關。重新開啟整體採集後,原欄位許可繼續生效。
支援的版本
開始支援的版本: 5.0.0
介面定義
- setCollectControl(MTMACollectControl control)
- 介面說明:
- 設定採集權限,如果需要開啟/關閉某些資料擷取,請呼叫本介面
- 參數說明:
control:擷取權限設定;未明確設定的屬性使用下列預設值setCarrier(boolean enable):是否擷取操作員訊息,預設為開啟setMacAddress(boolean enable):是否採集 MAC 位址,預設為關閉setGAID(boolean enable):是否採集 GAID,預設為關閉setOAID(boolean enable):是否採集 OAID,預設為關閉setAAID(boolean enable):是否採集 AAID,預設為關閉setIMEI(boolean enable):是否採集 IMEI,預設為關閉;僅 Android 9 及以下支持,宿主應用需自行聲明並取得READ_PHONE_STATE權限
- 介面說明:
呼叫範例
try {
MTMACollectControl mtmaCollectControl = new MTMACollectControl();
mtmaCollectControl.setCarrier(true);
mtmaCollectControl.setMacAddress(true);
mtmaCollectControl.setGAID(true);
mtmaCollectControl.setOAID(true);
mtmaCollectControl.setIMEI(true);
mtmaCollectControl.setAAID(true);
MTMAApi.getInstance(this).setCollectControl(mtmaCollectControl);
} catch (Throwable e) {e.printStackTrace();
}
設定使用者屬性
設定使用者屬性的值,若使用者屬性不存在,後台會自動建立。
覆寫更新使用者屬性
- propertySet(final JSONObject properties, final CallBack callBack)
- 介面說明:
- 批量覆蓋更新使用者屬性的值
- 僅儲存最新上報的數據,涵蓋歷史數據,如:用戶會員等級。
- Value 支援字串、數字、布林值、字串陣列、
JSONObject,以及元素全部為JSONObject的JSONArray。
- 參數說明:
- properties: 使用者屬性
- callBack:介面回調
- 回傳說明:
onCallBack(int code, String message)- code: 回傳碼,0 代表取得成功,-1 為失敗,詳見錯誤碼描述
- message:原因描述
- 呼叫範例:
- 介面說明:
try {JSONObject properties = new JSONObject();
properties.put("your_property_name","your_property_value");
properties.put("your_property_name 2","your_property_value 2");
properties.put("your_property_name 3","your_property_value 3");
MTMAApi.getInstance(this).propertySet(properties, new CallBack() {
@Override
public void onCallBack(int code, String message) {}});
} catch (Throwable e) {e.printStackTrace();
}
- propertySet(String property, Object value, CallBack callBack)
- 介面說明:
- 單一覆寫更新使用者屬性的值
- 僅儲存最新上報的數據,涵蓋歷史數據,如:用戶會員等級。
- Value 類型規則與批次
propertySet一致。
- 參數說明:
- property: 使用者屬性名
- 值: 使用者屬性值
- callBack:介面回調
- 回傳說明:
onCallBack(int code, String message)- code: 回傳碼,0 代表取得成功,-1 為失敗,詳見錯誤碼描述
- message:原因描述
- 呼叫範例:
- 介面說明:
MTMAApi.getInstance(this).propertySet("your_property_name","your_property_value", new CallBack() {
@Override
public void onCallBack(int code, String message) {}});
累加更新使用者屬性
- propertyIncrease(final Map<String, ? extends Number> properties, CallBack callBack)
- 介面說明:
- 對使用者屬性的值設定累加,批次請求
- 累加所有上報的數據,如累計消費金額。
- 只能對數值類型的用戶屬性調用這個接口,否則會被忽略, 如果這個用戶屬性之前不存在,則初始值當做 0 來處理。
- 參數說明:
- properties: 使用者屬性
- callBack:介面回調
- 回傳說明:
onCallBack(int code, String message)- code: 回傳碼,0 代表取得成功,-1 為失敗,詳見錯誤碼描述
- message:原因描述
- 呼叫範例:
- 介面說明:
Map<String,Number> properties = new HashMap();
properties.put("your_property_name",1);
properties.put("your_property_name 2",2);
properties.put("your_property_name 3",3);
MTMAApi.getInstance(this).propertyIncrease(properties, new CallBack() {
@Override
public void onCallBack(int code, String message) {}});
- propertyIncrease(final String property, final Number value, CallBack callBack)
- 介面說明:
- 對使用者屬性的值設定累加,單次請求
- 累加所有上報的數據,如累計消費金額。
- 只能對數值類型的用戶屬性調用這個接口,否則會被忽略, 如果這個用戶屬性之前不存在,則初始值當做 0 來處理。
- 參數說明:
- property: 使用者屬性名
- 值: 使用者屬性值
- callBack:介面回調
- 回傳說明:
onCallBack(int code, String message)- code: 回傳碼,0 代表取得成功,-1 為失敗,詳見錯誤碼描述
- message:原因描述
- 呼叫範例:
- 介面說明:
MTMAApi.getInstance(this).propertyIncrease("your_property_name",1, new CallBack() {
@Override
public void onCallBack(int code, String message) {}});
追加用戶屬性
- propertyAdd(final String property, final String value, CallBack callBack)
- 介面說明:
- 對使用者屬性的值進行追加,單次請求
- 可持續增加此集合元素,元素入庫去重處理,若已存在ABC,追加CD,最終為ABCD。
- 參數說明:
- property: 使用者屬性名
- 值: 使用者屬性值
- callBack:介面回調
- 回傳說明:
onCallBack(int code, String message)- code: 回傳碼,0 代表取得成功,-1 為失敗,詳見錯誤碼描述
- message:原因描述
- 呼叫範例:
- 介面說明:
MTMAApi.getInstance(this).propertyAdd("your_property_name","your_property_value", new CallBack() {
@Override
public void onCallBack(int code, String message) {}});
- propertyAdd(final String property, final Set values, CallBack callBack)
- 介面說明:
- 對使用者屬性的值進行追加,一次加入多個值
- 可持續增加此集合元素,元素入庫去重處理,若已存在ABC,追加CD,最終為ABCD。
- 參數說明:
- property: 使用者屬性名
- 值: 使用者屬性值
- callBack:介面回調
- 回傳說明:
onCallBack(int code, String message)- code: 回傳碼,0 代表取得成功,-1 為失敗,詳見錯誤碼描述
- message:原因描述
- 呼叫範例:
- 介面說明:
Set<String> properties = new HashSet<>();
properties.add("your_property_value");
properties.add("your_property_value 2");
properties.add("your_property_value 3");
MTMAApi.getInstance(this).propertyAdd("your_property_name",properties, new CallBack() {
@Override
public void onCallBack(int code, String message) {}});
操作 object_array 元素
以下介面從 5.5.0 開始支持,僅用於 object_array 使用者屬性。原有 propertyAdd、propertyRemove 仍用於字串數組,行為不變。
- updateObjectArrayProperty(String property, String identifierKey, Object identifierValue, JSONObject values, CallBack callBack)
- 根據唯一識別更新一個物件元素的子欄位。
identifierValue支援字串或有限數字;values不能修改識別欄位。values中使用JSONObject.NULL可刪除對應子欄位。
JSONObject values = new JSONObject().put("enabled", false);
MTMAApi.getInstance(this).updateObjectArrayProperty(
"devices", "device_id", "device_1", values, callBack);
- addObjectArrayProperty(String property, JSONObject object, CallBack callBack)
- 向
object_array追加一個非空物件元素。
- 向
JSONObject device = new JSONObject()
.put("device_id", "device_2")
.put("year", 2026);
MTMAApi.getInstance(this).addObjectArrayProperty("devices", device, callBack);
- removeObjectArrayProperty(String property, String identifierKey, Object identifierValue, CallBack callBack)
- 根據唯一識別刪除整個物件元素。
MTMAApi.getInstance(this).removeObjectArrayProperty(
"devices", "device_id", "device_2", callBack);
移除使用者屬性
- propertyRemove(final String property, String values, final CallBack callBack)
- 介面說明:
- 移除使用者屬性的值操作。
- 值為集合元素,元素入庫重處理,若已存在 ABCD,刪除 D,最終為 ABC。
- 參數說明:
- property: 使用者屬性名
- 值: 使用者屬性值
- callBack:介面回調
- 回傳說明:
onCallBack(int code, String message)- code: 回傳碼,0 代表取得成功,-1 為失敗,詳見錯誤碼描述
- message:原因描述
- 呼叫範例:
- 介面說明:
MTMAApi.getInstance(this).propertyRemove("your_property_name","your_property_value", new CallBack() {
@Override
public void onCallBack(int code, String message) {}});
- propertyRemove(final String property, Set
values, final CallBack callBack) - 介面說明:
- 使用者屬性的值操作移除,一次移除多個值。
- 值為集合元素,元素入庫重處理,若已存在 ABCD,刪除 CD,最終為 AB。
- 參數說明:
- property: 使用者屬性名
- 值: 使用者屬性值
- callBack:介面回調
- 回傳說明:
onCallBack(int code, String message)- code: 回傳碼,0 代表取得成功,-1 為失敗,詳見錯誤碼描述
- message:原因描述
- 呼叫範例:
- 介面說明:
Set<String> properties = new HashSet<>();
properties.add("your_property_value");
properties.add("your_property_value 2");
properties.add("your_property_value 3");
MTMAApi.getInstance(this).propertyRemove("your_property_name",properties, new CallBack() {
@Override
public void onCallBack(int code, String message) {}});
刪除使用者屬性
支援的版本
開始支援的版本: 5.0.0
介面定義
- propertyDelete(final String property, final CallBack callBack)
- 介面說明:
- 刪除某個使用者屬性的所有 value 值
- 參數說明:
- property: 使用者屬性名
- callBack:介面回調
- 回傳說明:
onCallBack(int code, String message)- code: 回傳碼,0 代表取得成功,-1 為失敗,詳見錯誤碼描述
- message:原因描述
- 介面說明:
呼叫範例
MTMAApi.getInstance(this).propertyDelete("your_property_name", new CallBack() {
@Override
public void onCallBack(int code, String message) {}});
事件上報
支援的版本
開始支援的版本: 5.0.0
介面定義
- onEvent(String eventKey, JSONObject properties)
- 介面說明:
- 事件上報
- 參數說明:
- eventKey: 事件名稱
- properties:事件屬性,Key為屬性名稱,value為屬性值
- 介面說明:
呼叫範例
JSONObject properties = new JSONObject();
properties.put("key1","v1");
properties.put("key2","v2");
MTMAApi.getInstance(this).onEvent("your_event_name",properties );
錯誤碼
| code | 值 | 說明 |
|---|---|---|
| CODE_SUCCEED | 0 | 成功 |
| CODE_UNKNOWN | -1 | 未知錯誤 |
| CODE_START_FAIL | -2 | 初始化未完成、初始化失敗、在非主程序初始化,或當前操作依賴的 MA 配置未就緒 |
| CODE_VALID | -3 | 參數校驗失敗 |
| CODE_ENABLE | -4 | MA 項目已關閉 |
| CODE_REGISTRATIONID | -5 | MA RID 缺失或不合法 |
| CODE_SWITCH | -6 | MA 專案配置已切換,需要再次呼叫 start |
| CODE_COLLECTION_DISABLED | -8 | 資料採集已關閉,本次普通採集操作未執行;5.5.2 開始提供 |










