Mengelola laporan

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

Pengantar

Laporan monetisasi memungkinkan Anda mengakses informasi penggunaan dan aktivitas transaksi yang terfokus. Misalnya, Anda dapat menentukan aplikasi, developer, paket produk API, atau produk API mana yang memiliki aktivitas transaksi untuk rentang tanggal tertentu. Dengan monetisasi, Anda dapat membuat laporan ringkasan atau detail yang melacak penggunaan API.

Jenis laporan monetisasi

Anda dapat membuat jenis laporan monetisasi berikut.

Laporkan Deskripsi
Penagihan Lihat aktivitas developer untuk satu bulan penagihan dan verifikasi bahwa paket tarif telah diterapkan dengan benar.
Saldo Prabayar Melihat pengisian ulang saldo yang dilakukan developer prabayar dalam bulan penagihan atau dalam bulan yang sedang berjalan, sehingga Anda dapat mencocokkan dengan pembayaran yang diterima dari pemroses pembayaran Anda.
Pendapatan Lihat aktivitas dan pendapatan yang dihasilkan oleh developer dalam rentang tanggal, sehingga Anda dapat menganalisis performa paket dan produk API di seluruh developer (dan aplikasi mereka).
Variansi

Bandingkan aktivitas dan pendapatan yang dihasilkan oleh developer dalam dua rentang tanggal, sehingga Anda dapat menganalisis tren naik atau turun dalam performa paket dan produk API di seluruh developer (dan aplikasi mereka).

Tentang retensi data

Di cloud publik Apigee Edge, retensi data monetisasi adalah hak paket. Lihat hak monetisasi di https://cloud.google.com/apigee/specsheets. Hubungi Tim Penjualan Apigee jika Anda ingin data monetisasi dipertahankan di luar periode hak. Perpanjangan retensi data diaktifkan pada saat permintaan dan tidak dapat diaktifkan secara retroaktif untuk menyertakan data yang lebih awal dari periode retensi data asli.

Tentang transaksi duplikat

Jika Anda membandingkan laporan transaksi monetisasi dengan data Analytics, Anda mungkin melihat sejumlah kecil transaksi duplikat. Hal ini merupakan perilaku yang diharapkan karena sistem monetisasi dapat memproses beberapa juta transaksi setiap hari dengan banyak transaksi yang diproses secara paralel pada waktu tertentu. Rata-rata, ~0,1% transaksi mungkin berupa duplikat.

Menjelajahi halaman Laporan Monetisasi

Akses halaman Laporan Monetisasi, seperti yang dijelaskan di bawah.

Edge

Untuk mengakses halaman Reports menggunakan Edge UI:

  1. Login ke apigee.com/edge.
  2. Pilih Publikasikan > Monetisasi > Laporan di menu navigasi kiri.

Halaman Laporan akan ditampilkan.

Seperti yang ditunjukkan pada gambar, halaman Laporan memungkinkan Anda:

Classic Edge (Private Cloud)

Untuk mengakses halaman Laporan menggunakan UI Edge Klasik:

  1. Login ke http://ms-ip:9000, dengan ms-ip adalah alamat IP atau nama DNS node Server Pengelolaan.
  2. Pilih Monetisasi > Laporan Monetisasi di menu navigasi atas.

Halaman Laporan akan ditampilkan.

Mengonfigurasi laporan

Konfigurasi laporan menggunakan UI, seperti yang dijelaskan di bagian berikut.

Langkah-langkah untuk mengonfigurasi laporan

Konfigurasi laporan menggunakan Edge UI atau Classic Edge UI.

Edge

Untuk mengonfigurasi laporan menggunakan UI Edge:

  1. Pilih Publikasikan > Monetisasi > Laporan di menu navigasi kiri.
  2. Klik + Laporan
  3. Konfigurasi detail laporan yang ditentukan dalam tabel berikut.
    Kolom Deskripsi
    Nama Nama unik laporan.
    Deskripsi Deskripsi laporan.
    Jenis laporan Lihat Jenis laporan monetisasi.
  4. Konfigurasi detail laporan lainnya berdasarkan jenis laporan yang dipilih, seperti yang dijelaskan di bagian berikut:
  5. Setelah memasukkan informasi di jendela laporan, Anda dapat:
    • Klik Simpan laporan untuk menyimpan konfigurasi laporan.
    • Khusus laporan Mendetail, klik Kirim tugas untuk menjalankan laporan secara asinkron dan mengambil hasilnya nanti. Lihat Membuat dan mendownload laporan untuk mengetahui informasi selengkapnya.

    • Klik Simpan sebagai CSV atau Simpan sebagai Zip untuk mendownload laporan yang dihasilkan ke komputer lokal Anda sebagai file comma-separated values (CSV) atau file zip terkompresi yang berisi CSV. Download ZIP direkomendasikan untuk laporan berukuran besar dan akan didownload secara lebih efektif.

Classic Edge (Private Cloud)

Untuk membuat laporan menggunakan UI Edge Klasik:

  1. Pilih Monetisasi > Laporan Monetisasi di menu navigasi atas.
  2. Di menu drop-down, pilih jenis laporan yang ingin Anda buat. Lihat Jenis laporan monetisasi.
  3. Klik + Laporan.
  4. Konfigurasi detail laporan berdasarkan jenis penagihan yang dipilih, seperti yang dijelaskan di bagian berikut:
  5. Setelah memasukkan informasi di jendela laporan, Anda dapat:
    • Klik Simpan sebagai ... untuk menyimpan konfigurasi laporan dan mendownload laporan nanti.
    • Khusus untuk laporan Mendetail, klik Kirim tugas untuk menjalankan laporan secara asinkron dan mengambil hasilnya nanti. Lihat Membuat dan mendownload laporan untuk mengetahui informasi selengkapnya.

    • Klik Download CSV untuk membuat dan mendownload laporan ke komputer lokal Anda sebagai file nilai yang dipisahkan koma (CSV) untuk dilihat.

Mengonfigurasi laporan penagihan

Ikuti langkah-langkah untuk mengonfigurasi laporan dan masukkan informasi berikut di halaman laporan:

Kolom Deskripsi
Bulan Penagihan

Bulan penagihan untuk laporan.

Tingkat Pelaporan

Tingkat pelaporan. Nilai yang valid mencakup:

  • Mendetail: Menampilkan setiap transaksi di baris terpisah dan memungkinkan Anda memeriksa apakah paket tarif telah diterapkan dengan benar. Tidak ada ringkasan.
  • Ringkasan: Merangkum total pendapatan untuk setiap produk dan developer API.
Paket Produk

Catatan: Di UI Edge Klasik, paket produk API disebut sebagai paket API.

