הטמעה

סכימת POST

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

מטען ייעודי (payload) של 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;
}

תיאור השדה

שדה תיאור
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 השדה הזה מוגדר כ'אופציונלי' סמנטי. אם הערך הוא True, צריך להתייחס אליו בתור ליד לניסיון. אם הערך הוא 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' השם הפרטי של המשתמש. "First Name" (שם פרטי)
'LAST_NAME' שם המשפחה של המשתמש. "Last Name" (שם משפחה)
"אימייל" כתובת האימייל של המשתמש. "כתובת האימייל של המשתמש"
'PHONE_NUMBER' מספר הטלפון של המשתמש ב-E.164 פורמט, למשל "+11234567890". "טלפון של משתמש"
"POSTAL_CODE" המיקוד של המשתמש. "מיקוד"
'COMPANY_NAME' שם החברה של המשתמש. "שם החברה"
"JOB_TITLE" שם התפקיד של המשתמש. "תפקיד"
'WORK_EMAIL' כתובת האימייל בעבודה של המשתמש. "כתובת האימייל בעבודה"
'WORK_PHONE' מספר הטלפון של המשתמש בעבודה. "טלפון בעבודה"
"STREET_ADDRESS" הרחוב ומספר הבית של המשתמש. 'כתובת'
'עיר' העיר שבה נמצא המשתמש. "עיר"
'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' איזה שירות אפשר להציע לך? לא רלוונטי
'מבצע' איזה מבצע מעניין אותך? לא רלוונטי
'קטגוריה' איזו קטגוריה מעניינת אותך? לא רלוונטי
"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_ANSWER_INTEREST' רוצה להירשם לאירוע? לא רלוונטי
"PREFERRED_SHOPPING_PLACES" איפה היית רוצה לעשות קניות? לא רלוונטי
'FAVORITE_BRAND' מה המותג המועדף עליך? לא רלוונטי
"TRANSPORTATION_COMMERCIAL_LICENSE_TYPE" איזו דרגה של רישיון נהיגה תקף לרכב מסחרי יש לך? לא רלוונטי
'EVENT_BOOKING_INTEREST' רוצה להזמין אירוע? לא רלוונטי
'DESTINATION_COUNTRY' מהי מדינת היעד שלך? לא רלוונטי
'DESTINATION_LOCATION' לאיזו עיר ברצונך להגיע? לא רלוונטי
'cost_COUNTRY' מה מדינת המוצא? לא רלוונטי
'escape_EEA' מה עיר המוצא? לא רלוונטי
'VALUE_DATE' מה תאריך היציאה? לא רלוונטי
'return_DATE' מה תאריך החזרה? לא רלוונטי
'NUMBER_OF_TRAVELERS' מה מספר הנוסעים שמצטרפים אליך? לא רלוונטי
'TRAVEL_BUDGET' מה התקציב לנסיעה? לא רלוונטי
"TRAVEL_ACCOMMODATION" איפה היית רוצה ללון בנסיעה? לא רלוונטי

טיפול בלידים

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

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

כפילויות

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