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: ช่วงเวลาการรายงาน หน่วยเป็นวินาที (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)
  • คำอธิบายอินเทอร์เฟซ:
    • เมื่อแอปพลิเคชันอยู่ในพื้นหลัง ระยะเวลาหมดเวลาของเซสชันจะเริ่มนับ เมื่อเกินระยะเวลาที่ตั้งค่าไว้ (ค่าเริ่มต้น 30 นาที) เซสชันนี้จะสิ้นสุด
  • คำอธิบายพารามิเตอร์
    • duration: ระยะเวลาหมดเวลา หน่วยเป็นวินาที (s)

ตัวอย่างการเรียกใช้

              
                  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);