הטמעה

סכימת POST

בקשת ה-POST שנשלחה ל-webhook תהיה בפורמט JSON עם הסכימה הבאה:

מטען ייעודי (payload) של Webhook Pro

// 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) – פרמטר ייחודי שמשמש למעקב אחר כל קליק על מודעה.
google_key מפתח שהוגדר על ידי המפרסם עם כל טופס.

טיפול בהמלצה: לפני עיבוד של ליד שהתקבל באמצעות תגובה לפעולה מאתר אחר (webhook), אימות google_key זהה להגדרה ב-Google Ads כדי שיהיה לך יותר ביטחון שהליד חוקי. יש לשמור על הסודיות של המפתח הזה ולעדכן אותו ב-Google Ads אם יש סיבה להאמין שהפרטים האלה הודלפו בתפוצה רחבה.

is_test השדה הזה הוא 'אופציונלי'. אם הערך הוא True, אפשר להתייחס לליד הזה כאל ליד לניסיון. אם הערך הוא False או אם השדה לא קיים, יש להתייחס לליד הזה בתור ליד חוקי של סביבת הייצור.
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 content 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' איזה מבצע מעניין אותך? לא רלוונטי
'קטגוריה' איזו קטגוריה מעניינת אותך? לא רלוונטי
'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_HEADING_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' איפה היית רוצה ללון בנסיעה? לא רלוונטי

טיפול בלידים

רכיבי handler של לידים צריכים להגיב עם קודי ה-HTTP הבאים:

תגובת HTTP גוף התגובה (JSON) שגיאה שניתן לשחזר?
200 {} לא רלוונטי
4XX {"message: טקסט שגיאה בטופס חופשי, מתאר מה הייתה הבעיה בבקשה"} לא
5XX {"message: לסירוגין הודעת שגיאה שניתנת לחזרה לסירוגין"} כן

כפילויות

לא בטוח שליד יחיד יישלח פעם אחת בלבד, ולכן צריך לטפל בכפילויות ב-webhook שמטפל בלידים בצורה חלקה.