Pilih paket produk API yang akan disertakan dalam laporan. Jika tidak ada yang dipilih, semua paket produk API akan disertakan dalam laporan.

Laporan ini menyertakan baris terpisah untuk setiap paket produk API yang dipilih.

Untuk laporan ringkasan, Anda dapat secara opsional mencentang Jangan tampilkan di opsi tampilan Ringkasan. Dalam hal ini, laporan menggabungkan informasi di semua (atau beberapa) paket produk API (dan tidak mencantumkan informasi untuk setiap paket produk API secara terpisah).

Produk

Pilih produk API yang akan disertakan dalam laporan. Jika tidak ada yang dipilih, semua produk API akan disertakan dalam laporan.

Laporan ini menyertakan baris terpisah untuk setiap produk API yang dipilih.

Untuk laporan ringkasan, Anda dapat secara opsional mencentang Jangan tampilkan di opsi tampilan Ringkasan. Dalam hal ini, laporan menggabungkan informasi di semua (atau developer yang dipilih) (dan tidak mencantumkan informasi untuk setiap developer yang dipilih secara terpisah).

Perusahaan

Pilih perusahaan yang akan disertakan dalam laporan. Jika tidak ada yang dipilih, semua perusahaan akan disertakan dalam laporan.

Paket Tarif

Paket tarif yang akan disertakan dalam laporan. Pilih salah satu opsi berikut:

  • Semua paket tarif: Menyertakan semua paket tarif dalam laporan.
  • Paket tarif standar: Hanya menyertakan paket tarif standar dalam laporan.
  • Paket tarif khusus developer: Hanya menyertakan paket developer dalam laporan.

Mengonfigurasi laporan saldo prabayar

Ikuti langkah-langkah untuk mengonfigurasi laporan dan masukkan informasi berikut di halaman laporan:

Kolom Deskripsi
Bulan Penagihan

Bulan penagihan untuk laporan.

Tingkat Pelaporan

Tingkat pelaporan. Nilai yang valid mencakup:

  • Detail: Menampilkan setiap pengisian ulang saldo secara terpisah dan memungkinkan Anda untuk mencocokkan dengan pembayaran yang diterima dari pemroses pembayaran Anda.
  • Ringkasan: Merangkum total pengisian ulang saldo untuk setiap developer.
Perusahaan

Pilih perusahaan yang akan disertakan dalam laporan. Jika tidak ada yang dipilih, semua perusahaan akan disertakan dalam laporan.

Mengonfigurasi laporan pendapatan

Ikuti langkah-langkah untuk mengonfigurasi laporan dan masukkan informasi berikut di halaman laporan:

Kolom Deskripsi
Rentang Tanggal

Rentang tanggal untuk laporan. Pilih salah satu opsi berikut:

  • Preset: Pilih salah satu rentang tanggal standar (seperti Bulan Kalender Lalu) dari menu drop-down.
  • Kustom: Pilih tanggal mulai dan tanggal akhir untuk rentang dari pop-up kalender.
Pilih mata uang

Mata uang untuk laporan. Nilai yang valid mencakup:

  • Mata uang lokal: Setiap baris laporan ditampilkan menggunakan paket tarif yang berlaku. Artinya, mungkin ada beberapa mata uang dalam satu laporan jika developer memiliki paket yang menggunakan mata uang yang berbeda.
  • Euro: Transaksi dalam mata uang lokal dalam laporan dikonversi dan ditampilkan dalam Euro.
  • Pound Inggris Raya: Transaksi dalam mata uang lokal dalam laporan dikonversi dan ditampilkan dalam pound.
  • Dolar Amerika Serikat: Transaksi mata uang lokal dalam laporan dikonversi dan ditampilkan dalam dolar.
Tingkat Pelaporan

Tingkat pelaporan. Nilai yang valid mencakup:

  • Detail: Menampilkan setiap transaksi pada baris terpisah. Tidak ada ringkasan.
  • Ringkasan: Merangkum total pendapatan untuk setiap produk API dan developer, bergantung pada parameter yang Anda pilih.
Paket Produk

Catatan: Di UI Edge Klasik, paket produk API disebut sebagai paket API.

Pilih paket produk API yang akan disertakan dalam laporan. Jika tidak ada yang dipilih, semua paket produk API akan disertakan dalam laporan.

Laporan ini menyertakan baris terpisah untuk setiap paket produk API yang dipilih.

Untuk laporan ringkasan, Anda dapat secara opsional mencentang Jangan tampilkan di opsi tampilan Ringkasan. Dalam hal ini, laporan menggabungkan informasi di semua (atau beberapa) paket produk API (dan tidak mencantumkan informasi untuk setiap paket produk API secara terpisah).

Produk

Pilih produk API yang akan disertakan dalam laporan. Jika tidak ada yang dipilih, semua produk API akan disertakan dalam laporan.

Laporan ini menyertakan baris terpisah untuk setiap produk API yang dipilih.

Untuk laporan ringkasan, Anda dapat secara opsional mencentang Jangan tampilkan di opsi tampilan Ringkasan. Dalam hal ini, laporan menggabungkan informasi di semua (atau developer yang dipilih) (dan tidak mencantumkan informasi untuk setiap developer yang dipilih secara terpisah).

Perusahaan

Pilih perusahaan yang akan disertakan dalam laporan. Jika tidak ada yang dipilih, semua perusahaan akan disertakan dalam laporan.

Untuk laporan ringkasan, Anda dapat secara opsional mencentang Jangan tampilkan di bagian Opsi Tampilan Ringkasan. Dalam hal ini, laporan menggabungkan informasi di semua (atau perusahaan yang dipilih) (dan tidak mencantumkan informasi untuk setiap perusahaan yang dipilih secara terpisah).

Aplikasi

Pilih aplikasi yang akan disertakan dalam laporan. Jika tidak ada yang dipilih, semua aplikasi akan disertakan dalam laporan.

Laporan ini menyertakan baris terpisah untuk setiap aplikasi yang dipilih.

Untuk laporan ringkasan, Anda dapat secara opsional mencentang Jangan tampilkan di bagian Opsi Tampilan Ringkasan. Dalam hal ini, laporan menggabungkan informasi di semua (atau aplikasi yang dipilih) (dan tidak mencantumkan informasi untuk setiap aplikasi yang dipilih secara terpisah).

Opsi tampilan ringkasan

Urutan kolom dikelompokkan dan ditampilkan dalam laporan. Pilih angka yang menunjukkan urutan relatif bagian tersebut dalam pengelompokan (1 adalah pengelompokan pertama). Misalnya, laporan berikut dikelompokkan terlebih dahulu menurut paket, lalu menurut produk, kemudian menurut developer, lalu menurut aplikasi.

