Menyiapkan notifikasi batas

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

Pengantar

Anda dapat menetapkan batas terkait monetisasi, seperti yang dijelaskan dalam Menegakkan 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 khusus serta batas implisit. Misalnya, sistem menetapkan batas implisit untuk developer prabayar Anda, yaitu saldo prabayar mereka. Anda dapat menyiapkan notifikasi otomatis agar developer diberi tahu jika mereka mendekati atau telah mencapai saldo prabayar.

Toolbox

Anda dapat menyiapkan notifikasi otomatis untuk batasan menggunakan UI pengelolaan atau Monetization API. Jika Anda menggunakan UI, Anda menyiapkan notifikasi otomatis pada halaman Notifications.

Jika menggunakan API, Anda menyiapkan notifikasi otomatis untuk batasan dengan mengedit template notifikasi yang disediakan oleh monetisasi. Kemudian, tentukan kondisi yang menyebabkan pengiriman notifikasi yang disediakan oleh template yang diedit.

Menyiapkan notifikasi batas menggunakan UI

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

  2. Pilih level untuk notifikasi. Nilai minimum ini didasarkan pada angka absolut atau persentase basis batas. Pilih:
    • Tanda lebih besar dari atau sama dengan (?) atau kurang dari atau sama dengan tanda (?) dari menu drop-down.
    • Bilangan bulat (yaitu, bukan tempat desimal). Absolut (untuk mengindikasikan nilai angka) atau Persentase untuk menunjukkan nilai persentase. Untuk batas persentase, selalu pastikan Anda menetapkan batas sebagai >, yang berarti notifikasi akan dikirim saat developer mencapai atau melampaui tingkat persentase tersebut.

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

  3. Pada kolom Send 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 ke "Apa saja" atau menetapkan kondisi Batas developer dengan developer tertentu. Jika memilih "Apa saja", Anda akan melihat "Developer yang dipilih (Apa pun)" dalam daftar alamat email. Artinya, monetisasi akan mengirimkan notifikasi kepada semua developer yang terpengaruh. Jika memilih developer tertentu, Anda akan melihat "Developer yang dipilih ({developer_id})" dalam daftar alamat email (dengan {developer_id} sebagai identifikasi developer yang dipilih). Monetisasi hanya akan mengirimkan notifikasi kepada developer tersebut.

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

    Anda dapat menambahkan alamat email untuk pengguna organisasi dengan memilih Pengguna Organisasi 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).Yang muncul di template bergantung pada hal berikut:

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

    Misalnya, jika semua hal berikut terpenuhi:

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

    Templatenya akan terlihat seperti ini:

    Asumsikan bahwa nama perusahaan developer adalah "perusahaan XYZ", batas volume transaksi ditetapkan sebesar 50 untuk paket API bernama "Paket X" dan Produk API bernama "Produk Y", dan tanggal habis masa berlakunya 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 me-resolve variabel yang relevan seperti nama developer (jika ada), nama paket (jika ada), dan nama produk (jika ada). Anda dapat mengedit pesan untuk memenuhi persyaratan Anda dengan mengklik Edit di sebelah kiri template.

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

    • 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 "Apa pun" atau aplikasi tertentu ditampilkan di bawah ini.

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

    Sekali lagi, jika batasnya adalah untuk aplikasi "Apa pun" (atau tertentu), atau pengguna "Semua" (atau pengguna tertentu), Anda perlu mengedit template lalu menambahkan aplikasi ${application.name} dan/atau pengguna ${user.name}, bergantung pada apakah batas tersebut berlaku 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 tagihan, atau volume).
    ${PERCENT}

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

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

    Unit dasar untuk batas: mata uang (untuk batas pembelanjaan), atau panggilan (untuk 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 telah mencapai persentase tertentu dari volume transaksi untuk paket apa pun di aplikasi apa 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 level tambahan. Untuk setiap tingkat tambahan, klik Tambahkan. Tindakan ini akan menambahkan area template Level, Kirim email, dan 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 level ini tercapai.
  5. Setelah menambahkan semua notifikasi, klik Simpan (untuk menyimpan dan memublikasikan notifikasi di lain waktu), Simpan dan Publikasikan (untuk memublikasikan sekarang), atau Batal (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 menyebabkan pengiriman notifikasi yang disediakan oleh template yang diedit. Untuk detail selengkapnya, lihat Menyiapkan notifikasi menggunakan template notifikasi.

Langkah berikutnya

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