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