สคีมา POST
คำขอ POST ที่ส่งไปยังเว็บฮุคจะอยู่ในรูปแบบ JSON ดังนี้ สคีมา:
เพย์โหลด 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;
}
คำอธิบายช่อง
ช่อง | คำอธิบาย | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
lead_id |
สตริงที่ไม่ซ้ำกันซึ่งระบุโอกาสในการขายหนึ่งๆ
คำแนะนำในการจัดการ: ใช้เพื่อคัดกรองผู้มีโอกาสเป็นลูกค้าที่ซ้ำกันออก ได้รับ ซึ่งจะไม่ซ้ำกันในทุกรูปแบบ คุณต้องใช้รหัสนี้เมื่อรายงานปัญหาที่เกี่ยวข้องกับโอกาสในการขายที่เฉพาะเจาะจง |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_version |
เวอร์ชัน API ที่มีสคีมาโอกาสในการขายนี้ จะใช้เมื่อ ย้ายข้อมูลไปยังสคีมาใหม่ แต่จะไม่สนใจได้ในตอนนี้ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
form_id |
รหัสที่ไม่ซ้ำกันสำหรับแต่ละแบบฟอร์มที่กำหนดค่าใน Google Ads ผลิตภัณฑ์ปัจจุบันช่วยให้
การแนบฟอร์มที่มีระดับแคมเปญ (เทียบกับการแนบที่กลุ่มโฆษณาหรือโฆษณา
ระดับ)
ผลกระทบ: โอกาสในการขายจะแบ่งออกได้ที่ ไคลเอ็นต์ต้องใช้จำนวนเต็ม 8 ไบต์ในการประมวลผล |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id |
รหัสแคมเปญ Google Ads หรือรหัสรายการโฆษณา (Display &Video 360) ของ
แบบฟอร์มสำหรับรวบรวมข้อมูลลูกค้าที่แนบมา
ไคลเอ็นต์ต้องใช้จำนวนเต็ม 8 ไบต์ในการประมวลผล |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adgroup_id |
รหัสกลุ่มโฆษณา Google Ads จะใช้เพื่อแยก
กลุ่มโฆษณาในแคมเปญ (ใช้ได้กับโอกาสในการขายจากโฆษณาวิดีโอและโฆษณา Discovery เท่านั้น)
ไคลเอ็นต์ต้องใช้จำนวนเต็ม 8 ไบต์ในการประมวลผล |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id |
รหัสโฆษณา Google Ads ใช้เพื่อแยกแยะ
ครีเอทีฟโฆษณาในกลุ่มโฆษณา (ใช้ได้กับโอกาสในการขายจากโฆษณาวิดีโอและโฆษณา Discovery เท่านั้น)
ไคลเอ็นต์ต้องใช้จำนวนเต็ม 8 ไบต์เพื่อประมวลผล |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id |
การคลิกของ Google ID คือพารามิเตอร์ที่ไม่ซ้ำกันซึ่งใช้ติดตามการคลิกโฆษณาแต่ละครั้ง | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key |
คีย์ที่ผู้ลงโฆษณากำหนดค่าไว้ในแบบฟอร์มแต่ละรายการ
คำแนะนำในการจัดการ: ก่อนประมวลผลโอกาสในการขายที่ได้รับ
เว็บฮุค การตรวจสอบ |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test |
ฟิลด์นี้มีความหมายเป็น "ไม่บังคับ" หากค่าเป็น "จริง" ให้ดำเนินการตามนี้ เป็นผู้มีโอกาสเป็นลูกค้าเพื่อทดสอบ หากค่าเป็น "เท็จ" หรือหากไม่มีช่อง ให้ใช้ ให้เป็นผู้มีโอกาสเป็นลูกค้าที่ถูกต้อง | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
Tuple คีย์-ค่าที่ซ้ำกันซึ่งส่งข้อมูลที่ผู้ใช้ส่ง
|
การจัดการผู้มีโอกาสเป็นลูกค้า
แฮนเดิลโอกาสในการขายควรตอบกลับด้วยรหัส HTTP ต่อไปนี้
การตอบกลับ HTTP | เนื้อหาการตอบกลับ (JSON) | เกิดข้อผิดพลาดที่กู้คืนซ้ำได้ใช่ไหม |
---|---|---|
200 |
{} | ไม่มี |
4XX |
{"message: ข้อความแสดงข้อผิดพลาดรูปแบบอิสระ การอธิบายว่าคำขอเกิดข้อผิดพลาดอะไร"} | ไม่ได้ |
5XX |
{"message: ข้อความแสดงข้อผิดพลาดที่ทำซ้ำได้เป็นระยะๆ"} | ใช่ |
รายการซ้ำ
ไม่รับประกันว่าผู้มีโอกาสเป็นลูกค้ารายการเดียวจะได้รับการนำส่งเพียงครั้งเดียว โอกาสในการขายจึงจะได้รับ การจัดการเว็บฮุคควรจัดการกับรายการที่ซ้ำกันได้อย่างสวยงาม