Giản đồ POST
Yêu cầu POST được gửi tới webhook sẽ ở định dạng JSON với các yêu cầu sau giản đồ:
Tải trọng 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;
}
Phần mô tả về trường
| Trường | 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.
Đề xuất xử lý: Sử dụng đề xuất này để loại bỏ những khách hàng tiềm năng trùng lặp đã nhận được. Thông tin này sẽ là duy nhất trên tất cả biểu mẫu. Khi báo cáo các vấn đề liên quan đến một khách hàng tiềm năng cụ thể, thì bạn sẽ 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. Thông tin này sẽ được dùng khi chuyển sang một giản đồ mới và tạm thờ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 với 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
cấp độ).
Ý nghĩa: Bạn chỉ có thể phân chia khách hàng tiềm năng ở Ứng dụng cần 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 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 trong chiến dịch. (Dành cho khách hàng tiềm năng từ video và chiến dịch khám phá
chỉ quảng cáo)
Ứng dụng cần dùng số nguyên 8 byte để xử lý. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id |
Mã mẫu quảng cáo của Google Ads được dùng để phân biệt
mẫu quảng cáo trong nhóm quảng cáo. (Dành cho khách hàng tiềm năng từ video và chiến dịch khám phá
chỉ quảng cáo)
Ứng dụng cần dùng số nguyên 8 byte để xử lý. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id |
Lượt nhấp của Google ID, một thông số duy nhất dùng để theo dõi mỗi lượt nhấp vào quảng cáo. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key |
Khoá do nhà quảng cáo thiết lập theo từng biểu mẫu.
Xử lý đề xuất: Trước khi xử lý một khách hàng tiềm năng đã nhận được
webhook, việc xác thực |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test |
Trường này có từ "không bắt buộc" ngữ nghĩa. Nếu giá trị là true, hãy xử lý trở thành khách hàng tiềm năng thử nghiệm. Nếu giá trị là false hoặc nếu không có trường này, hãy xử lý khách hàng tiềm năng này là trưởng nhóm sản xuất hợp lệ. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
Một bộ khoá-giá trị lặp lại đang 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 cần phản hồi bằng các 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 biểu mẫu tuỳ ý, mô tả vấn đề đã xảy ra với yêu cầu"} | Không |
5XX |
{"message: thông báo không bắt buộc về lỗi gián đoạn có thể đọc lại"} | Có |
Liên hệ trùng lặp
Không thể đảm bảo chỉ phân phối đúng một khách hàng tiềm năng một lần, do đó, khách hàng tiềm năng việc xử lý webhook sẽ xử lý các bản sao trùng lặp một cách linh hoạt.