Jika Anda tidak ingin menampilkan bagian, pilih Jangan tampilkan, lalu pilih kolom yang tersisa secara berurutan. Urutan akan otomatis diperbarui saat Anda mengubah urutan relatif satu bagian atau memilih untuk tidak menampilkan bagian dalam laporan.

Menyertakan atribut transaksi kustom dalam laporan ringkasan pendapatan

Kebijakan pencatatan transaksi memungkinkan Anda mengambil data atribut kustom dari transaksi, dan Anda dapat menyertakan atribut kustom tersebut dalam laporan pendapatan ringkasan. Tentukan kumpulan default atribut kustom yang disertakan dalam tabel database monetisasi dengan menetapkan properti MINT.SUMMARY_CUSTOM_ATTRIBUTES untuk organisasi Anda.

Penggunaan fitur ini memerlukan pemikiran dan perencanaan, jadi tinjau pertimbangan di bawah.

Jika Anda adalah pelanggan cloud, hubungi Dukungan Apigee Edge untuk menetapkan properti tersebut. Jika Anda adalah pelanggan Apigee Edge for Private Cloud, tetapkan tanda menggunakan permintaan PUT ke API berikut dengan kredensial Administrator Sistem.

curl -u email:password -X PUT -H "Content-type:application/xml" http://host:port/v1/o/{myorg} -d \
"<Organization type="trial" name="MyOrganization">
    <Properties>
        <Property name="features.isMonetizationEnabled">true</Property>
        <Property name="MINT.SUMMARY_CUSTOM_ATTRIBUTES">[&quot;partner_id&quot;,&quot;tax_source&quot;]</Property>
        <Property name="features.topLevelDevelopersAreCompanies">false</Property>
    </Properties>
</Organization>"

Dalam contoh ini, panggilan API mengaktifkan fitur dan menambahkan kolom partner_id dan tax_source ke database monetisasi. Perhatikan bahwa array atribut kustom dalam panggilan API dienkode URL.

Pertimbangan untuk menyertakan atribut transaksi kustom dalam laporan

  • Pastikan nama atribut yang ingin Anda gunakan sebelum Anda membuatnya dengan API. Itu adalah nama kolom dalam database, dan data atribut kustom selalu disimpan di sana.
  • Ada 10 slot atribut kustom yang tersedia di setiap kebijakan perekaman transaksi, seperti yang ditunjukkan pada gambar berikut. Gunakan nama dan posisi atribut yang sama persis untuk atribut yang sama di seluruh produk yang akan disertakan dalam laporan. Misalnya, dalam kebijakan perekaman transaksi berikut, atribut kustom partner_id dan tax_source menempati kotak 4 dan 5. Ini harus berupa nama dan posisi mereka dalam semua kebijakan pencatatan transaksi agar produk disertakan dalam pelaporan.

Untuk menyertakan atribut kustom dalam laporan pendapatan ringkasan setelah Anda mengaktifkan fitur ini, gunakan API laporan dengan menambahkan transactionCustomAttributes ke MintCriteria. Lihat Opsi konfigurasi kriteria.

Mengonfigurasi laporan varians (Tidak digunakan lagi)

Ikuti langkah-langkah untuk mengonfigurasi laporan dan masukkan informasi berikut di halaman laporan:

Kolom Deskripsi
Rentang Tanggal

Rentang tanggal untuk laporan. Pilih salah satu opsi berikut:

  • Preset: Pilih salah satu rentang tanggal standar (seperti Bulan Kalender Lalu) dari menu drop-down.
  • Kustom: Pilih tanggal mulai dan tanggal akhir untuk rentang dari pop-up kalender.
Paket

Paket API yang akan disertakan dalam laporan. Pilih salah satu opsi berikut:

  • Semua: Mencakup semua paket API dalam laporan.
  • Dipilih: Menampilkan daftar yang dapat Anda gunakan untuk memilih paket API yang akan disertakan dalam laporan. Jika Anda tidak memilih paket, semua paket akan disertakan dalam laporan.

Laporan ini menyertakan baris terpisah untuk setiap paket API yang dipilih.

Untuk laporan ringkasan, Anda dapat secara opsional mencentang Jangan Tampilkan (Paket) di bagian Opsi Tampilan Ringkasan. Dalam hal ini, laporan menggabungkan informasi di semua (atau yang dipilih) paket API (dan tidak mencantumkan informasi untuk setiap paket API secara terpisah).

Produk

Produk API yang akan disertakan dalam laporan. Pilih salah satu opsi berikut:

  • Semua: Menyertakan semua produk API dalam laporan.
  • Dipilih: Menampilkan daftar yang dapat Anda gunakan untuk memilih produk yang akan disertakan dalam laporan. Jika Anda tidak memilih produk, semua produk akan disertakan dalam laporan.

Laporan ini menyertakan baris terpisah untuk setiap produk API yang dipilih.

Untuk laporan ringkasan, Anda dapat secara opsional mencentang Jangan Tampilkan (Produk) di bagian Opsi Tampilan Ringkasan. Dalam hal ini, laporan menggabungkan informasi di semua (atau yang dipilih) produk API (dan tidak mencantumkan informasi untuk setiap produk API secara terpisah).

Perusahaan

Perusahaan yang akan disertakan dalam laporan. Pilih salah satu opsi berikut:

  • Semua: Menyertakan semua perusahaan dalam laporan.
  • Dipilih: Menampilkan daftar yang dapat Anda gunakan untuk memilih perusahaan yang akan disertakan dalam laporan. Jika Anda tidak memilih perusahaan, semua perusahaan akan disertakan dalam laporan.

Laporan ini menyertakan baris terpisah untuk setiap perusahaan yang dipilih.

Untuk laporan ringkasan, Anda dapat secara opsional mencentang Jangan Tampilkan (Perusahaan) di bagian Opsi Tampilan Ringkasan. Dalam hal ini, laporan menggabungkan informasi di semua (atau perusahaan yang dipilih) dan tidak mencantumkan informasi untuk setiap perusahaan yang dipilih secara terpisah.

Aplikasi

Aplikasi yang akan disertakan dalam laporan. Pilih salah satu opsi berikut:

  • Semua: Menyertakan semua aplikasi dalam laporan.
  • Dipilih: Menampilkan daftar yang dapat Anda gunakan untuk memilih aplikasi yang akan disertakan dalam laporan. Jika Anda tidak memilih aplikasi, semua aplikasi akan disertakan dalam laporan.

Laporan ini menyertakan baris terpisah untuk setiap aplikasi yang dipilih.

Untuk laporan ringkasan, Anda dapat secara opsional mencentang Jangan Tampilkan (Aplikasi) di bagian Opsi Tampilan Ringkasan. Dalam hal ini, laporan menggabungkan informasi di semua (atau aplikasi yang dipilih) (dan tidak mencantumkan informasi untuk setiap aplikasi yang dipilih secara terpisah).

