مخطط POST
سيكون طلب POST المُرسَل إلى الردّ التلقائي على الويب بتنسيق JSON مع ما يلي المخطط:
حمولة Webhook Proto
// 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". المنتجات التي يسمح بها المنتج الحالي
إرفاق نموذج على مستوى الحملة (مقارنة بالإرفاق في المجموعة الإعلانية أو الإعلان)
المستويات).
الآثار المترتبة: يمكن تقسيم العملاء المحتملين إلى يحتاج العملاء إلى معالجة عدد صحيح يبلغ 8 بايت. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id |
رقم تعريف الحملة على "إعلانات Google" أو رقم تعريف العنصر (مساحة العرض والفيديو 360)
نموذج العميل المحتمل المرفق.
يحتاج العملاء إلى معالجة عدد صحيح 8 بايت. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adgroup_id |
يُستخدَم رقم تعريف المجموعة الإعلانية على "إعلانات Google" للتفريق بين
المجموعة الإعلانية في الحملة. (هذه الميزة متاحة للعملاء المحتملين من Video and discovery)
إعلانات فقط)
يحتاج العملاء إلى معالجة عدد صحيح 8 بايت. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id |
يُستخدم رقم تعريف تصميم الإعلان في "إعلانات Google" لتمييز
تصميم الإعلان في المجموعة الإعلانية. (خيار متوفّر للعملاء المحتملين من Video وDiscovery)
إعلانات فقط)
يحتاج العملاء إلى معالجة عدد صحيح 8 بايت. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id |
النقرة على Google ID، وهو معلمة فريدة تُستخدَم لتتبُّع كل نقرة على الإعلان. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key |
مفتاح يتم ضبطه من قِبل المعلِن مع كل نموذج.
التعامل مع الاقتراح: قبل معالجة عميل محتمل تم تلقّيه
الرد التلقائي على الويب، والتحقق من صحة |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test |
يحتوي هذا الحقل على "اختياري" دلالي. إذا كانت القيمة صحيحة، تعامل مع هذه الحالة عميل محتمل كعميل محتمل. إذا كانت القيمة خاطئة أو في حال عدم توفّر الحقل، يتم إجراء المعالجة هذا العميل المحتمل كعميل إنتاج صالح. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
صف متكرّر وقيم أساسية ينقل البيانات التي أرسلها المستخدم
|
التعامل مع العملاء المحتملين
يجب أن تستجيب المعالِجات الرئيسية للعملاء المحتملِين برموز HTTP التالية:
استجابة HTTP | نص الاستجابة (JSON) | هل حدث خطأ يمكن استرجاعه؟ |
---|---|---|
200 |
{} | لا ينطبق |
4XX |
{"message: نص خطأ مجاني، يصف الخطأ في الطلب"} | لا |
5XX |
{"message: رسالة خطأ يمكن إعادة معالجتها بشكل متقطع"} | نعم |
جهات الاتصال المكررة
ليس من المضمون أن يتم تسليم عميل محتمل واحد مرة واحدة فقط، لذلك يجب أن تتعامل معالجة الرد التلقائي على الويب مع التكرارات على نحو سلس.