Giản đồ POST
Yêu cầu POST được gửi đến webhook sẽ ở định dạng JSON với giản đồ sau:
Tải trọng 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;
}
Nội dung mô tả trường
| Trường | Nội dung mô tả | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
lead_id |
Chuỗi duy nhất xác định một khách hàng tiềm năng nhất định.
Xử lý đề xuất: Sử dụng đề xuất này để loại bỏ khách hàng tiềm năng mà hệ thống đã nhận được. Tên này sẽ là duy nhất trên tất cả các biểu mẫu. Khi báo cáo vấn đề liên quan đến một khách hàng tiềm năng cụ thể, bạn bắt buộc phải cung cấp mã này. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_version |
Phiên bản API chứa giản đồ khách hàng tiềm năng này. Thuộc tính này sẽ được dùng khi di chuyển sang một giản đồ mới và hiện tại có thể bị bỏ qua. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
form_id |
Mã nhận dạng duy nhất cho mỗi biểu mẫu được thiết lập trong Google Ads. Sản phẩm hiện tại cho phép
đính kèm biểu mẫu ở cấp chiến dịch (so với đính kèm ở cấp nhóm quảng cáo hoặc
quảng cáo).
Ý nghĩa: Bạn chỉ có thể chia khách hàng tiềm năng ở cấp Ứng dụng cần sử dụng số nguyên 8 byte để xử lý. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id |
Mã chiến dịch trên Google Ads hoặc mã mục hàng (Display & Video 360) của
biểu mẫu khách hàng tiềm năng đính kèm.
Ứng dụng cần sử dụng số nguyên 8 byte để xử lý. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adgroup_id |
Mã nhóm quảng cáo trên Google Ads được dùng để phân biệt nhóm quảng cáo
cụ thể trong chiến dịch. (Chỉ dành cho khách hàng tiềm năng từ quảng cáo
video và quảng cáo khám phá)
Ứng dụng cần sử dụng số nguyên 8 byte để xử lý. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id |
Mã mẫu quảng cáo trên Google Ads được dùng để phân biệt mẫu quảng cáo
cụ thể trong nhóm quảng cáo. (Chỉ dành cho khách hàng tiềm năng từ quảng cáo
video và quảng cáo khám phá)
Ứng dụng cần sử dụng số nguyên 8 byte để xử lý. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id |
Mã lượt nhấp của Google, một thông số riêng biệt dùng để theo dõi mỗi lượt nhấp vào một quảng cáo. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key |
Khoá do nhà quảng cáo định cấu hình với mỗi biểu mẫu.
Đề xuất về cách xử lý: Trước khi xử lý một khách hàng tiềm năng đã nhận được qua
webhook, việc xác thực |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test |
Trường này có ngữ nghĩa "không bắt buộc". Nếu giá trị là đúng, hãy coi khách hàng tiềm năng này là khách hàng tiềm năng thử nghiệm. Nếu giá trị là sai hoặc nếu không có trường, hãy coi khách hàng tiềm năng này là khách hàng tiềm năng hợp lệ. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
Một bộ dữ liệu khoá-giá trị lặp lại truyền dữ liệu do người dùng gửi.
|
Xử lý khách hàng tiềm năng
Trình xử lý khách hàng tiềm năng phải phản hồi bằng mã HTTP sau đây:
| Phản hồi HTTP | Nội dung phản hồi (JSON) | Lỗi có thể thử lại? |
|---|---|---|
200 |
{} | Không áp dụng |
4XX |
{"message: Văn bản lỗi dạng tự do, mô tả những gì đã xảy ra với yêu cầu"} | Không |
5XX |
{"message: Thông báo lỗi lặp lại gián đoạn không bắt buộc"} | Có |
Bài hát trùng lặp
Một khách hàng tiềm năng duy nhất không được đảm bảo được phân phối chính xác một lần, do đó, webhook xử lý khách hàng tiềm năng phải xử lý các trường hợp trùng lặp một cách linh hoạt.