পোস্ট স্কিমা
ওয়েবহুকে পাঠানো 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];
// The source of the lead submission.
// Possible values: "LEAD_FORM" or "CONVERSATIONAL_AGENT".
string lead_source = 14 [(datapol.semantic_type) = ST_NOT_REQUIRED];
}
ক্ষেত্রের বিবরণ
| মাঠ | বর্ণনা | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
lead_id | একটি অনন্য স্ট্রিং যা প্রদত্ত লিডকে শনাক্ত করে। পরিচালনার সুপারিশ: প্রাপ্ত লিডগুলো থেকে ডুপ্লিকেট বাদ দিতে এটি ব্যবহার করুন। এটি সমস্ত ফর্ম জুড়ে অনন্য হবে। একটি নির্দিষ্ট লিড সম্পর্কিত সমস্যা রিপোর্ট করার সময়, এই আইডিটি প্রয়োজন হবে। | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_version | এই লিড স্কিমাটি যে এপিআই সংস্করণের অন্তর্গত। এটি একটি নতুন স্কিমাতে স্থানান্তরের সময় ব্যবহৃত হবে এবং আপাতত উপেক্ষা করা যেতে পারে। | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
form_id | গুগল অ্যাডস-এ কনফিগার করা প্রতিটি ফর্মের জন্য একটি অনন্য আইডি রয়েছে। বর্তমান প্রোডাক্টটি ক্যাম্পেইন লেভেলের সাথে একটি ফর্ম সংযুক্ত করার সুযোগ দেয় (অ্যাড গ্রুপ বা অ্যাড লেভেলে সংযুক্ত করার পরিবর্তে)। তাৎপর্য: লিডগুলি শুধুমাত্র প্রক্রিয়াকরণের জন্য ক্লায়েন্টদের ৮ বাইটের পূর্ণসংখ্যা ব্যবহার করতে হবে। | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id | সংযুক্ত লিড ফর্মটির গুগল অ্যাডস ক্যাম্পেইন আইডি অথবা লাইন আইটেম আইডি (ডিসপ্লে ও ভিডিও ৩৬০)। প্রক্রিয়াকরণের জন্য ক্লায়েন্টদের একটি ৮-বাইট পূর্ণসংখ্যা ব্যবহার করতে হবে। | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adgroup_id | ক্যাম্পেইনের মধ্যে নির্দিষ্ট অ্যাড গ্রুপকে আলাদা করার জন্য গুগল অ্যাডস অ্যাড গ্রুপ আইডি ব্যবহার করা হয়। (শুধুমাত্র ভিডিও এবং ডিসকভারি অ্যাড থেকে প্রাপ্ত লিডের জন্য উপলব্ধ) প্রক্রিয়াকরণের জন্য ক্লায়েন্টদের একটি ৮-বাইট পূর্ণসংখ্যা ব্যবহার করতে হবে। | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id | অ্যাড গ্রুপের মধ্যে নির্দিষ্ট ক্রিয়েটিভকে আলাদা করতে গুগল অ্যাডস ক্রিয়েটিভ আইডি ব্যবহার করা হয়। (শুধুমাত্র ভিডিও এবং ডিসকভারি অ্যাড থেকে প্রাপ্ত লিডের জন্য উপলব্ধ) প্রক্রিয়াকরণের জন্য ক্লায়েন্টদের একটি ৮-বাইট পূর্ণসংখ্যা ব্যবহার করতে হবে। | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id | গুগল ক্লিক আইডি , বিজ্ঞাপনের প্রতিটি ক্লিক ট্র্যাক করতে ব্যবহৃত একটি অনন্য প্যারামিটার। | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key | বিজ্ঞাপনদাতা কর্তৃক প্রতিটি ফর্মের সাথে কনফিগার করা একটি কী। ব্যবস্থাপনার সুপারিশ: ওয়েবহুকের মাধ্যমে প্রাপ্ত কোনো লিড প্রসেস করার আগে, লিডটি বৈধ কিনা সে বিষয়ে আরও বেশি নিশ্চিত হতে Google Ads-এ কনফিগার করার মতোই | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test | এই ফিল্ডটির অর্থ 'ঐচ্ছিক'। যদি মান 'true' হয়, তবে এই লিডটিকে একটি টেস্ট লিড হিসেবে গণ্য করুন। যদি মান 'false' হয় অথবা ফিল্ডটি উপস্থিত না থাকে, তবে এই লিডটিকে একটি বৈধ প্রোডাকশন লিড হিসেবে গণ্য করুন। | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data | ব্যবহারকারীর জমা দেওয়া ডেটা প্রেরণকারী একটি পুনরাবৃত্ত কী-ভ্যালু টাপল।
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
asset_group_id | এই ফিল্ডটি শুধুমাত্র পারফরম্যান্স-ম্যাক্স ক্যাম্পেইনের জন্য পূরণ করা হয়। এটি সেই কন্টেইনার আইডি নির্দেশ করে, যেখানে লিড ফর্মটি রয়েছে। প্রক্রিয়াকরণের জন্য ক্লায়েন্টদের একটি ৮-বাইট পূর্ণসংখ্যা ব্যবহার করতে হবে। | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
lead_stage | এটি লিড ডেলিভারির সময়কার লিডের পর্যায় নির্দেশ করে। এই ফিল্ডটি কোনো লিডের ফানেল পর্যায় বা রূপান্তর অবস্থা ট্র্যাক করতে সহায়ক। | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
lead_submit_time | এটি সেই সময় নির্দেশ করে যখন ব্যবহারকারী ফর্মটি জমা দিয়েছেন। এটি ISO-8601 ফরম্যাটে প্রকাশ করা হয়। উদাহরণ- 2024-09-26T12:30:00Z | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
lead_source | এটি লিড জমা দেওয়ার উৎস নির্দেশ করে। একটি সাধারণ লিড ফর্ম বিজ্ঞাপন থেকে তৈরি হওয়া লিডের জন্য এটি 'LEAD_FORM' হতে পারে, অথবা সার্চ-এ এজেন্টিক চ্যাট অভিজ্ঞতা থেকে তৈরি হওয়া লিডের জন্য এটি 'CONVERSATIONAL_AGENT' হতে পারে। |
অস্বীকৃত ক্ষেত্র এবং ফরোয়ার্ড সামঞ্জস্যতা
আপনার ওয়েবহুক ইন্টিগ্রেশন যাতে শক্তিশালী থাকে এবং ভবিষ্যতের উন্নয়নগুলোর সাথে খাপ খাইয়ে নিতে পারে, তা নিশ্চিত করার জন্য এটি একটি আদর্শ উত্তম অনুশীলন যে আপনার JSON পার্সারকে এমনভাবে ডিজাইন করা উচিত, যাতে এটি ওয়েবহুক পেলোডের মধ্যে থাকা এমন যেকোনো ফিল্ডকে সাবলীলভাবে উপেক্ষা করে যা আপনার সিস্টেম স্পষ্টভাবে গ্রহণ বা শনাক্ত করে না।
মূল পরামর্শ: আপনার JSON পার্সিং লজিক এমনভাবে কনফিগার করুন যাতে এটি শুধুমাত্র আপনার অ্যাপ্লিকেশনের জন্য বিশেষভাবে প্রয়োজনীয় ফিল্ডগুলোই প্রসেস করে। এমন কোড লিখবেন না যা একটি নির্দিষ্ট সেট ফিল্ড প্রত্যাশা করে অথবা পেলোডে নতুন, অপ্রত্যাশিত ফিল্ড উপস্থিত থাকলে ব্যর্থ হবে।
কেন এটি গুরুত্বপূর্ণ:
- ভবিষ্যৎ সামঞ্জস্যতা: আরও সমৃদ্ধ ডেটা বা নতুন বৈশিষ্ট্য প্রদানের জন্য গুগল ভবিষ্যতের আপডেটে ওয়েবহুক পেলোডে নতুন, ঐচ্ছিক ফিল্ড যোগ করতে পারে। যদি আপনার পার্সারটি খুব কঠোর হয় (যেমন, অজানা প্রপার্টির ক্ষেত্রে ব্যর্থ হয়), তাহলে গুগলের পক্ষ থেকে এই ধরনের নন-ব্রেকিং পরিবর্তনগুলি চালু করা হলে আপনার ইন্টিগ্রেশনটি ভেঙে যেতে পারে।
- সরলীকৃত রক্ষণাবেক্ষণ: শুধুমাত্র আপনার সক্রিয়ভাবে ব্যবহৃত ডেটা পয়েন্টগুলোর উপর মনোযোগ কেন্দ্রীভূত করার ফলে, আপনার ইন্টিগ্রেশন কোড আরও সরল এবং রক্ষণাবেক্ষণে সুবিধাজনক থাকে।
অধিকাংশ আধুনিক JSON পার্সিং লাইব্রেরিতে ডিফল্টরূপে অজানা প্রপার্টি উপেক্ষা করার অপশন থাকে, অথবা সেভাবে কনফিগারও করা যায়।
লিড হ্যান্ডলিং
লিড হ্যান্ডলারদের নিম্নলিখিত HTTP কোডগুলি দিয়ে সাড়া দেওয়া উচিত:
| HTTP প্রতিক্রিয়া | প্রতিক্রিয়া বডি (JSON) | পুনরায় চেষ্টাযোগ্য ত্রুটি? |
|---|---|---|
200 | {} | প্রযোজ্য নয় |
4XX | {"বার্তা: অনুরোধে কী ভুল ছিল তার বর্ণনা সহ একটি মুক্ত-ফর্মের ত্রুটির বিবরণ"} | না |
5XX | {"বার্তা: মাঝে মাঝে সংশোধনযোগ্য ত্রুটির ঐচ্ছিক বার্তা"} | হ্যাঁ |
ডুপ্লিকেট
একটি লিড যে ঠিক একবারই ডেলিভার করা হবে, তার কোনো নিশ্চয়তা নেই, তাই লিড হ্যান্ডলিং ওয়েবহুকের উচিত ডুপ্লিকেটগুলো সুষ্ঠুভাবে সামলানো।