สคีมา 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 ผลิตภัณฑ์ปัจจุบันอนุญาตให้แนบแบบฟอร์มที่มีระดับแคมเปญ (เทียบกับการแนบที่ระดับกลุ่มโฆษณาหรือโฆษณา)
ผลกระทบ: โอกาสในการขายแบ่งย่อยได้ที่ระดับ form_id
เท่านั้น (ที่ระดับแคมเปญ)
ไคลเอ็นต์ต้องใช้จำนวนเต็ม 8 ไบต์เพื่อประมวลผล
campaign_id
รหัสแคมเปญ Google Ads หรือรหัสรายการโฆษณา (Display & Video 360) ของ
โฆษณาแบบกรอกฟอร์มที่แนบมา
ไคลเอ็นต์ต้องใช้จำนวนเต็ม 8 ไบต์เพื่อประมวลผล
adgroup_id
รหัสกลุ่มโฆษณา Google Ads ใช้เพื่อแยกแยะกลุ่มโฆษณา
เฉพาะเจาะจงในแคมเปญ (ใช้ได้สำหรับโอกาสในการขายจากโฆษณาวิดีโอและ Discovery เท่านั้น)
ไคลเอ็นต์ต้องใช้จำนวนเต็ม 8 ไบต์เพื่อประมวลผล
creative_id
รหัสครีเอทีฟโฆษณา Google Ads ใช้เพื่อแยกแยะครีเอทีฟโฆษณา
ที่ต้องการในกลุ่มโฆษณา (ใช้ได้สำหรับโอกาสในการขายจากโฆษณาวิดีโอและ Discovery เท่านั้น)
ไคลเอ็นต์ต้องใช้จำนวนเต็ม 8 ไบต์เพื่อประมวลผล
gcl_id
Google Click ID พารามิเตอร์ที่ไม่ซ้ำที่ใช้ในการติดตามการคลิกโฆษณาแต่ละครั้ง
google_key
คีย์ที่กำหนดค่าโดยผู้ลงโฆษณาพร้อมแต่ละแบบฟอร์ม
คําแนะนําในการจัดการ: ก่อนประมวลผลโอกาสในการขายที่ได้รับผ่านเว็บฮุค การตรวจสอบ google_key
จะเหมือนกับการกําหนดค่าใน Google Ads เพื่อให้มั่นใจได้มากขึ้นว่าโอกาสในการขายนั้นถูกต้อง โปรดเก็บคีย์นี้เป็นความลับและอัปเดตใน Google Ads หากมีเหตุผลให้เชื่อว่าข้อมูลนี้รั่วไหลในวงกว้าง
is_test
ช่องนี้มีความหมาย "ไม่บังคับ" หากค่าเป็นจริง ให้ถือว่าโอกาสในการขายนี้เป็นโอกาสในการขายทดสอบ หากค่าเป็น false หรือไม่มีช่องอยู่ ให้ถือว่าโอกาสในการขายนี้เป็นโอกาสในการขายที่ใช้งานจริงที่ถูกต้อง
user_column_data
คีย์-ค่าที่ซ้ำกันซึ่งส่งข้อมูลที่ผู้ใช้ส่ง
user_column_data.column_id
: ประเภทข้อมูลที่ผู้ใช้ส่ง
User_column_data.column_value
: ระบบจะป้อนข้อมูลประเภทค่าสําหรับข้อมูลแต่ละประเภทโดยอิงตามประเภทข้อมูล ประเภทข้อมูลในปัจจุบันทั้งหมดมีค่าเป็น user_column_data.string_value
user_column_data.column_name
: ข้อความประเภทข้อมูลที่มนุษย์อ่านได้ที่ผู้ใช้ส่ง ช่องนี้อาจไม่ได้ป้อนข้อมูลเสมอไป ให้ใช้ column_id
แทน
user_column_data.column_id
เนื้อหา User_column_data.string_value
user_column_data.column_name (เลิกใช้งานแล้ว)
"FULL_NAME"
ชื่อเต็มของผู้ใช้
"ชื่อเต็ม"
"FIRST_NAME"
ชื่อจริงของผู้ใช้
"ชื่อ"
"LAST_NAME"
นามสกุลผู้ใช้
"นามสกุล"
"EMAIL"
อีเมลผู้ใช้
"อีเมลผู้ใช้"
"PHONE_NUMBER"
หมายเลขโทรศัพท์ของผู้ใช้ในรูปแบบ E.164 เช่น "+11234567890"
.
"โทรศัพท์ของผู้ใช้"
"รหัสไปรษณีย์"
รหัสไปรษณีย์ของผู้ใช้
"รหัสไปรษณีย์"
"บริษัท_NAME"
ชื่อบริษัทของผู้ใช้
"ชื่อบริษัท"
"JOB_TITLE"
ตำแหน่งงานของผู้ใช้
"ตำแหน่งงาน"
"WORK_EMAIL"
อีเมลที่ทำงานของผู้ใช้
"อีเมลที่ทำงาน"
"โทรศัพท์ที่ทำงาน"
โทรศัพท์ที่ทำงานของผู้ใช้
"โทรศัพท์ที่ทำงาน"
"STREET_ADDRESS"
ที่อยู่ของผู้ใช้
"ที่อยู่"
"CITY"
เมืองของผู้ใช้
"เมือง"
"ภูมิภาค"
ภูมิภาคของผู้ใช้
"ภูมิภาค"
"COUNTRY"
ประเทศของผู้ใช้
"ประเทศ"
"รุ่น VEHICLE_MODEL"
คุณสนใจรถรุ่นไหน
ไม่มีข้อมูล
"ประเภทยานพาหนะ"
คุณสนใจรถประเภทไหน
ไม่มีข้อมูล
"PREFERRED_DEALERSHIP"
เลือกตัวแทนจำหน่ายที่ต้องการ
ไม่มีข้อมูล
"VEHICLE_PURCHASE_TIMELINE"
คุณวางแผนจะซื้อรถเมื่อใด
ไม่มีข้อมูล
"VEHICLE_CONDITION"
คุณสนใจรถสภาพใด
ไม่มีข้อมูล
"VEHICLE_OWNERSHIP"
คุณมีรถหรือไม่
"ไม่มี"
"VEHICLE_PAYMENT_TYPE"
คุณสนใจที่จะซื้อรถด้วยวิธีใด
ไม่มีข้อมูล
"ขนาด COMPANY_SIZE"
บริษัทของคุณมีขนาดเท่าใด
ไม่มีข้อมูล
ยอดขาย "ANNUAL_SALES"
คุณมียอดขายต่อปีเท่าไร
ไม่มีข้อมูล
"YEARS_IN_BUSINESS"
คุณทำงานในสายธุรกิจนี้มาแล้วกี่ปี
ไม่มีข้อมูล
"JOB_DEPARTMENT"
คุณทำงานในแผนกใด
ไม่มีข้อมูล
"JOB_ROLE"
คุณทำงานในตำแหน่งใด
ไม่มีข้อมูล
"EDUCATION_PROGRAM"
คุณสนใจโปรแกรมใด
ไม่มีข้อมูล
"EDUCATION_COURSE"
คุณสนใจหลักสูตรไหน
ไม่มีข้อมูล
"PRODUCT"
คุณสนใจผลิตภัณฑ์ใด
ไม่มีข้อมูล
"บริการ"
คุณสนใจบริการใด
ไม่มีข้อมูล
"ข้อเสนอ"
คุณสนใจข้อเสนอใด
ไม่มีข้อมูล
"CATEGORY"
คุณสนใจหมวดหมู่ใด
ไม่มีข้อมูล
"PREFERRED_CONTACT_METHOD"
เลือกวิธีการติดต่อที่ต้องการ
ไม่มีข้อมูล
"PREFERRED_LOCATION"
เลือกสถานที่ที่ต้องการ
ไม่มีข้อมูล
"PREFERRED_CONTACT_TIME"
เวลาที่คุณสะดวกให้ติดต่อได้คือช่วงใด
ไม่มีข้อมูล
"PURCHASE_TIMELINE"
ปกติคุณจะหาซื้อสินค้าเมื่อใด
ไม่มีข้อมูล
"YEARS_OF_EXPERIENCE"
คุณมีประสบการณ์ในการทำงานมานานกี่ปี
ไม่มีข้อมูล
"งานอุตสาหกรรม"
คุณทำงานอยู่ในธุรกิจประเภทใด
ไม่มีข้อมูล
"LEVEL_OF_EDUCATION"
คุณจบการศึกษาสูงสุดในระดับใด
ไม่มีข้อมูล
"PROPERTY_TYPE"
คุณกำลังมองหาที่พักอาศัยประเภทใด
ไม่มีข้อมูล
"REALTOR_HELP_GOAL"
คุณต้องการความช่วยเหลือจากนายหน้าในเรื่องใด
ไม่มีข้อมูล
"PROPERTY_COMMUNITY"
คุณสนใจชุมชนใด
ไม่มีข้อมูล
"PRICE_RANGE"
คุณกำลังมองหาช่วงราคาใด
ไม่มีข้อมูล
"NUMBER_OF_BEDROOMS"
คุณกำลังมองหาที่อยู่ที่มีกี่ห้องนอน
ไม่มีข้อมูล
"FURNISHED_PROPERTY"
คุณกำลังมองหาที่พักอาศัยซึ่งตกแต่งครบพร้อมเข้าอยู่ใช่ไหม
ไม่มีข้อมูล
"PETS_ALLOWED_PROPERTY"
คุณกำลังหาที่พักอาศัยที่อนุญาตให้เลี้ยงสัตว์ได้ใช่ไหม
ไม่มีข้อมูล
"NEXT_PLANNED_PURCHASE"
คุณวางแผนจะซื้อผลิตภัณฑ์ใดต่อไป
ไม่มีข้อมูล
"EVENT_SIGNUP_INTEREST"
คุณต้องการลงชื่อเข้าร่วมกิจกรรมไหม
ไม่มีข้อมูล
"PREFERRED_SHOPPING_PLACES"
คุณสนใจที่จะช็อปปิ้งที่ไหน
ไม่มีข้อมูล
"แบรนด์โปรด"
คุณชอบแบรนด์ไหนมากที่สุด
ไม่มีข้อมูล
"TRANSPORTATION_COMMERCIAL_ LICENSE_TYPE"
คุณมีทะเบียนพาณิชย์ประเภทใด
ไม่มีข้อมูล
"EVENT_BOOKING_INTEREST"
คุณสนใจที่จะจองเพื่อเข้าร่วมกิจกรรมไหม
ไม่มีข้อมูล
"DESTINATION_COUNTRY"
จุดหมายของคุณคือประเทศใด
ไม่มีข้อมูล
เมืองปลายทาง
จุดหมายของคุณคือเมืองใด
ไม่มีข้อมูล
"DEPARTURE_COUNTRY"
คุณออกเดินทางจากประเทศใด
ไม่มีข้อมูล
"DEPARTURE_CITY"
คุณออกเดินทางจากเมืองใด
ไม่มีข้อมูล
DATE_DATE
คุณออกเดินทางวันที่เท่าไหร่
ไม่มีข้อมูล
"RETURN_DATE"
คุณจะเดินทางกลับวันที่เท่าไหร่
ไม่มีข้อมูล
"NUMBER_OF_TRAVELERS"
คุณมีผู้ร่วมเดินทางกี่คน
ไม่มีข้อมูล
"TRAVEL_BUDGET"
คุณมีงบประมาณการท่องเที่ยวเท่าใด
ไม่มีข้อมูล
"TRAVEL_ACCOMMODATION"
คุณต้องการพักที่ใดในระหว่างการเดินทาง
ไม่มีข้อมูล
การจัดการผู้มีโอกาสเป็นลูกค้า
ตัวแฮนเดิลโอกาสในการขายควรตอบกลับด้วยรหัส HTTP ต่อไปนี้
การตอบกลับ HTTP
เนื้อหาการตอบกลับ (JSON)
เกิดข้อผิดพลาดซ้ำไหม
200
{}
ไม่มีข้อมูล
4XX
{"message: ข้อความแสดงข้อผิดพลาดของรูปแบบอิสระ อธิบายสิ่งที่ผิดปกติเกี่ยวกับคำขอ"}
ไม่ได้
5XX
{"message: Interentialt retraible error relevant message"}
มี
เพลงซ้ำ
เราไม่รับประกันว่าจะมีการส่งโอกาสในการขายเดียวเพียงครั้งเดียว ดังนั้นเว็บฮุคที่ใช้จัดการผู้มีโอกาสเป็นลูกค้าจึงควรจัดการกับข้อมูลที่ซ้ำกันได้อย่างราบรื่น
ประเด็นหลัก: ใช้ lead_id
เพื่อกำจัดโอกาสในการขายออก