การใช้งาน

สคีมา 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 จะใช้เพื่อแยก กลุ่มโฆษณาในแคมเปญ (ใช้ได้สำหรับโอกาสในการขายจากวิดีโอและการค้นพบ โฆษณาเท่านั้น)

ไคลเอ็นต์ต้องใช้จำนวนเต็ม 8 ไบต์ในการประมวลผล

creative_id รหัสโฆษณา Google Ads ใช้เพื่อแยกแยะ ครีเอทีฟโฆษณาในกลุ่มโฆษณา (ใช้ได้สำหรับโอกาสในการขายจากวิดีโอและการค้นพบ โฆษณาเท่านั้น)

ไคลเอ็นต์ต้องใช้จำนวนเต็ม 8 ไบต์ในการประมวลผล

gcl_id การคลิกของ Google ID คือพารามิเตอร์ที่ไม่ซ้ำกันซึ่งใช้ติดตามการคลิกโฆษณาแต่ละครั้ง
google_key คีย์ที่ผู้ลงโฆษณากำหนดค่าไว้ในแบบฟอร์มแต่ละรายการ

คำแนะนำในการจัดการ: ก่อนประมวลผลโอกาสในการขายที่ได้รับ เว็บฮุค การตรวจสอบ google_key เหมือนกับการกำหนดค่าใน Google Ads เพื่อสร้างความมั่นใจมากขึ้นว่าโอกาสในการขายนั้นถูกต้อง เก็บ คีย์นี้จะเป็นความลับและอัปเดตใน Google Ads หากมีเหตุผลที่จะ เชื่อว่ามีการเผยแพร่ข่าวในวงกว้าง
is_test ช่องนี้มี "ไม่บังคับ" เชิงความหมาย หากค่าเป็น "จริง" ให้ดำเนินการตามนี้ เป็นผู้มีโอกาสเป็นลูกค้าเพื่อทดสอบ หากค่าเป็น "เท็จ" หรือหากไม่มีช่อง ให้ใช้ เป็นผู้มีโอกาสเป็นลูกค้าที่ถูกต้อง
user_column_data Tuple คีย์-ค่าที่ซ้ำกันซึ่งส่งข้อมูลที่ผู้ใช้ส่ง
  • 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" "โทรศัพท์ของผู้ใช้"
"POSTAL_CODE" รหัสไปรษณีย์ของผู้ใช้ "รหัสไปรษณีย์"
"COMPANY_NAME" ชื่อบริษัทของผู้ใช้ "ชื่อบริษัท"
"JOB_TITLE" ตำแหน่งงานของผู้ใช้ "ตำแหน่งงาน"
"WORK_EMAIL" อีเมลที่ทำงานของผู้ใช้ "อีเมลที่ทำงาน"
"WORK_PHONE" หมายเลขโทรศัพท์ที่ทำงานของผู้ใช้ "โทรศัพท์ที่ทำงาน"
"STREET_ADDRESS" ที่อยู่ของผู้ใช้ "ที่อยู่"
"CITY" เมืองของผู้ใช้ "เมือง"
"ภูมิภาค" ภูมิภาคของผู้ใช้ "ภูมิภาค"
"COUNTRY" ประเทศของผู้ใช้ "ประเทศ"
"VEHICLE_MODEL" คุณสนใจรุ่นใด ไม่มี
"VEHICLE_TYPE" คุณสนใจรถประเภทไหน ไม่มี
"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" คุณสนใจผลิตภัณฑ์ใด ไม่มี
"SERVICE" คุณสนใจบริการใด ไม่มี
"ข้อเสนอพิเศษ" คุณสนใจข้อเสนอใด ไม่มี
"CATEGORY" คุณสนใจประเภทใด ไม่มี
"PREFERRED_CONTACT_METHOD" เลือกวิธีการติดต่อที่ต้องการ ไม่มี
"PREFERRED_LOCATION" เลือกสถานที่ที่ต้องการ ไม่มี
"PREFERRED_CONTACT_TIME" เวลาที่คุณสะดวกให้ติดต่อได้คือช่วงใด ไม่มี
"PURCHASE_TIMELINE" ปกติคุณจะหาซื้อสินค้าเมื่อใด ไม่มี
"YEARS_OF_EXPERIENCE" คุณมีประสบการณ์ในการทำงานมานานกี่ปี ไม่มี
"JOB_INDUSTRY" คุณทำงานอยู่ในธุรกิจประเภทใด ไม่มี
"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" ประเทศจุดหมายของคุณคือที่ใด ไม่มี
"DESTINATION_CITY" จุดหมายของคุณคือเมืองใด ไม่มี
"DEPARTURE_COUNTRY" คุณออกเดินทางจากประเทศใด ไม่มี
"DEPARTURE_CITY" คุณออกเดินทางจากเมืองใด ไม่มี
"DEPARTURE_DATE" คุณออกเดินทางวันที่เท่าไหร่ ไม่มี
"RETURN_DATE" คุณจะเดินทางกลับวันที่เท่าใด ไม่มี
"NUMBER_OF_TRAVELERS" คุณมีผู้ร่วมเดินทางกี่คน ไม่มี
"TRAVEL_BUDGET" คุณมีงบประมาณการท่องเที่ยวเท่าใด ไม่มี
"TRAVEL_ACCOMMODATION" คุณต้องการพักที่ใดในระหว่างการเดินทาง ไม่มี

การจัดการผู้มีโอกาสเป็นลูกค้า

ตัวแฮนเดิลโอกาสในการขายควรตอบกลับด้วยโค้ด HTTP ต่อไปนี้

การตอบกลับ HTTP เนื้อหาการตอบกลับ (JSON) เกิดข้อผิดพลาดที่กู้คืนซ้ำได้ใช่ไหม
200 {} ไม่มี
4XX {"message: ข้อความแสดงข้อผิดพลาดรูปแบบอิสระ ซึ่งอธิบายสิ่งที่ไม่ถูกต้องกับคำขอ"} ไม่ได้
5XX {"message: ข้อความแสดงข้อผิดพลาดที่ทำซ้ำได้เป็นระยะๆ"} ใช่

รายการซ้ำ

ไม่รับประกันว่าผู้มีโอกาสเป็นลูกค้ารายการเดียวจะได้รับการนำส่งเพียงครั้งเดียว โอกาสในการขายจึงจะได้รับ การจัดการเว็บฮุคควรจัดการกับรายการที่ซ้ำกันได้อย่างสวยงาม