Mata Uang

Mata uang untuk laporan. Nilai yang valid mencakup:

  • Mata uang lokal: Setiap baris laporan ditampilkan menggunakan paket tarif yang berlaku. Artinya, mungkin ada beberapa mata uang dalam satu laporan jika developer memiliki paket yang menggunakan mata uang yang berbeda.
  • EUR: Transaksi dalam mata uang lokal dalam laporan dikonversi dan ditampilkan dalam Euro.
  • GPB: Transaksi dalam mata uang lokal dalam laporan dikonversi dan ditampilkan dalam pound.
  • USD: Transaksi mata uang lokal dalam laporan dikonversi dan ditampilkan dalam dolar.
Opsi tampilan ringkasan

Urutan kolom dikelompokkan dan ditampilkan dalam laporan. Pilih angka yang menunjukkan urutan relatif bagian tersebut dalam pengelompokan (1 adalah pengelompokan pertama). Misalnya, laporan berikut dikelompokkan terlebih dahulu menurut paket, lalu menurut produk, kemudian menurut developer, lalu menurut aplikasi.

Jika Anda tidak ingin menampilkan bagian, pilih Jangan tampilkan, lalu pilih kolom yang tersisa secara berurutan. Urutan akan otomatis diperbarui saat Anda mengubah urutan relatif satu bagian atau memilih untuk tidak menampilkan bagian dalam laporan.

Membuat dan mendownload laporan

Setelah membuat laporan, Anda dapat mendownload hasil laporan dalam format CSV atau file zip. Anda dapat membuat file CSV atau ZIP secara sinkron atau asinkron.

  • Untuk laporan sinkron, Anda menjalankan permintaan laporan dan permintaan diblokir hingga server analytics memberikan respons. Namun, karena laporan mungkin perlu memproses sejumlah besar data (misalnya, ratusan GB), laporan sinkron mungkin gagal karena waktu tunggu habis.

    Tingkat laporan Ringkasan hanya mendukung pembuatan sinkron.

  • Untuk laporan asinkron, Anda menjalankan permintaan laporan dan mengambil hasilnya di lain waktu. Beberapa situasi saat pemrosesan kueri asinkron mungkin menjadi alternatif yang baik meliputi:

    • Menganalisis dan membuat laporan yang mencakup interval waktu yang besar.
    • Menganalisis data dengan berbagai dimensi pengelompokan dan batasan lain yang menambah kompleksitas kueri.
    • Mengelola kueri saat Anda mendapati bahwa volume data telah meningkat secara signifikan untuk beberapa pengguna atau organisasi.

    Tingkat laporan Detail mendukung pembuatan asinkron.

Untuk membuat dan mendownload laporan dalam format file CSV atau zip, lakukan salah satu tugas berikut:

  1. Buka halaman Laporan.
  2. Arahkan kursor ke laporan yang ingin Anda download.
  3. Di kolom Diubah, klik:

    1. Ikon Ikon file CSV atau ikon ikon file zip (untuk laporan Ringkasan). Laporan disimpan ke file CSV atau zip secara serentak.
    2. Kirimkan tugas (untuk Laporan mendetail). Tugas asinkron dimulai.
      1. Pantau status tugas di kolom Diubah.

        Ikon disk akan muncul saat laporan siap didownload:

        Image disk muncul saat laporan siap didownload.
      2. Setelah tugas selesai, klik ikon disk untuk mendownload laporan.

Berikut adalah contoh file CSV untuk laporan penagihan ringkasan.

Mengedit laporan

Untuk mengedit laporan:

  1. Akses halaman Laporan.
  2. Arahkan kursor ke laporan yang ingin Anda edit, lalu klik di menu tindakan.
  3. Perbarui konfigurasi laporan sesuai kebutuhan.
  4. Klik Perbarui laporan untuk menyimpan konfigurasi laporan yang telah diperbarui.

Menghapus laporan

Untuk menghapus laporan:

  1. Akses halaman Laporan.
  2. Arahkan kursor ke laporan yang ingin Anda hapus.
  3. Klik di menu tindakan.

Mengelola laporan monetisasi menggunakan API

Bagian berikut menjelaskan cara mengelola laporan monetisasi menggunakan API.

Mengonfigurasi laporan menggunakan API

Untuk mengonfigurasi laporan bagi seluruh organisasi, kirim permintaan POST ke /organizations/{org_name}/report-definitions.

Untuk mengonfigurasi laporan bagi developer tertentu, kirim permintaan POST ke /organizations/{org_name}/developers/{dev_id}/report-definitions, dengan {dev_id} adalah identifikasi developer.

Saat membuat permintaan, Anda perlu menentukan nama dan jenis laporan. Jenisnya adalah salah satu dari berikut ini: BILLING, REVENUE, VARIANCE (tidak digunakan lagi), atau PREPAID_BALANCE. Selain itu, Anda dapat menentukan kriteria di properti mintCriteria yang mengonfigurasi laporan lebih lanjut. Ada berbagai kriteria yang dapat Anda tentukan. Hal ini memberi Anda banyak fleksibilitas dalam mengonfigurasi laporan. Beberapa hal yang dapat Anda tentukan sebagai kriteria adalah:

  • Untuk laporan saldo prabayar atau penagihan, bulan penagihan untuk laporan
  • Untuk laporan pendapatan, jenis transaksi yang tercakup dalam laporan, seperti transaksi pembelian, transaksi penagihan, dan pengembalian dana
  • Untuk laporan saldo prabayar, developer yang laporannya berlaku
  • Untuk laporan pendapatan, produk API yang digabungkan (atau paket API), produk, paket tarif, dan aplikasi yang tercakup dalam laporan
  • Untuk laporan pendapatan atau varians, mata uang yang berlaku untuk laporan
  • Untuk laporan penagihan, saldo prabayar, atau pendapatan, apakah laporan tersebut adalah laporan ringkasan atau laporan mendetail
  • Untuk laporan ringkasan pendapatan, sertakan atribut transaksi kustom dalam laporan

Lihat Opsi konfigurasi laporan untuk mengetahui daftar lengkap kriteria laporan.

Misalnya, berikut ini membuat laporan pendapatan yang meringkas aktivitas transaksi untuk bulan Juli 2015. Laporan ini mencakup berbagai jenis transaksi yang ditentukan dalam properti transactionTypes, dan berlaku khusus untuk paket produk Payment API dan produk Payment API. Karena tidak ada developer atau aplikasi tertentu yang ditentukan dalam definisi laporan, laporan ini berlaku untuk semua developer dan aplikasi. Karena properti currencyOption disetel ke LOCAL, setiap baris laporan akan ditampilkan menggunakan mata uang paket tarif yang berlaku. Selain itu, properti groupBy menentukan bahwa kolom dalam laporan akan dikelompokkan dalam urutan berikut: PAKET, PRODUK, DEVELOPER, APLIKASI, dan PAKET TARIF (mencakup nama paket tarif dan ID dalam laporan).

