การใช้งาน

สคีมา POST

คำขอ POST ที่ส่งไปยัง Webhook จะเป็นรูปแบบ JSON ที่มีสคีมาต่อไปนี้

เพย์โหลด 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;
}

คำอธิบายช่อง

ช่อง คำอธิบาย
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 ซึ่งเป็นพารามิเตอร์ที่ไม่ซ้ำกันซึ่งใช้ติดตามการคลิกโฆษณาแต่ละครั้ง
google_key คีย์ที่ผู้ลงโฆษณากําหนดค่าไว้กับแบบฟอร์มแต่ละรายการ

คําแนะนําในการจัดการ: ก่อนประมวลผลโอกาสในการขายที่ได้รับผ่าน Webhook การยืนยัน google_key จะเหมือนกับการกําหนดค่าใน Google Ads เพื่อให้มั่นใจมากขึ้นว่าโอกาสในการขายนั้นถูกต้อง เก็บรักษาคีย์นี้ไว้เป็นความลับและอัปเดตใน Google Ads หากมีเหตุผลที่เชื่อว่าคีย์นี้รั่วไหลออกไปแล้ว

is_test ฟิลด์นี้มีความหมายเป็น "ไม่บังคับ" หากค่าเป็น "จริง" ให้ถือว่าโอกาสในการขายนี้เป็นโอกาสในการขายทดสอบ หากค่าเป็นเท็จหรือไม่มีฟิลด์ ให้ถือว่าโอกาสในการขายนี้เป็นโอกาสในการขายเวอร์ชันที่ใช้งานจริงที่ถูกต้อง
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" "โทรศัพท์ของผู้ใช้"
"POSTAL_CODE" รหัสไปรษณีย์ของผู้ใช้ "รหัสไปรษณีย์"
"COMPANY_NAME" ชื่อบริษัทของผู้ใช้ "ชื่อบริษัท"
"JOB_TITLE" ตำแหน่งงานของผู้ใช้ "ชื่องาน"
"WORK_EMAIL" อีเมลงานของผู้ใช้ "อีเมลงาน"
"WORK_PHONE" โทรศัพท์ที่ทำงานของผู้ใช้ "โทรศัพท์งาน"
"STREET_ADDRESS" ที่อยู่ของผู้ใช้ "ที่อยู่"
"CITY" เมืองของผู้ใช้ "เมือง"
"REGION" ภูมิภาคของผู้ใช้ "ภูมิภาค"
"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" คุณสนใจบริการใด ไม่มี
"OFFER" คุณสนใจข้อเสนอใด ไม่มี
"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" คุณสนใจที่จะช็อปปิ้งที่ไหน ไม่มี
"FAVORITE_BRAND" คุณชอบแบรนด์ไหนมากที่สุด ไม่มี
"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" คุณต้องการพักที่ใดในระหว่างการเดินทาง ไม่มี
asset_group_id ระบบจะป้อนข้อมูลในช่องนี้สําหรับแคมเปญ Performance Max เท่านั้น ข้อมูลนี้ระบุรหัสคอนเทนเนอร์ที่มีโฆษณาแบบกรอกฟอร์ม

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

การจัดการโอกาสในการขาย

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

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

รายการซ้ำ

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