Menyiapkan notifikasi batas

Anda melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Pengantar

Anda dapat menetapkan batas terkait monetisasi, seperti yang dijelaskan dalam Menerapkan batas monetisasi menggunakan kebijakan Pemeriksaan Batas Monetisasi. Anda juga dapat menyiapkan notifikasi otomatis yang memberi tahu developer, dan/atau pengguna di organisasi Anda, saat batas mendekati atau tercapai.

Anda dapat menyiapkan notifikasi otomatis untuk batas kustom serta batas implisit. Misalnya, sistem menetapkan batas implisit untuk developer prabayar Anda, yaitu saldo prabayar mereka. Anda dapat menyiapkan notifikasi otomatis sehingga developer Anda akan diberi tahu jika mereka mendekati atau telah mencapai saldo prabayar mereka.

Kotak Alat

Anda dapat menyiapkan notifikasi otomatis untuk batas menggunakan UI pengelolaan atau API monetisasi. Jika menggunakan UI, Anda menyiapkan notifikasi otomatis di halaman Notifikasi.

Jika menggunakan API, Anda menyiapkan notifikasi otomatis untuk batas dengan mengedit template notifikasi yang disediakan oleh monetisasi. Kemudian, Anda menentukan kondisi yang menghasilkan pengiriman notifikasi yang disediakan oleh template yang diedit.