$ curl -H "Content-Type: application/json" -X POST -d \
'{
      "name": "July 2015 revenue report",
      "description": " July 2015 revenue report for Payment product",
      "type": "REVENUE",     
      "mintCriteria":{
         "fromDate":"2015-07-01 00:00:00",
         "toDate":"2015-08-01 13:35:00",
         "showTxDetail":true,
         "showSummary":true,
         "transactionTypes":[
            "PURCHASE",
            "CHARGE",
            "REFUND",
            "CREDIT",
            "SETUPFEES",
            "TERMINATIONFEES",
            "RECURRINGFEES"
         ],
         "monetizationPackageIds":[
            "payment"
         ],
         "productIds":[
            "payment"
         ],
         "currencyOption":"LOCAL",
         "groupBy":[
            "PACKAGE",
            "PRODUCT",
            "DEVELOPER",
            "APPLICATION",
            "RATEPLAN"
         ]
      }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions" \
-u email:password

Berikut ini membuat laporan penagihan mendetail yang menunjukkan aktivitas developer DEV FIVE untuk bulan Juni 2015.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
      "name": "June billing report, DEV FIVE",
      "description": "June billing report, DEV FIVE",
      "type": "BILLING",      
      "mintCriteria":{
         "billingMonth": "JUNE",
         "billingYear": 2015,
         "showTxDetail":true,
         "showSummary":false,         
         "currencyOption":"LOCAL"         
      },
      "devCriteria":[{
         "id":"RtHAeZ6LtkSbEH56",
         "orgId":"myorg"}]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/report-definitions" \
-u email:password

Melihat konfigurasi laporan menggunakan API

Anda dapat melihat konfigurasi laporan tertentu atau semua konfigurasi laporan untuk organisasi. Anda juga dapat melihat konfigurasi laporan untuk masing-masing developer.

Untuk melihat konfigurasi laporan tertentu untuk organisasi, kirim permintaan GET ke /organizations/{org_name}/report-definitions/{report_definition_id}, dengan {report_definition_id} adalah identifikasi konfigurasi laporan tertentu (ID ditampilkan dalam respons saat Anda membuat konfigurasi laporan). Contoh:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/1f7fa53b-de5a-431d-9438-62131e1396c5" \
-u email:password

Untuk melihat semua konfigurasi laporan untuk organisasi, kirim permintaan GET ke /organizations/{org_name}/report-definitions.

Anda dapat meneruskan parameter kueri berikut untuk memfilter dan mengurutkan hasil:

Parameter Kueri Deskripsi
all Flag yang menentukan apakah akan menampilkan semua paket produk API. Jika disetel ke false, jumlah paket produk API yang ditampilkan per halaman ditentukan oleh parameter kueri size. Nilai defaultnya adalah false.
size Jumlah paket produk API yang ditampilkan per halaman. Defaultnya adalah 20. Jika parameter kueri all ditetapkan ke true, parameter ini akan diabaikan.
page Nomor halaman yang ingin Anda tampilkan (jika konten dipaginasi). Jika parameter kueri all ditetapkan ke true, parameter ini akan diabaikan.
sort Kolom yang digunakan untuk mengurutkan informasi. Jika parameter kueri all ditetapkan ke true, parameter ini akan diabaikan. Nilai defaultnya adalah UPDATED:DESC.

Misalnya, kode berikut menampilkan konfigurasi laporan untuk organisasi dan membatasi pengambilan hingga maksimum lima konfigurasi laporan:

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions?size=5" \ 
-u email:password

Responsnya akan terlihat seperti ini (hanya sebagian respons yang ditampilkan):

{
  "reportDefinition" : [ {
    "description" : "Test revenue report",
    "developer" : null,
    "id" : "1f7fa53b-de5a-431d-9438-62131e1396c5",
    "lastModified" : "2015-08-27 15:44:03",
    "mintCriteria" : {
      "asXorg" : false,
      "currencyOption" : "LOCAL",
      "fromDate" : "2015-07-01 00:00:00",
      "groupBy" : [ "PACKAGE", "PRODUCT", "DEVELOPER", "APPLICATION", "RATEPLAN" ],
      "monetizationPackageIds" : [ "payment" ],
      "productIds" : [ "payment" ],
      "showRevSharePct" : false,
      "showSummary" : true,
      "showTxDetail" : true,
      "showTxType" : false,
      "toDate" : "2015-08-01 00:05:00",
      "transactionTypes" : [ "PURCHASE", "CHARGE", "REFUND", "CREDIT", "SETUPFEES", "TERMINATIONFEES", "RECURRINGFEES" ]
    },
    "name" : "Test revenue report",
    "organization" : {
      ...
    },
    "type" : "REVENUE"
  }, {
    "description" : "June billing report, DEV FIVE",
    "developer" : null,
    "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb",
    "lastModified" : "2015-08-27 17:13:20",
    "mintCriteria" : {
      "asXorg" : false,
      "billingMonth" : "JUNE",
      "billingYear" : 2015,
      "currencyOption" : "LOCAL",
      "showRevSharePct" : false,
      "showSummary" : false,
      "showTxDetail" : true,
      "showTxType" : false
    },
    "name" : "June billing report, DEV FIVE",
    "organization" : {
      ...
    },
    "type" : "BILLING"
  } ],
  "totalRecords" : 2
}

Untuk melihat konfigurasi laporan bagi developer tertentu, kirim permintaan GET ke /organizations/{org_name}/developers/{dev_id}/report-definitions, dengan {dev_id} adalah identifikasi developer. Saat membuat permintaan, Anda dapat menentukan parameter kueri yang dijelaskan di atas untuk memfilter dan mengurutkan data.

Misalnya, perintah berikut menampilkan konfigurasi laporan untuk developer tertentu dan mengurutkan respons berdasarkan nama laporan:

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xUreport-definitions?sort=name" \ 
-u email:password

Memperbarui konfigurasi laporan menggunakan API

