Mengumpulkan data kustom dengan kebijakan DataCapture

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Baca 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 dijelaskan di bagian berikut:

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

Catatan:Jika Anda memiliki organisasi Apigee dengan penagihan Pay-as-you-go, Anda harus mengaktifkan add-on Analytics Apigee API agar dapat menggunakan kebijakan ini. Untuk informasi selengkapnya, lihat Mengelola add-on Analytics Apigee API.

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

Membuat resource REST Data Collector

Untuk menggunakan kebijakan DataCapture, Anda harus membuat resource REST Data Collector 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 Data Collector harus diawali dengan awalan dc_.
• Jika Anda menggunakan Kolektor Data di beberapa kebijakan, data yang direkam akan ditimpa oleh kebijakan terakhir yang dijalankan.

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

Menentukan data yang akan dikumpulkan

Anda dapat menentukan data yang akan dikumpulkan menggunakan elemen <Collect> kebijakan DataCapture. Ada beberapa cara untuk melakukannya, seperti yang ditunjukkan di bagian 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 dapat mengumpulkan data yang dimasukkan pelanggan di formulir halaman web menggunakan variabel alur message.formparam.param_name.values, dengan param_name adalah nama parameter dalam formulir. Misalkan formulir memiliki parameter bernama payment_amount. Variabel alur yang sesuai akan menjadi message.formparam.payment_amount.values.

Kode berikut menentukan variabel ini menurut 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 ke 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 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 Data Collector yang Anda buat untuk DataCapture—misalnya, dc_my_custom_data—seperti yang ditunjukkan di bawah ini.

Anda juga dapat menggunakan variabel yang sama seperti dimensi dalam laporan kustom. Karena dimensi mengelompokkan data berdasarkan nilai variabel, biasanya lebih disarankan jika variabel tersebut adalah string yang hanya berisi sejumlah nilai yang terbatas.