Skema POST
Permintaan POST yang dikirim ke webhook akan dalam format JSON dengan skema berikut:
Payload Proto webhook
// 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;
// Asset group id represents the container for holding assets, associated
// urls, hints and criteria that will be used to select assets and for
// optimization. This field is only populated for Performance Max campaigns.
int64 asset_group_id = 11;
}
Deskripsi kolom
| Kolom | Deskripsi | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
lead_id |
String unik yang mengidentifikasi prospek tertentu.
Menangani rekomendasi: Gunakan ini untuk menghapus duplikat prospek yang diterima. ID ini akan unik di semua formulir. Saat melaporkan masalah yang terkait dengan prospek tertentu, ID ini akan diperlukan. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_version |
Versi API tempat skema prospek ini berada. Ini akan digunakan saat 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
lampiran formulir dengan tingkat kampanye (vs. lampiran di tingkat grup iklan atau iklan
itu sendiri).
Implikasi: Prospek hanya dapat dikelompokkan di tingkat Klien harus menggunakan bilangan bulat 8 byte untuk diproses. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id |
ID kampanye Google Ads atau ID item baris (Display & Video 360) dari
formulir prospek yang dilampirkan.
Klien harus menggunakan bilangan bulat 8 byte untuk diproses. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 harus menggunakan bilangan bulat 8 byte untuk diproses. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 harus menggunakan bilangan bulat 8 byte untuk diproses. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id |
ID klik Google, parameter unik yang digunakan untuk melacak setiap klik iklan. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key |
Kunci yang dikonfigurasi oleh pengiklan dengan setiap formulir.
Rekomendasi penanganan: Sebelum memproses prospek yang diterima melalui
webhook, memvalidasi |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test |
Kolom ini memiliki semantik "opsional". Jika nilainya benar, perlakukan prospek ini sebagai prospek pengujian. Jika nilainya salah atau jika kolom tidak ada, anggap prospek ini sebagai prospek produksi yang valid. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
Tupel nilai kunci berulang yang mengirimkan data yang dikirimkan pengguna.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
asset_group_id |
Kolom ini hanya diisi untuk kampanye Performa Maksimal.
Ini menunjukkan ID penampung yang berisi formulir prospek.
Klien harus menggunakan bilangan bulat 8 byte untuk diproses. |
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: Free form error text, describing what was wrong with request"} | Tidak |
5XX |
{"message: Intermittent retraible error optional message"} | Ya |
Duplikat
Satu prospek tidak dijamin akan dikirim tepat satu kali, sehingga webhook penanganan prospek harus menangani duplikat dengan baik.