Mengumpulkan data kustom dengan kebijakan DataCapture

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat Dokumentasi Apigee Edge.

Selain data API biasa yang dikumpulkan oleh Apigee, Anda juga dapat mengumpulkan data kustom menggunakan DataCapture lebih lanjut. Ada dua langkah utama yang diperlukan, seperti yang dijelaskan di bagian berikut:

1. Membuat resource REST Data Collector.
2. Tentukan data yang ingin dikumpulkan menggunakan elemen <Collect> kebijakan DataCapture.

Catatan:Jika Anda memiliki organisasi Apigee dengan penagihan Bayar sesuai penggunaan, Anda harus mengaktifkan add-on Analisis API Apigee untuk menggunakan kebijakan ini. Untuk informasi selengkapnya, lihat Kelola add-on Apigee API Analytics.

Jika tidak yakin apakah Anda menggunakan Apigee Langganan atau Bayar sesuai penggunaan organisasi, hubungi administrator organisasi Apigee Anda.

Membuat resource REST Data Collector

Untuk menggunakan kebijakan DataCapture, Anda harus membuat dahulu Resource REST Data Collector. Untuk melakukannya, kirim permintaan API seperti berikut:

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -X POST -H "content-type:application/json" \
  -d '
{
  "name": "dc_my_custom_data",
  "description": "Collects data for analysis.",
  "type": "STRING",
}' \
  "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/datacollectors"

Tindakan ini akan membuat resource bernama dc_my_custom_data, yang dapat Anda gunakan bersama kebijakan DataCapture.

Catatan:

• Nama resource Data Collector harus diawali dengan awalan dc_.
• Jika Anda menggunakan Kolektor Data dalam beberapa kebijakan, data yang diambil akan ditimpa oleh kebijakan terakhir yang dijalankan.

Peringatan: Jangan membuat dua pengumpul data dengan nama yang berbeda hanya per kasus, seperti dc_my_data dan dc_My_Data, seperti halnya mengekspor data akan menghasilkan “nama kolom duplikat” error.

Menentukan data yang akan dikumpulkan

Anda dapat menentukan data yang akan dikumpulkan menggunakan kebijakan DataCapture Elemen <Collect>. Ada berbagai cara untuk melakukannya, seperti yang ditampilkan di Contoh di halaman referensi DataCapure. Salah satu caranya adalah dengan menentukan variabel flow, yang menyimpan data yang diteruskan dalam permintaan dan respons API. Misalnya, Anda bisa mengumpulkan data yang dimasukkan pelanggan dalam formulir halaman web menggunakan alur variabel message.formparam.param_name.values, dengan param_name adalah nama parameter dalam formulir. Misalkan formulir memiliki parameter bernama payment_amount. Variabel aliran yang sesuai akan message.formparam.payment_amount.values.

Kode berikut menentukan variabel ini berdasarkan atribut ref dari elemen <Collect>.

<DataCapture name="capturepayment">
    <Capture>
        <DataCollector>dc_my_custom_data</DataCollector>
        <Collect ref="message.form_param.payment_amount.values" >
    </Capture>
</DataCapture>

Dengan setelan ini, data yang dimasukkan dalam kolom payment_amount formulir akan yang dikumpulkan oleh DataCapture dan disimpan dalam variabel bernama dc_my_custom_data.

Membuat laporan kustom dari data yang dikumpulkan dengan DataCapture

Setelah menyiapkan pengumpulan data dengan kebijakan DataCapture, Anda dapat menggunakan data untuk membuat laporan khusus dengan prosedur yang dijelaskan di Menambahkan laporan kustom. Untuk melakukannya, saat Anda memilih metrik untuk dalam laporan, seperti yang ditunjukkan dalam langkah 4 dari prosedur, pilih variabel yang memiliki nama yang sama dengan Data Collector Resource REST yang Anda buat untuk DataCapture—misalnya, dc_my_custom_data— sebagaimana ditunjukkan di bawah ini.

Anda juga dapat menggunakan variabel yang sama seperti dimensi dalam laporan kustom. Karena dimensi mengelompokkan data berdasarkan nilai variabel, hal itu variabel sebaiknya berupa {i>string<i} yang hanya menggunakan sejumlah kecil masing-masing.