Skema POST
Permintaan POST yang dikirim ke webhook akan memiliki format JSON dengan skema berikut:
Payload Webhook Proto
// Represent user lead data for single column
message UserLeadColumnData {
// Human-readable text of the field type (e.g.: Full Name, What is your
// preferred dealership?). This field might not always be populated.
optional string column_name = 1;
// Column value based on column type
oneof column_value {
string string_value = 2;
}
// Column id. Populated for all types of fields. (e.g.: FULL_NAME)
optional string column_id = 3;
}
// Message to construct webhook JSON payload
message WebhookLead {
// Unique id to represent lead
optional string lead_id = 1;
// User inputted data per column
repeated UserLeadColumnData user_column_data = 2;
// API version
optional string api_version = 3;
// Form id to which lead belonged to.
optional int64 form_id = 4;
// Campaign id that the lead form is associated with
optional int64 campaign_id = 5;
// Key to be used by advertiser to verify the request
// is from Google.
optional string google_key = 6;
// Denotes if the lead is a test lead.
optional bool is_test = 7;
// Click ID for the lead submission.
optional string gcl_id = 8;
// Adgroup id which generated the lead.
optional int64 adgroup_id = 9;
// Creative id which generated the lead.
optional int64 creative_id = 10;
}
Deskripsi kolom
| Kolom | Deskripsi | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
lead_id |
String unik yang mengidentifikasi prospek tertentu.
Penanganan rekomendasi: Gunakan ini untuk menghapus duplikat prospek yang diterima. Kolom ini akan unik di semua formulir. Saat melaporkan masalah yang terkait dengan prospek tertentu, ID ini akan diperlukan. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_version |
Versi API yang mencakup skema prospek ini. Ini akan digunakan ketika bermigrasi ke skema baru, dan dapat diabaikan untuk saat ini. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
form_id |
ID unik untuk setiap formulir yang dikonfigurasi di Google Ads. Produk saat ini memungkinkan
penyertaan formulir dengan tingkat kampanye (vs. melampirkan di tingkat grup iklan atau
iklan).
Implikasi: Prospek hanya dapat dikelompokkan pada tingkat Klien perlu menggunakan bilangan bulat 8 byte untuk memproses. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id |
ID kampanye Google Ads atau ID item baris (Display & Video 360) dari
formulir prospek yang terlampir.
Klien perlu menggunakan bilangan bulat 8 byte untuk memproses. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adgroup_id |
ID grup iklan Google Ads digunakan untuk membedakan grup iklan
tertentu dalam kampanye. (Hanya tersedia untuk prospek dari iklan video dan
discovery)
Klien perlu menggunakan bilangan bulat 8 byte untuk memproses. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id |
ID materi iklan Google Ads digunakan untuk membedakan materi iklan
tertentu dalam grup iklan. (Hanya tersedia untuk prospek dari iklan video dan
discovery)
Klien perlu menggunakan bilangan bulat 8 byte untuk memproses. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id |
ID klik Google, parameter unik yang digunakan untuk melacak setiap klik iklan. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key |
Kunci yang dikonfigurasi oleh pengiklan dengan setiap formulir.
Menangani rekomendasi: Sebelum memproses prospek yang diterima melalui webhook, memvalidasi |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test |
Kolom ini memiliki semantik "opsional". Jika nilainya true (benar), perlakukan prospek ini sebagai prospek percobaan. Jika nilainya salah atau jika kolom tidak ada, perlakukan prospek ini sebagai prospek produksi yang valid. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
Tuple nilai kunci berulang yang mengirimkan data yang dikirimkan pengguna.
|
Penanganan prospek
Pengendali prospek harus merespons dengan kode HTTP berikut:
| Respons HTTP | Isi respons (JSON) | Error yang dapat dicoba lagi? |
|---|---|---|
200 |
{} | T/A |
4XX |
{"message: Teks error bentuk bebas, menjelaskan apa yang salah dengan permintaan"} | Tidak |
5XX |
{"message: Intermittent retraible error option"} | Ya |
Duplikat
Satu prospek tidak dijamin akan dikirim tepat satu kali, sehingga webhook penanganan prospek harus menangani duplikat dengan baik.