Menyiapkan notifikasi batas menggunakan UI

  1. Klik Tambahkan di bagian Notifikasi pada halaman Tambahkan Batas. Tindakan ini akan membuka bagian Notifikasi.

  2. Pilih tingkat untuk notifikasi. Ini adalah nilai minimum berdasarkan angka absolut atau a persentase basis batas. Pilih:
    • Tanda lebih besar dari atau sama dengan (?) atau tanda kurang dari atau sama dengan (?) dari the menu drop-down.
    • Bilangan bulat (yaitu, tanpa tempat desimal). Absolut (untuk menunjukkan nilai angka) atau Persentase untuk menunjukkan nilai persentase. Untuk batas persentase, pastikan Anda selalu menetapkan batas ke sebagai >, yang berarti notifikasi dikirim saat developer mencapai atau melampaui tingkat persentase tersebut.

    Misalnya, jika Anda menetapkan batas pengeluaran sebesar $100 dan menetapkan notifikasi pada lebih besar dari atau sama dengan 90%, notifikasi akan dikirim saat 90% batas ($90) tercapai atau terlampaui.

  3. Di kolom Kirim Email, pilih satu atau beberapa developer, atau pilih satu atau beberapa pengguna di organisasi Anda. Notifikasi akan dikirim ke developer atau pengguna yang terpengaruh.

    Penerima email: Anda hanya dapat mengirim notifikasi kepada developer jika menetapkan kondisi batas Developer sebagai "Semua" atau menetapkan kondisi batas Developer dengan developer tertentu. Jika memilih "Semua", Anda akan melihat "Developer yang dipilih (Semua)" dalam daftar alamat email. Artinya, monetisasi akan mengirim notifikasi ke semua developer yang terpengaruh. Jika memilih developer tertentu, Anda akan melihat "Developer yang dipilih ({developer_id})" dalam daftar alamat email (dengan {developer_id} adalah identifikasi developer yang dipilih). Monetisasi hanya akan mengirim notifikasi kepada developer tertentu tersebut.

    Jika tidak memilih kondisi batas Developer "Semua" atau developer tertentu, Anda tidak akan melihat "Developer yang dipilih (Semua)" di kolom Kirim Email. Namun, Anda dapat memilih pengguna organisasi yang ingin diberi tahu.

    Anda dapat menambahkan alamat email untuk pengguna organisasi dengan memilih Organisasi Pengguna di tab Admin.

    Template email: Anda akan melihat template email setelah memilih di kolom Kirim Email "Developer yang dipilih (Semua)" atau alamat email pengguna di organisasi Anda (atau keduanya).Apa yang muncul dalam template bergantung pada hal berikut:

    • Tingkat notifikasi.
    • Apakah batas tersebut merupakan batas penghentian eksekusi atau tidak.
    • Apakah email tersebut ditujukan untuk pengguna organisasi, developer, atau keduanya.

    Misalnya, jika semua hal berikut benar:

    • Kotak centang Hentikan eksekusi dicentang.
    • Tingkat notifikasi adalah 100% atau jumlah yang sama dengan batas.
    • Email hanya ditujukan untuk pengguna organisasi.

    Template akan terlihat seperti ini:

    Asumsikan bahwa nama perusahaan developer adalah "XYZ company", batas volume transaksi ditetapkan sebesar 50 untuk paket API bernama "X Package" dan Produk API bernama "Y Product", dan tanggal habis masa berlaku ditetapkan pada 30 September 2013. Pesan email yang dikirim akan terlihat seperti ini:

    Developer XYZ company has exceeded their transaction volume limit of 50 transactions for X package, Y product. Their API calls will be blocked till 2013-09-30

    Jika email ditujukan ke "Developer yang dipilih (Semua)", template akan muncul sebagai berikut:

    Kedua template akan menyelesaikan variabel yang relevan seperti nama developer (jika ada), nama paket (jika ada), dan nama produk (jika ada). Anda dapat mengedit pesan untuk memenuhi persyaratan dengan mengklik Edit di sebelah kiri template.

    Jika batasnya adalah untuk "Semua" atau aplikasi tertentu dan "Semua" atau pengguna tertentu, Anda juga perlu menambahkan variabel untuk aplikasi dan pengguna ke template. Anda dapat melakukannya sebagai mengikuti:

    • Klik Edit di sebelah kiri template.
    • Tambahkan ${user.name} user, depending on whether the limit is for application and/or user.

    Template yang diedit untuk "Semua" atau aplikasi tertentu ditampilkan di bawah.

    Jika Hentikan eksekusi tidak dicentang, atau tingkat notifikasi lebih besar dari atau sama dengan 100%, template untuk developer yang dipilih akan terlihat seperti ini:

    Sekali lagi, jika batasnya adalah untuk aplikasi "Semua" (atau tertentu), atau pengguna "Semua" (atau tertentu) , Anda perlu mengedit template, lalu menambahkan ${application.name} aplikasi dan/atau ${user.name} pengguna, bergantung pada apakah batasnya untuk aplikasi, pengguna, atau keduanya.

    Variabel template: Saat mengedit pesan dalam template email, Anda dapat menyertakan salah satu variabel berikut.

    Variabel Deskripsi
    ${developer.name}

    Nama developer.
    ${developer.legalName}

    Nama perusahaan developer.
    ${ratePlan.monetizationPackage.displayName}

    Nama paket API.
    ${application.name}

    Nama aplikasi.
    ${USER}

    Nama pengguna.
    ${USAGE}

    Penggunaan saat ini (total pendapatan atau biaya, atau volume).
    ${PERCENT}

    Persentase batas yang dicapai oleh penggunaan saat ini.
    ${QUOTA_TYPE}

    Jenis batas (volume transaksi, batas pengeluaran, atau eksposur biaya).
    ${QUOTA_UNIT}

    Unit dasar untuk batas: mata uang (untuk batas pengeluaran), atau panggilan (untuk a batas transaksi).
    ${QUOTA_LIMIT}

    Jumlah batas.
    ${EXPIRY_DATE}

    Tanggal atau waktu batas berakhir atau saat batas direset.

    Misalnya, jika Anda ingin diberi tahu saat developer mencapai persentase volume transaksi tertentu untuk paket apa pun di aplikasi mana pun, Anda dapat mengedit template agar terlihat seperti ini:

    ${developer.legalName} has reached a total volume of ${USAGE} on ${ratePlan.monetizationPackage.displayName}. This is ${PERCENT} of the daily/weekly/monthly (state period of limit as appropriate) transaction volume limit of ${QUOTA_LIMIT}.
  4. Tambahkan notifikasi sesuai kebutuhan untuk tingkat tambahan. Untuk setiap tingkat tambahan, klik Tambahkan. Tindakan ini akan menambahkan area Tingkat, Kirim email, dan Template email ke bagian Notifikasi pada halaman. Anda dapat menambahkan hingga 6 tingkat untuk notifikasi. Misalnya, jika Anda menetapkan notifikasi sebagai > 70%, 80%, 90%, 100%, notifikasi akan dikirim saat setiap tingkat ini tercapai.
  5. Setelah menambahkan semua notifikasi, klik Simpan (untuk menyimpan dan memublikasikan notifikasi di lain waktu), Simpan dan Publikasikan (untuk memublikasikan sekarang), atau Batalkan (untuk membatalkan).

Menyiapkan notifikasi batas menggunakan API

Monetisasi menyediakan serangkaian template yang menyediakan teks untuk berbagai jenis notifikasi, termasuk notifikasi batas serta notifikasi ad-hoc seperti memberi tahu developer tentang ketersediaan produk baru. Anda dapat menyesuaikan salah satu template ini untuk memenuhi kebutuhan Anda. Untuk menyiapkan notifikasi batas otomatis, edit template yang sesuai terlebih dahulu. Kemudian, tentukan kondisi yang menghasilkan pengiriman notifikasi yang disediakan oleh template yang diedit. Untuk mengetahui detail selengkapnya, lihat Menyiapkan notifikasi menggunakan template notifikasi.

Langkah berikutnya

Pelajari cara menyiapkan notifikasi otomatis sehingga Anda dapat memberi tahu developer tentang peristiwa seperti produk baru, versi baru Persyaratan Layanan, atau paket tarif baru. Lihat Menyiapkan notifikasi menggunakan template notifikasi.