लागू करने का तरीका

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 में कॉन्फ़िगर किए गए हर फ़ॉर्म के लिए यूनीक आईडी. मौजूदा प्रॉडक्ट में, कैंपेन लेवल पर फ़ॉर्म अटैच करने की सुविधा है. हालांकि, इसे विज्ञापन ग्रुप या विज्ञापन लेवल पर भी अटैच किया जा सकता है.

असर: लीड को सिर्फ़ form_id लेवल (यानी, कैंपेन लेवल) पर ही स्लाइस किया जा सकता है.

क्लाइंट को प्रोसेस करने के लिए, आठ बाइट वाले इंटिजर का इस्तेमाल करना होगा.

campaign_id अटैच किए गए लीड फ़ॉर्म का Google Ads कैंपेन आईडी या लाइन आइटम आईडी (Display & Video 360).

क्लाइंट को प्रोसेस करने के लिए, आठ बाइट वाले इंटिजर का इस्तेमाल करना होगा.

adgroup_id Google Ads विज्ञापन ग्रुप आईडी का इस्तेमाल, कैंपेन में किसी खास विज्ञापन ग्रुप को अलग करने के लिए किया जाता है. (सिर्फ़ वीडियो और डिस्कवरी विज्ञापनों से मिलने वाली लीड के लिए उपलब्ध है)

क्लाइंट को प्रोसेस करने के लिए, आठ बाइट वाले इंटिजर का इस्तेमाल करना होगा.

creative_id Google Ads क्रिएटिव आईडी का इस्तेमाल, विज्ञापन ग्रुप में किसी खास क्रिएटिव की पहचान करने के लिए किया जाता है. (सिर्फ़ वीडियो और डिस्कवरी विज्ञापनों से मिलने वाली लीड के लिए उपलब्ध है)

क्लाइंट को प्रोसेस करने के लिए, आठ बाइट वाले इंटिजर का इस्तेमाल करना होगा.

gcl_id Google क्लिक आईडी, एक यूनीक पैरामीटर है. इसका इस्तेमाल, किसी विज्ञापन पर होने वाले हर क्लिक को ट्रैक करने के लिए किया जाता है.
google_key विज्ञापन देने वाले व्यक्ति या कंपनी ने हर फ़ॉर्म के साथ कॉन्फ़िगर की गई कुंजी.

सुझाव मैनेज करना: webhook से मिली लीड को प्रोसेस करने से पहले, google_key की पुष्टि करना, Google Ads में कॉन्फ़िगर करने जैसा ही है. इससे यह पक्का करने में मदद मिलती है कि लीड मान्य है. इस पासकोड को गोपनीय रखें और अगर आपको लगता है कि यह पासकोड लीक हो गया है, तो Google Ads में इसे अपडेट करें.