Untuk mengupdate konfigurasi laporan, kirimkan permintaan PUT ke /organizations/{org_name}/report-definitions/{report_definition_id}, dengan {report_definition_id} adalah identifikasi konfigurasi laporan tertentu. Saat melakukan pembaruan, Anda harus menentukan nilai konfigurasi yang diperbarui dan ID konfigurasi laporan dalam isi permintaan. Misalnya, permintaan berikut memperbarui laporan menjadi laporan ringkasan (properti yang diperbarui ditandai):

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
       "id": "fedac696-ce57-469b-b62c-a77b535fd0eb",
       "name": "June billing report, DEV FIVE",
       "description": "June billing report, DEV FIVE",
       "type": "BILLING",      
       "mintCriteria":{      
         "billingMonth": "JUNE",
         "billingYear": 2015,
         "showTxDetail":false,
         "showSummary":true    
        }     
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \
-u email:password

Responsnya akan terlihat seperti ini (hanya sebagian respons yang ditampilkan):

{
 "description" : "June billing report, DEV FIVE",
  "developer" : null,
  "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb",
  "lastModified" : "2015-08-27 17:47:29",
  "mintCriteria" : {
    "asXorg" : false,
    "billingMonth" : "JUNE",
    "billingYear" : 2015,
    "showRevSharePct" : false,
    "showSummary" : true,
    "showTxDetail" : false,
    "showTxType" : false
  },
  "name" : "June billing report, DEV FIVE",
  "organization" : {
    ... 
  },
  "type" : "BILLING"
}

Menghapus konfigurasi laporan menggunakan API

Untuk menghapus konfigurasi laporan, kirim permintaan DELETE ke /organizations/{org_namer}/report-definitions/{report_definition_id}, dengan {report_definition_id} adalah identifikasi konfigurasi laporan yang akan dihapus. Contoh:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \
-u email:password

Membuat laporan menggunakan API

Setelah mengonfigurasi laporan, Anda dapat membuat laporan dalam format file nilai yang dipisahkan koma (CSV) untuk dilihat.

Untuk membuat laporan, kirim permintaan POST ke organizations/{org_id}/{report_type}, dengan {report_type} menentukan jenis laporan yang ingin Anda buat. Jenisnya adalah:

  • billing-reports
  • revenue-reports
  • prepaid-balance-reports
  • variance-reports
Selain itu, Anda dapat membuat laporan pendapatan untuk developer tertentu, seperti yang dijelaskan dalam Membuat laporan pendapatan untuk developer.

Misalnya, untuk membuat laporan penagihan, kirim permintaan POST ke organizations/{org_name}/billing-reports.

Di isi permintaan (untuk jenis laporan apa pun), tentukan kriteria penelusuran untuk laporan. Gunakan properti mintCriteria untuk menentukan kriteria penelusuran. Lihat Opsi konfigurasi kriteria untuk mengetahui detail selengkapnya.

Misalnya, permintaan berikut menelusuri laporan pendapatan berdasarkan berbagai kriteria, seperti tanggal mulai dan akhir laporan serta jenis transaksi.

$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \
'{
      "fromDate":"2015-07-01 00:00:00",
      "toDate":"2015-08-01 13:35:00",
      "showTxDetail":true,
      "showSummary":true,                
      "transactionTypes":[
        "PURCHASE",
        "CHARGE",
        "REFUND",
        "CREDIT",
        "SETUPFEES",
        "TERMINATIONFEES",
        "RECURRINGFEES"
      ],
      "currencyOption":"LOCAL",
      "groupBy":[
        "PACKAGE",
        "PRODUCT",
        "DEVELOPER",
        "APPLICATION",
        "RATEPLAN"]
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \
-u email:password

Jika ditemukan, laporan pendapatan akan dibuat dalam format file CSV. Berikut adalah contoh output laporan:

Reporting Period:,From:,2015-07-01,  To:,2015-07-31
API Product:,All
Developer:,All
Application:,All
Currency:,Local
Type of Report:,Summary Revenue Report

Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate,
Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,

Menyertakan atribut kustom developer dalam laporan pendapatan menggunakan API

Khusus untuk laporan pendapatan, Anda dapat menyertakan atribut kustom dalam laporan, jika atribut kustom ditentukan untuk developer. Anda menentukan atribut kustom saat menambahkan developer ke organisasi Anda, seperti yang dijelaskan dalam Mengelola developer aplikasi.

Untuk menyertakan atribut kustom dalam laporan pendapatan, kirim permintaan POST ke organizations/{org_name}/revenue-reports dan sertakan array devCustomAttributes dalam isi permintaan:

"devCustomAttributes": [
    "custom_attribute1",
    "custom_attribute2",
    ...
]

Catatan: Jangan tentukan atribut MINT_* dan ADMIN_* yang telah ditentukan sebelumnya dalam array devCustomAttributes.

Misalnya, contoh berikut menyertakan tiga atribut kustom, BILLING_TYPE, SFID, dan ORG_EXT, dalam laporan (jika ditentukan untuk developer):

$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \
'{
      "fromDate":"2015-07-01 00:00:00",
      "toDate":"2015-08-01 13:35:00",
      "showTxDetail":true,
      "showSummary":true,                
      "transactionTypes":[
        "PURCHASE",
        "CHARGE",
        "REFUND",
        "CREDIT",
        "SETUPFEES",
        "TERMINATIONFEES",
        "RECURRINGFEES"
      ],
      "currencyOption":"LOCAL",
      "groupBy":[
        "PACKAGE",
        "PRODUCT",
        "DEVELOPER",
        "APPLICATION",
        "RATEPLAN"
      ],
      "devCustomAttributes": [
         "BILLING_TYPE",
         "SFID",
         "ORG_EXT"
      ]
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \
-u email:password

Berikut adalah contoh output laporan yang menyertakan nilai untuk dua atribut kustom:

Reporting Period:,From:,2015-07-01,  To:,2015-07-31
API Product:,All
Developer:,All
Application:,All
Currency:,Local
Type of Report:,Summary Revenue Report

Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate,BILLING_TYPE,SFID,ORG_EXT 
Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,

Melaporkan aktivitas transaksi menggunakan API

Anda dapat melihat aktivitas transaksi untuk organisasi dengan mengirimkan permintaan POST ke /organizations/{org_name}/transaction-search. Saat membuat permintaan, Anda perlu menentukan kriteria untuk pengambilan. Beberapa hal yang dapat Anda tentukan sebagai kriteria adalah:

  • ID satu atau beberapa produk API yang transaksinya dikeluarkan.
  • Bulan dan tahun penagihan transaksi.
  • Developer yang mengeluarkan transaksi.
  • Jenis transaksi seperti pembelian dan biaya penyiapan.
  • Status transaksi seperti berhasil dan gagal.

Lihat Opsi konfigurasi kriteria untuk mengetahui daftar lengkap kriteria.

Misalnya, berikut transaksi yang dikeluarkan oleh developer tertentu untuk bulan penagihan Juni 2015:

