בקשת ה-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 בייטים.
המלצה לטיפול: לפני עיבוד של ליד שהתקבל
תגובה לפעולה מאתר אחר (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".