הסכימה של POST
בקשת ה-POST שנשלחת ל-webhook תהיה בפורמט JSON עם הסכימה הבאה:
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;
// 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. המוצר הנוכחי מאפשר לצרף טופס ברמת הקמפיין (לעומת צירוף ברמת קבוצת המודעות או ברמת המודעה).
השלכות: אפשר לפלח לידים רק ברמה לקוחות צריכים להשתמש במספר שלם באורך 8 בייטים לעיבוד. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id |
מזהה הקמפיין או מזהה הפריט (Display & Video 360) ב-Google Ads של טופס יצירת הלידים המצורף.
לקוחות צריכים להשתמש במספר שלם באורך 8 בייטים לעיבוד. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adgroup_id |
מזהה קבוצת המודעות ב-Google Ads משמש להבדיל בין קבוצת המודעות הספציפית בקמפיין. (האפשרות הזו זמינה רק ללידים ממודעות וידאו ומודעות Discovery)
לקוחות צריכים להשתמש במספר שלם באורך 8 בייטים לעיבוד. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id |
מזהה הקריאייטיב ב-Google Ads משמש להבדיל בין הקריאייטיב הספציפי בקבוצת המודעות. (האפשרות הזו זמינה רק ללידים ממודעות וידאו ומודעות Discovery)
לקוחות צריכים להשתמש במספר שלם באורך 8 בייטים לעיבוד. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id |
מספר הקליק ב-Google, פרמטר ייחודי שמשמש למעקב אחרי כל קליק על מודעה. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key |
מפתח שהמפרסם מגדיר בכל טופס.
המלצה לטיפול: לפני עיבוד ליד שנשלח דרך ה-webhook, אימות השדה |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test |
לשדה הזה יש סמנטיקה 'אופציונלית'. אם הערך הוא true, המערכת תתייחס ללידים האלה כלידים לבדיקה. אם הערך הוא false או שהשדה לא קיים, צריך להתייחס ללידים האלה כלידים תקינים בסביבת הייצור. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
קבוצת נתונים חוזרת של מפתח-ערך שמשדרת נתונים שהמשתמשים שלחו.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
asset_group_id |
השדה הזה מאוכלס רק בקמפיינים למיקסום הביצועים.
זהו מזהה המאגר שמכיל את טופס השארת הפרטים.
לקוחות צריכים להשתמש במספר שלם באורך 8 בייטים לעיבוד. |
טיפול בלידים
מנהלי הלידים צריכים להשיב עם קודי ה-HTTP הבאים:
תגובת HTTP | גוף התשובה (JSON) | האם זו שגיאה שניתן לנסות שוב? |
---|---|---|
200 |
{} | לא רלוונטי |
4XX |
{"message: Free form error text, describing what was wrong with request"} | לא |
5XX |
{"message: Intermittent retraible error optional message"} | כן |
כפילויות
אין ערובה לכך שליד יחיד יישלח בדיוק פעם אחת, ולכן התגובה לפעולה מאתר אחר (webhook) לטיפול בלידים צריכה לטפל כראוי בעותקים כפולים.