पीओएसटी स्कीमा
वेबहुक को भेजा गया पोस्ट अनुरोध, JSON फ़ॉर्मैट में होगा. इसमें यहां दिए गए स्कीमा की जानकारी होगी:
वेबहुक प्रोटो पेलोड
// 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 |
एपीआई का यह वर्शन, जिससे यह लीड स्कीमा जुड़ा है. नए स्कीमा पर माइग्रेट करते समय, इसका इस्तेमाल किया जाएगा और फ़िलहाल इसे अनदेखा किया जा सकता है. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
form_id |
Google Ads में कॉन्फ़िगर किए गए हर फ़ॉर्म के लिए यूनीक आईडी. मौजूदा प्रॉडक्ट की मदद से,
कैंपेन लेवल के साथ फ़ॉर्म को अटैच किया जा सकता है. हालांकि, इससे विज्ञापन ग्रुप या विज्ञापन
लेवल पर फ़ॉर्म को अटैच किया जा सकता है.
अहम जानकारी: लीड को सिर्फ़ क्लाइंट को प्रोसेस करने के लिए, 8 बाइट वाले पूर्णांक का इस्तेमाल करना होगा. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id |
अटैच किए गए लीड फ़ॉर्म का Google Ads कैंपेन आईडी या लाइन आइटम आईडी (Display & Video 360).
क्लाइंट को प्रोसेस करने के लिए, 8-बाइट वाले पूर्णांक का इस्तेमाल करना होगा. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adgroup_id |
Google Ads विज्ञापन ग्रुप के आईडी का इस्तेमाल, कैंपेन में किसी खास विज्ञापन ग्रुप को अलग करने के लिए किया जाता है. (सिर्फ़ वीडियो और डिस्कवरी विज्ञापनों से मिलने वाली लीड के लिए उपलब्ध)
क्लाइंट को प्रोसेस करने के लिए, 8-बाइट वाले पूर्णांक का इस्तेमाल करना होगा. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id |
Google Ads क्रिएटिव आईडी का इस्तेमाल, विज्ञापन ग्रुप में मौजूद किसी
क्रिएटिव को अलग करने के लिए किया जाता है. (सिर्फ़ वीडियो और डिस्कवरी विज्ञापनों से मिलने वाली लीड के लिए उपलब्ध)
क्लाइंट को प्रोसेस करने के लिए, 8-बाइट वाले पूर्णांक का इस्तेमाल करना होगा. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id |
Google क्लिक आईडी, यह एक यूनीक पैरामीटर है. इसका इस्तेमाल, किसी विज्ञापन के हर क्लिक को ट्रैक करने के लिए किया जाता है. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key |
हर फ़ॉर्म के साथ विज्ञापन देने वाले की तरफ़ से कॉन्फ़िगर की गई एक कुंजी.
सुझाव को मैनेज करना: वेबहुक पर मिली लीड को प्रोसेस करने से पहले, |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test |
इस फ़ील्ड में "वैकल्पिक" सिमैंटिक है. अगर वैल्यू सही है, तो इस लीड को टेस्ट लीड के तौर पर देखें. अगर वैल्यू गलत है या फ़ील्ड मौजूद नहीं है, तो इस लीड को मान्य प्रोडक्शन लीड मानें. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
उपयोगकर्ता के सबमिट किए गए डेटा को ट्रांसमिट करने वाला, दोहराई गई कुंजी-वैल्यू का टपल.
|
लीड हैंडलिंग
लीड हैंडलर को इन एचटीटीपी कोड के साथ जवाब देना चाहिए:
| एचटीटीपी रिस्पॉन्स | जवाब का मुख्य हिस्सा (JSON) | क्या ऐसी गड़बड़ी है जिसे फिर से ठीक किया जा सकता है? |
|---|---|---|
200 |
{} | लागू नहीं |
4XX |
{"message: फ़्री फ़ॉर्म गड़बड़ी टेक्स्ट, यह बताता है कि अनुरोध में क्या गड़बड़ी थी"} | नहीं |
5XX |
{"message: इंटरमिटेंट रिट्रेबल एरर वैकल्पिक मैसेज"} | हां |
डुप्लीकेट
इस बात की कोई गारंटी नहीं है कि एक लीड सिर्फ़ एक बार ही डिलीवर होगी. इसलिए, लीड हैंडलिंग वेबहुक डुप्लीकेट को आसानी से हैंडल कर लेगा.