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 kebijakan DataCapture. Ada dua langkah utama yang diperlukan, seperti yang dijelaskan di bagian berikut:

1. Buat resource REST Pengumpul Data.
2. Tentukan data yang ingin Anda kumpulkan menggunakan elemen <Collect> kebijakan DataCapture.

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

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

Membuat resource REST Pengumpul Data

Untuk menggunakan kebijakan DataCapture, Anda harus membuat resource REST Pengumpul Data terlebih dahulu. 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 dengan kebijakan DataCapture.

Catatan:

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

Peringatan: Jangan membuat dua pengumpul data yang namanya hanya berbeda berdasarkan huruf besar/kecil, seperti dc_my_data dan dc_My_Data, karena mengekspor data akan menghasilkan error "nama kolom duplikat".

Tentukan data yang akan dikumpulkan

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

Kode berikut menentukan variabel ini dengan 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 di kolom payment_amount formulir akan 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 tersebut untuk membuat laporan kustom dengan prosedur yang dijelaskan dalam Menambahkan laporan kustom. Untuk melakukannya, saat Anda memilih metrik untuk laporan, seperti yang ditunjukkan pada langkah 4 prosedur, pilih variabel yang memiliki nama yang sama dengan resource REST Pengumpul Data yang Anda buat untuk DataCapture—misalnya, dc_my_custom_data.

Anda juga dapat menggunakan variabel yang sama sebagai dimensi dalam laporan kustom. Karena dimensi mengelompokkan data menurut nilai variabel, biasanya lebih baik jika variabel berupa string yang hanya memiliki sejumlah nilai terbatas.