$ curl -H "Content-Type:application/json" -X POST -d \
 '{        
    "billingMonth": "JUNE",
    "billingYear": 2015,
    "devCriteria": [{
      "id": "RtHAeZ6LtkSbEH56",
      "orgId":"myorg"}],
    "transactionTypes": ["PURCHASE", "CHARGE", "SETUPFEES"],
    "transactionStatus": ["SUCCESS", "FAILED"]
    }'
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/transaction-search \
-u email:password

Anda juga dapat menentukan aplikasi, developer, paket produk API, atau produk API mana yang memiliki aktivitas transaksi dalam rentang tanggal tertentu. Anda dapat melihat informasi ini secara terpisah untuk setiap jenis objek. Misalnya, Anda dapat melihat informasi khusus tentang aplikasi yang mengakses API dalam paket produk API yang dimonetisasi dalam tanggal mulai dan akhir tertentu.

Untuk melihat informasi tentang aktivitas transaksi, kirim permintaan GET ke salah satu resource berikut:

Resource Hasil
/organizations/{org_name}/applications-with-transactions

Aplikasi dengan transaksi

/organizations/{org_name}/developers-with-transactions

Developer dengan transaksi

/organizations/{org_name}/products-with-transactions

Produk dengan transaksi

/organizations/{org_name}/packages-with-transactions

Paket produk API (atau paket API) dengan transaksi

Saat mengirimkan permintaan, Anda harus menentukan tanggal mulai dan tanggal akhir sebagai parameter kueri untuk rentang tanggal. Misalnya, permintaan berikut menampilkan developer dengan transaksi selama bulan Agustus 2015.

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers-with-transactions?START_DATE=2015-08-01&END_DATE=2015-08-31" \
-u email:password

Responsnya akan terlihat seperti ini (hanya sebagian respons yang ditampilkan):

{
  "developer" : [ {
    "address" : [ {
      "address1" : "Dev Five Address",
      "city" : "Pleasanton",
      "country" : "US",
      "id" : "0917f15f-9521-4e69-9376-07aa7b7b32ca",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "94588"
    } ],
    "approxTaxRate" : 0.0900,
    "billingType" : "POSTPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev5@myorg.com",
    "hasSelfBilling" : false,
    "id" : "tJZG6broTpGGGeLV",
    "legalName" : "DEV FIVE",
    "name" : "Dev Five",
    "organization" : {
      ...
    },
    "registrationId" : "dev5",
    "status" : "ACTIVE",
    "type" : "UNTRUSTED"
  }, {
    "address" : [ {
      "address1" : "Dev Seven Address",
      "city" : "Pleasanton",
      "country" : "US",
      "id" : "f86d8c9f-6ed1-4323-b050-6adf494096c9",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "94588"
    } ],
    "approxTaxRate" : 0.0900,
    "billingType" : "POSTPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev7@myorg.com",
    "hasSelfBilling" : false,
    "id" : "VI3l8m8IPAvJTvjS",
    "legalName" : "DEV SEVEN",
    "name" : "Dev Seven",
    "organization" : {
      ...
    },
    "registrationId" : "dev7",
    "status" : "ACTIVE",
    "type" : "UNTRUSTED"
  }, ...
  ]
}

Opsi konfigurasi laporan untuk API

Opsi konfigurasi laporan berikut tersedia untuk API:

Nama Deskripsi Default Wajib?
name

Nama laporan.

T/A Ya
description

Deskripsi laporan.

T/A Tidak
mintCriteria

Kriteria untuk mengonfigurasi laporan. Lihat Opsi konfigurasi kriteria untuk mengetahui detail selengkapnya.

T/A Tidak
type

Jenis laporan. Nilainya bisa berupa salah satu dari berikut:

  • BILLING
  • REVENUE
  • VARIANCE
  • PREPAID_BALANCE
T/A Ya

Opsi konfigurasi kriteria

Opsi konfigurasi berikut tersedia untuk laporan melalui properti mintCriteria:

Nama Deskripsi Default Wajib?
appCriteria

ID dan organisasi untuk aplikasi tertentu yang akan disertakan dalam laporan. Jika properti ini tidak ditentukan, semua aplikasi akan disertakan dalam laporan.

T/A Tidak
billingMonth

Catatan: Properti ini tidak valid untuk laporan pendapatan.

Bulan penagihan untuk laporan, seperti JULI.

T/A Ya
billingYear

Catatan: Properti ini tidak valid untuk laporan pendapatan.

Tahun penagihan untuk laporan, seperti 2015.

T/A Ya
currCriteria

ID dan organisasi untuk mata uang tertentu yang akan disertakan dalam laporan. Jika properti ini tidak ditentukan, semua mata uang yang didukung akan disertakan dalam laporan.

T/A Tidak
currencyOption

Mata uang untuk laporan. Nilai yang valid mencakup:

  • LOCAL. Setiap baris laporan ditampilkan menggunakan paket tarif yang berlaku. Artinya, mungkin ada beberapa mata uang dalam satu laporan jika developer memiliki paket yang menggunakan mata uang yang berbeda.
  • EUR. Transaksi mata uang lokal dikonversi dan ditampilkan dalam Euro.
  • GPB. Transaksi mata uang lokal dikonversi dan ditampilkan dalam pound Inggris Raya.
  • USD. Transaksi mata uang lokal dikonversi dan ditampilkan dalam dolar Amerika Serikat.
T/A Tidak
devCriteria

ID developer (alamat email), dan nama organisasi untuk developer tertentu yang akan disertakan dalam laporan. Jika properti ini tidak ditentukan, semua developer akan disertakan dalam laporan. Contoh:

"devCriteria":[{
    "id":"RtHAeZ6LtkSbEH56",
    "orgId":"my_org"}
]
                
T/A Tidak
devCustomAttributes

Catatan: Properti ini hanya berlaku untuk laporan pendapatan.

Atribut kustom yang akan disertakan dalam laporan, jika ditentukan untuk developer. Contoh:

"devCustomAttributes": [
    "custom_attribute1",
    "custom_attribute2",
    ...
]

Catatan: Jangan tentukan atribut MINT_* dan ADMIN_* yang telah ditentukan sebelumnya dalam array devCustomAttributes.

T/A Tidak
fromDate

Catatan: Properti ini hanya berlaku untuk laporan pendapatan, varians, dan aktivitas transaksi.

Tanggal mulai laporan dalam UTC.

T/A Wajib diisi untuk laporan pendapatan; tidak wajib diisi untuk jenis laporan lainnya.
groupBy

Urutan pengelompokan kolom dalam laporan. Nilai yang valid mencakup:

  • APPLICATION
  • BALANCE
  • DEVELOPER
  • ORG
  • PACKAGE
  • PRODUCT
  • RATEPLAN
