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;
// 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;
}
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ỏ trùng lặp khách hàng tiềm năng đã nhận được. Mã 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ể, bạn sẽ phải cung cấp mã khách hàng tiềm năng này. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_version |
Phiên bản API mà giản đồ khách hàng tiềm năng này thuộc về. Giá trị này sẽ được dùng khi di chuyển sang giản đồ mới và hiện có thể bỏ qua. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
form_id |
Mã nhận dạng duy nhất cho mỗi biểu mẫu được định cấu hình 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 (thay vì đính kèm ở cấp nhóm quảng cáo hoặc cấp quảng cáo).
Hậu quả: Bạn chỉ có thể phân đoạn 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 hoặc mã mục hàng trên Google Ads (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ận dạng 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 khám phá và quảng cáo dạng video)
Ứ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 khám phá và quảng cáo dạng video)
Ứ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 tham số duy nhất dùng để theo dõi từng lượt nhấp vào quảng cáo. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key |
Khoá do nhà quảng cáo định cấu hình cho từng biểu mẫu.
Đề xuất xử lý: Trước khi xử lý 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à true, 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 này, hãy coi khách hàng tiềm năng này là khách hàng tiềm năng sản xuất hợp lệ. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
Một cặp khoá-giá trị lặp lại truyền dữ liệu do người dùng gửi.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
asset_group_id |
Trường này chỉ được điền cho chiến dịch Tối đa hoá hiệu suất.
Mã này biểu thị mã nhận dạng vùng chứa chứa biểu mẫu khách hàng tiềm năng.
Ứng dụng cần sử dụng số nguyên 8 byte để xử lý. |
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 các mã HTTP sau:
| 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ả lỗi xảy ra với yêu cầu"} | Không |
5XX |
{"message: Intermittent retraible error optional message"} | Có |
Liên hệ trùng lặp
Không đảm bảo một khách hàng tiềm năng sẽ được phân phối đúng một lần, do đó, webhook xử lý khách hàng tiềm năng phải xử lý các khách hàng tiềm năng trùng lặp một cách linh hoạt.