পোস্ট স্কিমা
ওয়েবহুকে পাঠানো 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 stage at the time of delivery.
string lead_stage = 12 [(datapol.semantic_type) = ST_NOT_REQUIRED];
// Lead submit time in ISO-8601 format. Ex- 2024-09-26T12:30:00Z
string lead_submit_time = 13 [(datapol.semantic_type) = ST_NOT_REQUIRED];
}
ক্ষেত্রের বিবরণ
| মাঠ | বর্ণনা | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
lead_id | অনন্য স্ট্রিং যা একটি প্রদত্ত সীসা সনাক্ত করে। হ্যান্ডলিং সুপারিশ: প্রাপ্ত লিড অনুমান করতে এটি ব্যবহার করুন। এটি সব ফর্ম জুড়ে অনন্য হবে. একটি নির্দিষ্ট লিড সম্পর্কিত সমস্যা রিপোর্ট করার সময়, এই আইডি প্রয়োজন হবে। | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_version | এপিআই সংস্করণ যা এই লিড স্কিমা অন্তর্গত। এটি একটি নতুন স্কিমাতে স্থানান্তরিত করার সময় ব্যবহার করা হবে এবং আপাতত উপেক্ষা করা যেতে পারে৷ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
form_id | Google বিজ্ঞাপনে কনফিগার করা প্রতিটি ফর্মের জন্য অনন্য আইডি। বর্তমান পণ্য প্রচারাভিযান স্তরের সাথে একটি ফর্ম সংযুক্ত করার অনুমতি দেয় (বনাম বিজ্ঞাপন গোষ্ঠী বা বিজ্ঞাপন স্তরে সংযুক্ত করা)। অন্তর্নিহিততা: লিডগুলি শুধুমাত্র ক্লায়েন্টদের প্রক্রিয়া করতে 8 বাইট পূর্ণসংখ্যা ব্যবহার করতে হবে। | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id | সংযুক্ত লিড ফর্মের Google বিজ্ঞাপন প্রচারের আইডি বা লাইন আইটেম আইডি (Display & Video 360)। ক্লায়েন্টদের প্রক্রিয়া করার জন্য একটি 8-বাইট পূর্ণসংখ্যা ব্যবহার করতে হবে। | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adgroup_id | প্রচারাভিযানের নির্দিষ্ট বিজ্ঞাপন গোষ্ঠীকে আলাদা করতে Google Ads বিজ্ঞাপন গ্রুপ আইডি ব্যবহার করা হয়। (শুধুমাত্র ভিডিও এবং আবিষ্কার বিজ্ঞাপন থেকে লিডের জন্য উপলব্ধ) ক্লায়েন্টদের প্রক্রিয়া করার জন্য একটি 8-বাইট পূর্ণসংখ্যা ব্যবহার করতে হবে। | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id | Google বিজ্ঞাপন ক্রিয়েটিভ আইডি বিজ্ঞাপন গ্রুপে নির্দিষ্ট ক্রিয়েটিভকে আলাদা করতে ব্যবহার করা হয়। (শুধুমাত্র ভিডিও এবং আবিষ্কার বিজ্ঞাপন থেকে লিডের জন্য উপলব্ধ) ক্লায়েন্টদের প্রক্রিয়া করার জন্য একটি 8-বাইট পূর্ণসংখ্যা ব্যবহার করতে হবে। | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id | Google ক্লিক আইডি , একটি বিজ্ঞাপনের প্রতিটি ক্লিক ট্র্যাক করতে ব্যবহৃত একটি অনন্য প্যারামিটার। | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key | প্রতিটি ফর্মের সাথে বিজ্ঞাপনদাতা দ্বারা কনফিগার করা একটি কী৷ পরিচালনার সুপারিশ: ওয়েবহুকের মাধ্যমে প্রাপ্ত লিড প্রক্রিয়া করার আগে, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test | এই ক্ষেত্রে "ঐচ্ছিক" শব্দার্থক আছে। মান সত্য হলে, এই সীসাটিকে পরীক্ষামূলক সীসা হিসাবে বিবেচনা করুন। মান মিথ্যা হলে বা ক্ষেত্র উপস্থিত না থাকলে, এই সীসাটিকে বৈধ উৎপাদন সীসা হিসাবে বিবেচনা করুন। | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data | একটি পুনরাবৃত্ত কী-মান টিপল ব্যবহারকারী জমা দেওয়া ডেটা প্রেরণ করে।
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
asset_group_id | এই ক্ষেত্রটি শুধুমাত্র পারফরম্যান্স-ম্যাক্স প্রচারের জন্য জনবহুল। এটি কন্টেইনার আইডি নির্দেশ করে যেটিতে লিড ফর্ম রয়েছে। ক্লায়েন্টদের প্রক্রিয়া করার জন্য একটি 8-বাইট পূর্ণসংখ্যা ব্যবহার করতে হবে। | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
lead_stage | এটি সীসা বিতরণের সময় সীসা পর্যায়ে নির্দেশ করে। এই ক্ষেত্রটি একটি লিডের ফানেল পর্যায় / রূপান্তর স্থিতি ট্র্যাক করতে সহায়ক। | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
lead_submit_time | এটি টাইমস্ট্যাম্প নির্দেশ করে যেটিতে ব্যবহারকারী ফর্ম জমা দিয়েছেন। এটি ISO-8601 বিন্যাসে উপস্থাপন করা হয়। প্রাক্তন- 2024-09-26T12:30:00Z |
অচেনা ক্ষেত্র এবং ফরোয়ার্ড সামঞ্জস্য
আপনার ওয়েবহুক ইন্টিগ্রেশন মজবুত থাকে এবং ভবিষ্যতের উন্নতির সাথে খাপ খাইয়ে নিতে পারে তা নিশ্চিত করার জন্য, ওয়েবহুক পেলোডের মধ্যে যে কোনো ক্ষেত্রকে আপনার সিস্টেম স্পষ্টভাবে ব্যবহার করে না বা চিনতে পারে না এমন কোনো ক্ষেত্রকে সুন্দরভাবে উপেক্ষা করার জন্য আপনার JSON পার্সার ডিজাইন করা একটি আদর্শ সেরা অনুশীলন।
মূল প্রস্তাবনা: আপনার JSON পার্সিং লজিক কনফিগার করুন শুধুমাত্র আপনার আবেদনের জন্য বিশেষভাবে প্রয়োজনীয় ক্ষেত্রগুলি প্রক্রিয়া করার জন্য। এমন কোড লিখবেন না যা ফিল্ডের একটি নির্দিষ্ট সেট আশা করে বা পেলোডে নতুন, অপ্রত্যাশিত ক্ষেত্র উপস্থিত থাকলে তা ব্যর্থ হবে।
কেন এটি গুরুত্বপূর্ণ:
- ফরওয়ার্ড সামঞ্জস্যতা: আরও সমৃদ্ধ ডেটা বা নতুন বৈশিষ্ট্য প্রদানের জন্য Google ভবিষ্যতের আপডেটে ওয়েবহুক পেলোডে নতুন, ঐচ্ছিক ক্ষেত্র যোগ করতে পারে। যদি আপনার পার্সার খুব কঠোর হয় (যেমন, অজানা বৈশিষ্ট্যগুলিতে ব্যর্থ হয়), Google দ্বারা এই ধরনের নন-ব্রেকিং পরিবর্তনগুলি রোল আউট করলে আপনার ইন্টিগ্রেশন ভেঙ্গে যেতে পারে।
- সরলীকৃত রক্ষণাবেক্ষণ: শুধুমাত্র আপনি সক্রিয়ভাবে ব্যবহার করা ডেটা পয়েন্টগুলিতে ফোকাস করার মাধ্যমে, আপনার ইন্টিগ্রেশন কোড বজায় রাখা সহজ এবং সহজ থাকে।
বেশিরভাগ আধুনিক JSON পার্সিং লাইব্রেরিগুলি ডিফল্টরূপে অজানা বৈশিষ্ট্যগুলি উপেক্ষা করার বিকল্পগুলি অফার করে বা এটি করার জন্য কনফিগার করা যেতে পারে।
সীসা হ্যান্ডলিং
লিড হ্যান্ডলারদের নিম্নলিখিত HTTP কোডগুলির সাথে প্রতিক্রিয়া জানানো উচিত:
| HTTP প্রতিক্রিয়া | রেসপন্স বডি (JSON) | পুনরায় চেষ্টাযোগ্য ত্রুটি? |
|---|---|---|
200 | {} | N/A |
4XX | {"বার্তা: ফ্রি ফর্ম ত্রুটি পাঠ্য, অনুরোধে কী ভুল ছিল তা বর্ণনা করে"} | না |
5XX | {"বার্তা: বিরতিহীন প্রত্যাহারযোগ্য ত্রুটি ঐচ্ছিক বার্তা"} | হ্যাঁ |
ডুপ্লিকেট
একটি সিঙ্গেল লিড ঠিক একবার ডেলিভারির নিশ্চয়তা দেওয়া হয় না, তাই লিড হ্যান্ডলিং ওয়েবহুকের ডুপ্লিকেটগুলিকে সুন্দরভাবে পরিচালনা করা উচিত।