مخطّط 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;
// 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". يسمح المنتج الحالي
بإرفاق نموذج على مستوى الحملة (بدلاً من إرفاقه على مستوى المجموعة الإعلانية أو الإعلان
).
التأثيرات: لا يمكن تقسيم العملاء المحتملين إلا على مستوى يجب أن يستخدم العملاء عددًا صحيحًا مكوّنًا من 8 بايت لمعالجته. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id |
رقم تعريف حملة "إعلانات Google" أو رقم تعريف العنصر ("مساحة العرض والفيديو 360")
لنموذج العملاء المحتملين المرفق.
يجب أن يستخدم العملاء عددًا صحيحًا مكوّنًا من 8 بايت لمعالجته. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adgroup_id |
يُستخدَم رقم تعريف المجموعة الإعلانية على "إعلانات Google" للتمييز بين المجموعة الإعلانية
المحدّدة في الحملة. (تتوفّر لعملاء المحتملين من إعلانات الفيديو وإعلانات أثناء التصفّح فقط)
يجب أن يستخدم العملاء عددًا صحيحًا مكوّنًا من 8 بايت لمعالجته. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id |
يُستخدَم رقم تعريف تصميم الإعلان في "إعلانات Google" للتمييز بين
تصميم الإعلان المحدّد في المجموعة الإعلانية. (تتوفّر لعملاء المحتملين من إعلانات الفيديو وإعلانات أثناء التصفّح فقط)
يجب أن يستخدم العملاء عددًا صحيحًا مكوّنًا من 8 بايت لمعالجته. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id |
معرّف النقرة من Google، وهي مَعلمة فريدة تُستخدَم لتتبُّع كل نقرة على إعلان. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key |
مفتاح يضبطه المعلِن مع كل نموذج.
اقتراح للتعامل مع المشكلة: قبل معالجة عميل محتمل تم تلقّيه من خلال
webhook، تكون عملية التحقّق من |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test |
يحتوي هذا الحقل على المعنى "اختياري". إذا كانت القيمة صحيحة، تعامل مع العميل المحتمل هذا كعميل محتمل لإجراء اختبار. إذا كانت القيمة خطأ أو إذا لم يكن الحقل متوفّرًا، تعامل مع العميل المحتمل هذا على أنّه عميل محتمل صالح للإنتاج. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
مجموعة متكرّرة من مفتاح وقيمة تنقل البيانات التي أرسلها المستخدم
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
asset_group_id |
لا يتمّ ملء هذا الحقل إلّا في "حملات الأداء الأفضل".
يشير ذلك إلى معرّف الحاوية التي تحتوي على نموذج العملاء المحتملين.
يجب أن يستخدم العملاء عددًا صحيحًا مكوّنًا من 8 بايت لمعالجته. |
معالجة العملاء المحتملِين
يجب أن تستجيب معالجات العملاء المحتملين برموز HTTP التالية:
استجابة HTTP | نص الاستجابة (بتنسيق JSON) | هل الخطأ قابل للاسترجاع؟ |
---|---|---|
200 |
{} | لا ينطبق |
4XX |
{"message: Free form error text, describing what was wrong with request"} | لا |
5XX |
{"message: Intermittent retraible error optional message"} | نعم |
جهات الاتصال المكررة
لا يمكن ضمان تسليم عميل محتمل واحد مرّة واحدة بالضبط، لذا يجب أن يتعامل الردّ التلقائي على الويب المخصّص لمعالجة العملاء المحتملين مع النُسخ المكرّرة بسلاسة.