POST स्कीमा
वेबहुक पर भेजा गया POST अनुरोध, 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;
// 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 |
वह एपीआई वर्शन जिससे यह लीड स्कीमा जुड़ा है. इसका इस्तेमाल, किसी नए स्कीमा पर माइग्रेट करते समय किया जाएगा. फ़िलहाल, इसे अनदेखा किया जा सकता है. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
form_id |
Google Ads में कॉन्फ़िगर किए गए हर फ़ॉर्म के लिए यूनीक आईडी. मौजूदा प्रॉडक्ट में, कैंपेन लेवल पर फ़ॉर्म अटैच करने की सुविधा है. हालांकि, इसे विज्ञापन ग्रुप या विज्ञापन लेवल पर भी अटैच किया जा सकता है.
असर: लीड को सिर्फ़ क्लाइंट को प्रोसेस करने के लिए, आठ बाइट वाले इंटिजर का इस्तेमाल करना होगा. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id |
अटैच किए गए लीड फ़ॉर्म का Google Ads कैंपेन आईडी या लाइन आइटम आईडी (Display & Video 360).
क्लाइंट को प्रोसेस करने के लिए, आठ बाइट वाले इंटिजर का इस्तेमाल करना होगा. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adgroup_id |
Google Ads विज्ञापन ग्रुप आईडी का इस्तेमाल, कैंपेन में किसी खास विज्ञापन ग्रुप को अलग करने के लिए किया जाता है. (सिर्फ़ वीडियो और डिस्कवरी विज्ञापनों से मिलने वाली लीड के लिए उपलब्ध है)
क्लाइंट को प्रोसेस करने के लिए, आठ बाइट वाले इंटिजर का इस्तेमाल करना होगा. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id |
Google Ads क्रिएटिव आईडी का इस्तेमाल, विज्ञापन ग्रुप में किसी खास
क्रिएटिव की पहचान करने के लिए किया जाता है. (सिर्फ़ वीडियो और डिस्कवरी विज्ञापनों से मिलने वाली लीड के लिए उपलब्ध है)
क्लाइंट को प्रोसेस करने के लिए, आठ बाइट वाले इंटिजर का इस्तेमाल करना होगा. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id |
Google क्लिक आईडी, एक यूनीक पैरामीटर है. इसका इस्तेमाल, किसी विज्ञापन पर होने वाले हर क्लिक को ट्रैक करने के लिए किया जाता है. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key |
विज्ञापन देने वाले व्यक्ति या कंपनी ने हर फ़ॉर्म के साथ कॉन्फ़िगर की गई कुंजी.
सुझाव मैनेज करना: webhook से मिली लीड को प्रोसेस करने से पहले, |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test |
इस फ़ील्ड के लिए, "ज़रूरी नहीं" सेमेटिक का इस्तेमाल किया गया है. अगर वैल्यू 'सही' है, तो इस लीड को जांच के तौर पर इस्तेमाल करें. अगर वैल्यू गलत है या फ़ील्ड मौजूद नहीं है, तो इस लीड को मान्य प्रोडक्शन लीड के तौर पर मैनेज करें. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
उपयोगकर्ता का सबमिट किया गया डेटा भेजने वाला, दोहराया गया की-वैल्यू टुपल.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
asset_group_id |
यह फ़ील्ड सिर्फ़ परफ़ॉर्मेंस मैक्स कैंपेन के लिए पॉप्युलेट होता है.
यह उस कंटेनर आईडी को दिखाता है जिसमें लीड फ़ॉर्म मौजूद है.
क्लाइंट को प्रोसेस करने के लिए, आठ बाइट वाले इंटिजर का इस्तेमाल करना होगा. |
लीड मैनेज करना
लीड हैंडलर को इन एचटीटीपी कोड के साथ जवाब देना चाहिए:
एचटीटीपी रिस्पॉन्स | रिस्पॉन्स का मुख्य हिस्सा (JSON) | क्या गड़बड़ी को दोबारा आज़माया जा सकता है? |
---|---|---|
200 |
{} | लागू नहीं |
4XX |
{"message: Free form error text, describing what was wrong with request"} | नहीं |
5XX |
{"message: Intermittent retraible error optional message"} | हां |
डुप्लीकेट
यह गारंटी नहीं है कि किसी एक लीड को सिर्फ़ एक बार डिलीवर किया जाएगा. इसलिए, लीड मैनेज करने वाले वेबहुक को डुप्लीकेट लीड को आसानी से मैनेज करना चाहिए.