Panduan API SDK

Atur Identifikasi Pengguna

Definisi Antarmuka

• identifyAccount(user);
  • Deskripsi Antarmuka:
    • Mengatur identifikasi pengguna, misal nomor kartu anggota.
  • Deskripsi Parameter
    • identity: ID identifikasi pengguna.
    • completion: Callback.

Contoh Pemanggilan

              
              let user = {completion: (code, message) => {}, identity: {"id": "value"}}
window.MAInterface.identifyAccount(user)

            

Dapatkan EUID

Definisi Antarmuka

• EUID()
  • Deskripsi Antarmuka:
    • Mendapatkan EUID dari EngageLab MA.

Contoh Pemanggilan

              
              window.MAInterface.EUID((code, euid) => {
    console.log(code, euid)
})

            

Atur Informasi Kontak Pengguna

Definisi Antarmuka

• setUserContact(user)
  • Deskripsi Antarmuka:
    • Mendukung pengaturan beberapa metode kontak sekaligus. Key adalah nama metode kontak, value adalah nilainya. Saat ini mendukung 4 jenis: email, mobile_phone, landline_phone, dan whatsapp_phone.
  • Deskripsi Parameter
    • contacts: Informasi kontak pengguna.
    • completion: Callback.

Contoh Pemanggilan

              
              let user = {
    completion: (code, message) => { },
    contacts: {}
}
user.contacts["Nama Metode Kontak"] = "Nilai Metode Kontak"   // Contoh: mobile_phone = 18800000000
window.MAInterface.setUserContact(user)

            

Atur Properti UTM

Definisi Antarmuka

• setUtmProperties(attrs:any)
  • Deskripsi Antarmuka:
    • Properti UTM adalah properti standar pada event. Jika pengembang dapat mengidentifikasi dari iklan mana pengguna diarahkan ke aplikasi, disarankan untuk mengatur informasi UTM. Parameter ini akan disertakan saat pelaporan event. Saat ini, properti UTM yang dapat diatur meliputi:
      • utm_source: Sumber kampanye iklan.
      • utm_medium: Media kampanye iklan.
      • utm_term: Kata kunci kampanye iklan.
      • utm_content: Konten kampanye iklan.
      • utm_campaign: Nama kampanye iklan.
      • utm_id: ID kampanye iklan.

Contoh Pemanggilan

              
              window.MAInterface.setUtmProperties({"utm_source": "value1"})

            

Atur Properti Pengguna

Atur nilai properti pengguna. Jika properti pengguna belum ada, maka akan otomatis dibuat di sistem.

Timpa dan Perbarui Properti Pengguna

• setProperty(user, completion)
  • Deskripsi Antarmuka:
    • Menimpa dan memperbarui nilai properti pengguna.
    • Hanya data terakhir yang disimpan, menggantikan data sebelumnya, misal level keanggotaan pengguna.
    • Konten properti pengguna disimpan dalam objek. Key adalah nama properti (string), value adalah isi properti (string, number, atau Array).
    • Untuk value Array, hanya mendukung tipe string.
    • Jika properti sudah ada, akan ditimpa; jika belum, akan dibuat.
  • Contoh Pemanggilan:

              
              window.MAInterface.setProperty({key: "value"}, (code, message) => {})

            

Tambah Nilai Properti Pengguna

• increaseProperty(user, completion)
  • Deskripsi Antarmuka:
    • Menambah nilai pada properti pengguna bertipe number. Semua data yang dilaporkan akan diakumulasikan, misal jumlah konsumsi kumulatif.
    • Hanya berlaku untuk properti bertipe number. Jika belum ada, nilai awal dianggap 0.
  • Contoh Pemanggilan:

              
              window.MAInterface.increaseProperty({key: 1}, (code, message) => {})

            

Tambah Elemen Properti Pengguna

• addProperty(key, content, completion)
  • Deskripsi Antarmuka:
    • Menambahkan nilai pada properti pengguna bertipe Array.
    • Elemen duplikat akan dihapus. Jika belum ada, akan diinisialisasi dengan Array kosong.
    • Elemen Array harus berupa string.
  • Contoh Pemanggilan:

              
              window.MAInterface.addProperty("key", ["value1", "value2"], (code, message) => {})

            

Hapus Elemen Properti Pengguna

• removeProperty(key, content, completion)
  • Deskripsi Antarmuka:
    • Menghapus satu atau beberapa nilai dari properti bertipe Array.
    • Elemen Array harus berupa string. Jika belum ada, tidak berpengaruh.
  • Contoh Pemanggilan:

              
              window.MAInterface.removeProperty("key", ["value1", "value2"], (code, message) => {})

            

Hapus Properti Pengguna

Definisi Antarmuka

• deleteProperty(key, completion)
  • Deskripsi Antarmuka:
    • Menghapus seluruh isi nilai dari suatu properti pengguna.
    • Jika belum ada, akan diabaikan.

Contoh Pemanggilan

              
              window.MAInterface.deleteProperty("key", (code, message) => {})

            

Atur Waktu Kedaluwarsa Sesi

Definisi Antarmuka

• setSessionTimeout(time)
  • Deskripsi Antarmuka:
    • Mengatur waktu kedaluwarsa sesi. Saat halaman dipindahkan ke latar belakang, waktu kedaluwarsa sesi akan berjalan. Jika waktu yang ditetapkan (default: 30 menit) terlampaui, sesi akan berakhir.

Contoh Pemanggilan

              
              window.MAInterface.setSessionTimeout(60)

            

Atur Durasi Tinggal di Halaman

Definisi Antarmuka

• setPageStayTime(time)
  • Deskripsi Antarmuka:
    • Mengatur durasi waktu tinggal di halaman.
    • Penghitungan waktu dimulai setelah mengakses halaman. Jika pengguna tetap di halaman selama time detik tanpa meninggalkan, event ini akan dilaporkan.
    • Default pelaporan pada 6 titik waktu: 5 detik, 30 detik, 60 detik, 2 menit, 5 menit, dan 10 menit. Anda bisa menambah titik waktu lain sesuai kebutuhan.

Contoh Pemanggilan

              
              window.MAInterface.setPageStayTime(60)

            

Laporkan Event

Jika event belum ada, akan otomatis dibuat saat pelaporan.

Definisi Antarmuka

• onEvent(event)
  • Deskripsi Antarmuka:
    • Melaporkan sebuah event.
  • Deskripsi Parameter
    • event: Event yang akan dilaporkan. name adalah nama event, properties adalah informasi properti event (key: nama properti, value: nilainya).

Contoh Pemanggilan

              
              let event = {name: "name", properties: {key: "value"}}
window.MAInterface.onEvent(event)