OneLink API

Premium
Direkomendasikan untuk
Pemasar Pengembang
Tanggal terakhir diupdate:

Sekilas: OneLink API membantu Anda melibatkan pengguna akhir dan memanfaatkan media yang dimiliki dengan menghasilkan tautan yang dipersonalisasi dalam kampanye skala besar, melalui SMS, dan masih banyak lagi. Mengharuskan pengiklan dan pengembang untuk menerapkan.

OneLink API

OneLink API digunakan untuk:

  • Buat, dapatkan, perbarui, dan  hapus URL singkat OneLink dengan parameter yang disesuaikan secara otomatis.
    Parameter dapat berupa:
    • Parameter terkait atribusi, digunakan untuk mengukur dan memantau upaya pemasaran, seperti sumber media, kampanye, dan adset. Perhatikan: Parameter sumber media (pid) itu wajib. 
    • Parameter personalisasi, yang memungkinkan Anda mengonfigurasi pengalaman pengguna yang disesuaikan saat membuka aplikasi dari tautan yang relevan. Parameter ini memungkinkan Anda mengarahkan pengguna ke konten dalam aplikasi yang disesuaikan, misalnya, laman produk tertentu, kode kupon, atau promosi.
  • Izinkan berbagi konten situs web dan aplikasi langsung ke pengguna seluler (sehingga meningkatkan interaksi dan penginstalan seluler).
  • Hasilkan banyak tautan atribusi khusus OneLink secara instan.
    Catatan : Untuk tautan rujukan, lihat artikel atribusi undangan pengguna .

 Contoh

Feed Me, layanan pengiriman bahan makanan, ingin mengirim tautan yang dipersonalisasi melalui SMS ke pelanggan yang sudah ada untuk mendorong mereka mengunduh aplikasi Feed Me dan membeli pisang. Berdasarkan negara pelanggan, Feed Me menggunakan OneLink REST API untuk membuat URL OneLink kustom yang berisi detail spesifik untuk negara, identitas pengguna, dan penawaran istimewa untuk pisang yang sedang dijual.

Jumlah kueri API OneLink yang dapat Anda buat terbatas tergantung pada jenis akun Anda.Anda dapat melihat berapa banyak kueri yang Anda buat dan berapa banyak yang tersisa, di dashboard OneLink API. 

Anda dapat menghubungi CSM Anda untuk meningkatkan batas kueri API.  

Pengaturan

Untuk menyiapkan OneLink API:

  1. Buat templat OneLink.
  2. Catat ID OneLink. 

  3. Catat kunci OneLink API. Pengguna admin perlu mengambil kunci API; pengguna akun tidak memiliki akses. 
    • Di dashboard AppsFlyer, buka Pengalaman & Deep Linking > OneLink API > Lihat kunci OneLink API
    • Jika kunci API OneLink tidak ada untuk pengguna admin, itu berarti Anda tidak memiliki paket yang diperlukan, dan Anda perlu menghubungi CSM Anda.
  4. Berikan OneLink ID dan kode OneLink API kepada pengembang.
  5. Beri tahu pengembang untuk mengikuti petunjuk di pusat pengembang.

Dashboard

Dashboard OneLink API menampilkan:

  • Penggunaan API harian, bulanan, dan tiga bulan Anda. 
  • Kunci OneLink API.

Untuk melihat dashboard OneLink API: 

Di AppsFlyer, buka Pengalaman & Deep Linking > OneLink API.

Karakteristik dan batasan

Sifat

Catatan

Batas kuota API
  • Batas penggunaan OneLink API untuk membuat, mengedit, atau menghapus tautan OneLink adalah 7,5 juta per bulan (zona waktu UTC), per akun.
  • Semua permintaan yang dibuat setelah melebihi kuota ini tidak dilayani, dan tautan tidak dibuat; panggilan API menerima kode status kesalahan 429 dengan pesan tersebut "Kuota bulanan terlampaui".
  • Informasi mengenai berapa kuota tarif yang terpakai/tetap ditampilkan di dashboard OneLink API. 