T/A Tidak
monetizationPackageId

ID satu atau beberapa paket produk API yang akan disertakan dalam laporan. Jika properti ini tidak ditentukan, semua paket produk API akan disertakan dalam laporan.

Catatan: Properti ini tidak valid saat melihat aktivitas transaksi (/transaction-search).

T/A Tidak
pkgCriteria

ID dan organisasi untuk paket produk API tertentu yang akan disertakan dalam laporan. Jika properti ini tidak ditentukan, semua paket produk API akan disertakan dalam laporan. Properti ini dapat ditentukan, bukan properti monetizationpackageIds.

Catatan: Properti ini tidak valid saat melihat aktivitas transaksi (/transaction-search).

T/A Tidak
prevFromDate

Catatan: Properti ini hanya berlaku untuk laporan varians.

Tanggal mulai periode sebelumnya dalam UTC. Digunakan untuk membuat laporan periode sebelumnya untuk dibandingkan dengan laporan saat ini.

T/A Tidak
prevToDate

Catatan: Properti ini hanya berlaku untuk laporan varians.

Tanggal akhir periode sebelumnya dalam UTC. Digunakan untuk membuat laporan periode sebelumnya untuk perbandingan dengan laporan saat ini.

T/A Tidak
prodCriteria

ID dan organisasi untuk produk API tertentu yang akan disertakan dalam laporan. Jika properti ini tidak ditentukan, semua produk API akan disertakan dalam laporan. Properti ini dapat ditentukan, bukan properti productIds.

Catatan: Properti ini tidak valid saat melihat aktivitas transaksi (/transaction-search).

T/A Tidak
productIds

ID satu atau beberapa produk API yang akan disertakan dalam laporan. Jika properti ini tidak ditentukan, semua produk API akan disertakan dalam laporan.

ID produk API harus ditentukan sebagai org-name@@@product-name. Misalnya: "productIds": ["myorg@@@myproduct", "myorg@@@myproduct2"].

T/A Tidak
pricingTypes

Jenis harga paket tarif yang akan disertakan dalam laporan. Nilai yang valid mencakup:

  • REVSHARE. Rencana pembagian keuntungan.
  • REVSHARE_RATECARD. Paket tarif pembagian keuntungan dan kartu tarif.
  • RATECARD. Paket kartu tarif.

Jika properti ini tidak ditentukan, paket tarif dari semua jenis harga akan disertakan dalam laporan.

T/A Tidak
ratePlanLevels

Jenis paket tarif yang akan disertakan dalam laporan. Nilai yang valid mencakup:

  • DEVELOPER. Paket tarif developer.
  • STANDARD. Paket tarif standar.

Jika properti ini tidak ditentukan, paket tarif khusus developer dan standar akan disertakan dalam laporan.

T/A Tidak
showRevSharePct

Flag yang menentukan apakah laporan menampilkan persentase pembagian keuntungan. Nilai yang valid mencakup:

  • true. Menampilkan persentase pembagian keuntungan.
  • false. Jangan tampilkan persentase pembagian keuntungan.
T/A Tidak
showSummary

Tanda yang menentukan apakah laporan adalah ringkasan. Nilai yang valid mencakup:

  • true. Laporan adalah ringkasan.
  • false. Laporan bukan ringkasan.
T/A Tidak
showTxDetail

Catatan: Properti ini hanya berlaku untuk laporan pendapatan.

Tanda yang menentukan apakah laporan menampilkan detail tingkat transaksi. Nilai yang valid mencakup:

  • true. Tampilkan detail tingkat transaksi.
  • false. Jangan menampilkan detail tingkat transaksi.
T/A Tidak
showTxType

Flag yang menentukan apakah laporan menampilkan jenis setiap transaksi. Nilai yang valid mencakup:

  • true. Tampilkan jenis setiap transaksi.
  • false. Jangan tampilkan jenis setiap transaksi.
T/A Tidak
toDate

Catatan: Properti ini hanya berlaku untuk laporan pendapatan, varians, dan aktivitas transaksi.

Tanggal akhir laporan dalam UTC.

Laporan ini menyertakan data yang dikumpulkan hingga akhir hari sebelum tanggal yang ditentukan. Data laporan yang dikumpulkan pada tanggal akhir yang ditentukan akan dikecualikan dari laporan. Jika Anda ingin mengakhiri paket tarif pada 31 Desember 2016, misalnya, Anda harus menetapkan nilai toDate ke 2017-01-01. Dalam hal ini, laporan akan menyertakan data laporan hingga akhir hari pada 31 Desember 2016; data laporan pada 1 Januari 2017 akan dikecualikan.

T/A Wajib diisi untuk laporan pendapatan; tidak wajib diisi untuk jenis laporan lainnya.
transactionStatus

Status transaksi yang akan disertakan dalam laporan. Nilai yang valid mencakup:

  • SUCCESS. Transaksi berhasil.
  • DUPLICATE. Transaksi duplikat. Transaksi ini dapat diabaikan. Pipeline data dari runtime Apigee ke server penilaian terkadang menghasilkan transaksi duplikat agar toleran terhadap kesalahan dan monetisasi mengenali serta menandainya sebagai duplikat.
  • FAILED. Transaksi gagal. Status ini dipicu saat validasi prasyarat gagal. Contoh:
    • Rating dicoba meskipun developer belum membeli paket tarif. Hal ini dapat terjadi jika kebijakan Pemeriksaan Batas Monetisasi tidak dikonfigurasi.
    • Kuota terlampaui, tetapi panggilan masih berlanjut. Hal ini dapat terjadi jika kebijakan Pemeriksaan Batas Monetisasi tidak dikonfigurasi.
    • Nilai atribut kustom negatif dikirim untuk paket berbasis atribut kustom.
  • INVALID_TSC. Transaksi tidak valid. Status ini dipicu saat kriteria runtime txProviderStatus tidak cocok dengan kriteria keberhasilan yang ditentukan di tingkat paket produk API.
  • REVIEW. Transaksi yang memerlukan peninjauan. Status ini dipicu untuk paket tarif pembagian keuntungan fleksibel jika nilai berada dalam rentang pendapatan yang tidak dikonfigurasi.
T/A Tidak
transactionCustomAttributes

Atribut transaksi kustom yang akan disertakan dalam laporan pendapatan ringkasan. Anda harus mengaktifkan fitur ini di organisasi Anda. Lihat Menyertakan atribut transaksi kustom dalam laporan ringkasan pendapatan.

T/A Tidak
transactionTypes

Jenis transaksi yang akan disertakan dalam laporan. Nilai yang valid mencakup:

Jika properti ini tidak ditentukan, semua jenis transaksi akan disertakan dalam laporan.

T/A Tidak