is_test इस फ़ील्ड के लिए, "ज़रूरी नहीं" सेमेटिक का इस्तेमाल किया गया है. अगर वैल्यू 'सही' है, तो इस लीड को जांच के तौर पर इस्तेमाल करें. अगर वैल्यू गलत है या फ़ील्ड मौजूद नहीं है, तो इस लीड को मान्य प्रोडक्शन लीड के तौर पर मैनेज करें.
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" उपयोगकर्ता का नाम. "नाम"
"LAST_NAME" उपयोगकर्ता का उपनाम. "उपनाम"
"EMAIL" उपयोगकर्ता का ईमेल. "उपयोगकर्ता का ईमेल पता"
"PHONE_NUMBER" उपयोगकर्ता का फ़ोन नंबर E.164 फ़ॉर्मैट में, जैसे कि "+11234567890". "उपयोगकर्ता का फ़ोन"
"POSTAL_CODE" उपयोगकर्ता का पिन कोड. "पिन कोड"
"COMPANY_NAME" उपयोगकर्ता की कंपनी का नाम. "कंपनी का नाम"
"JOB_TITLE" उपयोगकर्ता का जॉब टाइटल. "जॉब का टाइटल"
"WORK_EMAIL" उपयोगकर्ता का ऑफ़िस ईमेल पता. "ऑफ़िस का ईमेल पता"
"WORK_PHONE" उपयोगकर्ता का ऑफ़िस फ़ोन नंबर. "ऑफ़िस का फ़ोन नंबर"
"STREET_ADDRESS" उपयोगकर्ता के मोहल्ले का पता. "पता"
"CITY" उपयोगकर्ता का शहर. "शहर"
"REGION" उपयोगकर्ता का इलाका. "इलाका"
"COUNTRY" उपयोगकर्ता का देश. "देश"
"VEHICLE_MODEL" आप किस तरह का मॉडल चाहते हैं? लागू नहीं
"VEHICLE_TYPE" आपको किस तरह की गाड़ी चाहिए? लागू नहीं
"PREFERRED_DEALERSHIP" अपनी पसंदीदा डीलरशिप चुनें लागू नहीं
"VEHICLE_PURCHASE_TIMELINE" आपको गाड़ी कब खरीदनी है? लागू नहीं
"VEHICLE_CONDITION" आपको पुरानी गाड़ी चाहिए या नई? लागू नहीं
"VEHICLE_OWNERSHIP" क्या आपके पास कोई गाड़ी है? "N/A"
"VEHICLE_PAYMENT_TYPE" आपको गाड़ी खरीदनी है या लीज़ पर लेनी है? लागू नहीं
"COMPANY_SIZE" आपकी कंपनी कितनी बड़ी है? लागू नहीं
"ANNUAL_SALES" आपकी सालाना बिक्री कितनी है? लागू नहीं
"YEARS_IN_BUSINESS" आप कारोबार में कितने साल से हैं? लागू नहीं
"JOB_DEPARTMENT" आप किस विभाग में नौकरी करते हैं? लागू नहीं
"JOB_ROLE" आप किस पद पर हैं? लागू नहीं
"EDUCATION_PROGRAM" आपकी दिलचस्पी किस प्रोग्राम में है? लागू नहीं
"EDUCATION_COURSE" आपकी दिलचस्पी किस कोर्स में है? लागू नहीं
"PRODUCT" आपकी किस प्रॉडक्ट में दिलचस्पी है? लागू नहीं
"SERVICE" आपकी दिलचस्पी किस सेवा में है? लागू नहीं
"OFFER" आपकी दिलचस्पी किस ऑफ़र में है? लागू नहीं
"CATEGORY" आपकी दिलचस्पी किस कैटगरी में है? लागू नहीं
"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_SIGNUP_INTEREST" क्या आपको किसी इवेंट के लिए साइन अप करना है? लागू नहीं
"PREFERRED_SHOPPING_PLACES" आपको कहां से खरीदारी करनी है? लागू नहीं
"FAVORITE_BRAND" आपका पसंदीदा ब्रैंड कौनसा है? लागू नहीं
"TRANSPORTATION_COMMERCIAL_LICENSE_TYPE" आपके पास किस तरह का मान्य कमर्शियल लाइसेंस है? लागू नहीं
"EVENT_BOOKING_INTEREST" क्या आपको कोई इवेंट बुक करना है? लागू नहीं
"DESTINATION_COUNTRY" आपको किस देश में जाना है? लागू नहीं
"DESTINATION_CITY" आपको किस शहर में जाना है? लागू नहीं
"DEPARTURE_COUNTRY" आपको किस देश से जाना है? लागू नहीं
"DEPARTURE_CITY" आपको किस शहर से जाना है? लागू नहीं
"DEPARTURE_DATE" आपके जाने की तारीख क्या है? लागू नहीं
"RETURN_DATE" आपकी वापसी की तारीख क्या है? लागू नहीं
"NUMBER_OF_TRAVELERS" आपके साथ कितने लोग यात्रा कर रहे हैं? लागू नहीं
"TRAVEL_BUDGET" आपकी यात्रा का बजट क्या है? लागू नहीं
"TRAVEL_ACCOMMODATION" आपको यात्रा के दौरान कहां रुकना है? लागू नहीं
asset_group_id यह फ़ील्ड सिर्फ़ परफ़ॉर्मेंस मैक्स कैंपेन के लिए पॉप्युलेट होता है. यह उस कंटेनर आईडी को दिखाता है जिसमें लीड फ़ॉर्म मौजूद है.

क्लाइंट को प्रोसेस करने के लिए, आठ बाइट वाले इंटिजर का इस्तेमाल करना होगा.

लीड मैनेज करना

लीड हैंडलर को इन एचटीटीपी कोड के साथ जवाब देना चाहिए:

एचटीटीपी रिस्पॉन्स रिस्पॉन्स का मुख्य हिस्सा (JSON) क्या गड़बड़ी को दोबारा आज़माया जा सकता है?
200 {} लागू नहीं
4XX {"message: Free form error text, describing what was wrong with request"} नहीं
5XX {"message: Intermittent retraible error optional message"} हां

डुप्लीकेट

यह गारंटी नहीं है कि किसी एक लीड को सिर्फ़ एक बार डिलीवर किया जाएगा. इसलिए, लीड मैनेज करने वाले वेबहुक को डुप्लीकेट लीड को आसानी से मैनेज करना चाहिए.