Batas angka
  • Batas angka per akun adalah 500 permintaan per detik (30000 per menit).
  • Semua permintaan yang dibuat melebihi 500 permintaan per detik(30000 per menit) tidak dilayani, dan tautan tidak dibuat; panggilan API menerima kode status kesalahan 429 dengan pesan "Batas tarif terlampaui".

Visibilitas tautan
  • Tautan yang dibuat melalui API tidak muncul di daftar tautan khusus OneLink di dashboard AppsFlyer.
  • Praktik terbaik: Simpan tautan yang dibuat API ke tabel lokal, sehingga Anda dapat mengakses tautan untuk tujuan apa pun di masa mendatang. 

TTL 
  • Waktu hidup default (TTL) untuk URL singkat OneLink yang dibuat melalui OneLink API adalah 31 hari. Ini diperpanjang 31 hari setiap kali tautan diklik. Mengeklik tautan setelah TTL kedaluwarsa masih merupakan perilaku default yang ditentukan dalam konfigurasi dasar OneLink, tetapi atribusi tidak akan berfungsi.
    • Diperlukan waktu hingga 48 jam untuk menghapus URL pendek OneLink setelah TTL kedaluwarsa.
  • TTL maksimum adalah 31 hari. Nilai TTL apa pun yang lebih besar dari 31 diganti dengan TTL default 31.
  • Anda dapat mengubah TTL default dengan menambahkan parameter ttl={value} dan menentukan berapa hari, jam, atau menit. Misalnya ttl=7d, ttl=12h, atau ttl=10m.
  • Anda dapat mengirimpermintaan pembaruanuntuk menentukan TTL. Setiap permintaan pembaruan mengatur ulang TTL (untuk tautan yang ada) ke yang ditentukan dalam konten permintaan.
    • Ini berarti TTL diganti. Misalnya, jika Anda melakukan panggilan pembaruan dengan TTL 2d untuk tautan yang saat ini memiliki TTL 29d, itu akan berubah menjadi TTL=2d (bukan 31d).
    • Panggilan pembaruan berpotensi memperpanjang masa pakai tautan atribusi. Misalnya, jika Anda melakukan panggilan pembaruan dengan TTL 31d untuk tautan yang saat ini memiliki TTL 20d tetapi 5 hari telah berlalu, TTL akan menjadi 31d sejak waktu pembaruan.
  • Jika Anda tidak ingin tautan TTL diperpanjang secara otomatis, tambahkan parameter renew_ttl=false ke tautan Anda. Nilai untuk parameter ini adalah boolean, baik true (default) atau false.
  • Parameter renew_ttl tidak tampil pada URL aktual.

Karakter khusus

 Karakter berikut harus dikodekan jika digunakan untuk tautan yang dibuat API: ;, *, !, @, #, ?, $, ^, :, &, ~, `, =, +, ', >, <, /
Jika Anda tidak menyandikan karakter ini, mereka diganti dengan ruang kosong, dan tautan serta fungsinya berpotensi rusak

Payload

String kueri dari payload tidak boleh melebihi 2.048 karakter.

ID URL

ID URL (atau ID tautan pendek) dapat diedit untuk menyoroti penawaran kampanye Anda. Contohnya: https://myapp.onelink.me/abc123/apples. ID URL tidak boleh melebihi 50 karakter dan dapat berupa kombinasi huruf dan angka. Secara default, ini adalah 8 karakter.

Catatan:

  • Anda hanya dapat mengedit ID URL jika ID saat ini belum digunakan.
  • Jika ID URL sudah digunakan, pembuatan tautan gagal dan mengembalikan respons kesalahan (400). Anda dan pengembang Anda perlu memutuskan dan mengonfigurasi apa yang terjadi dalam event semacam itu.
  • Panggilan yang gagal tetap diperhitungkan dalam kuota API bulanan Anda.