التنفيذ

مخطط 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". المنتجات التي يسمح بها المنتج الحالي إرفاق نموذج على مستوى الحملة (مقارنة بالإرفاق في المجموعة الإعلانية أو الإعلان) المستويات).

الآثار المترتبة: يمكن تقسيم العملاء المحتملين إلى form_id فقط. (أي على مستوى الحملة).

يحتاج العملاء إلى معالجة عدد صحيح يبلغ 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 مفتاح يتم ضبطه من قِبل المعلِن مع كل نموذج.

التعامل مع الاقتراح: قبل معالجة عميل محتمل تم تلقّيه الرد التلقائي على الويب، والتحقق من صحة google_key هو نفسه الضبط في "إعلانات Google" لتعزيز الثقة في أنّ العميل المحتمل صالح. عدم الحذف بسرية هذا المفتاح وتعديله في "إعلانات Google" إذا كان هناك سبب أن هذا الخبر قد تسرَّب على نطاق واسع.
is_test يحتوي هذا الحقل على "اختياري" دلالي. إذا كانت القيمة صحيحة، تعامل مع هذه الحالة عميل محتمل كعميل محتمل. إذا كانت القيمة خاطئة أو في حال عدم توفّر الحقل، يتم إجراء المعالجة هذا العميل المحتمل كعميل إنتاج صالح.
user_column_data صف متكرّر وقيم أساسية ينقل البيانات التي أرسلها المستخدم
  • user_column_data.column_id: نوع البيانات المُرسلة من قِبل المستخدم.
  • User_column_data.column_value: لكل نوع بيانات، سيكون هناك نوع قيمة تمت تعبئته بناءً على نوع البيانات. جميع أنواع البيانات الحالية لها قيمة user_column_data.string_value
  • user_column_data.column_name: نص يمكن لشخص عادي قراءته نوع البيانات التي قدمها المستخدم. قد لا يكون هذا الحقل دائمًا تمّت تعبئته، يُرجى استخدام column_id بدلاً منه.
user_column_data.column_id محتوى عمود_بيانات_سلسلة_المستخدم user_column_data.column_name (متوقف)
"FULL_NAME" الاسم الكامل للمستخدِم. "الاسم بالكامل"
"FIRST_NAME" الاسم الأول للمستخدِم. "الاسم الأول"
"LAST_NAME" اسم العائلة للمستخدِم. "اسم العائلة"
"البريد الإلكتروني" عنوان البريد الإلكتروني للمستخدِم. "البريد الإلكتروني للمستخدم"
"PHONE_NUMBER" رقم هاتف المستخدم في E.164 التنسيق، على سبيل المثال: "+11234567890" "هاتف المستخدم"
"POSTAL_CODE" الرمز البريدي للمستخدم. "الرمز البريدي"
"COMPANY_NAME" اسم شركة المستخدم "اسم الشركة"
"JOB_TITLE" المسمى الوظيفي للمستخدم. "المسمى الوظيفي"
"WORK_EMAIL" عنوان البريد الإلكتروني للعمل الخاص بالمستخدم "البريد الإلكتروني للعمل"
"WORK_PHONE" رقم هاتف العمل الخاص بالمستخدم "هاتف العمل"
"STREET_ADDRESS" عنوان الشارع للمستخدم. "عنوان الشارع"
"المدينة" مدينة المستخدم. "المدينة"
"المنطقة" منطقة المستخدم. "المنطقة"
"COUNTRY" بلد المستخدم. "البلد"
"VEHICLE_MODEL" ما الطراز الذي تهتم به؟ لا ينطبق
"VEHICLE_TYPE" ما نوع المركبة التي تهتم بها؟ لا ينطبق
PREFERRED_DEALERSHIP اختيار الوكيل المفضّل لك لا ينطبق
"VEHICLE_PURCHASE_TIMELINE" متى تخطط لشراء مركبة؟ لا ينطبق
"VEHICLE_Condition" ما نوع حالة المركبة الذي تهتم به؟ لا ينطبق
"VEHICLE_OWNERSHIP" هل لديك مركبة؟ "لا ينطبق"
"VEHICLE_PAYMENT_TYPE" ما خيار ملكية المركبة الذي تهتم به؟ لا ينطبق
"COMPANY_size" ما حجم شركتك؟ لا ينطبق
"ANNUAL_SALES" ما حجم مبيعاتك السنوية؟ لا ينطبق
"YEARS_IN_business" كم عدد السنوات التي قضيتها في مزاولة النشاط التجاري؟ لا ينطبق
"JOB_DEPARTMENT" ما الإدارة الوظيفية؟ لا ينطبق
"JOB_ROLE" ما دورك الوظيفي؟ لا ينطبق
"EDUCATION_Program" ما البرنامج الذي تهتم به؟ لا ينطبق
"دورة تعليمية" ما الدورة التدريبية التي تهتم بها؟ لا ينطبق
"PRODUCT" ما المنتج الذي تهتم به؟ لا ينطبق
"SERVICE" ما الخدمة التي تهتم بها؟ لا ينطبق
"عرض" ما العرض الذي تهتم به؟ لا ينطبق
"الفئة" ما الفئة التي تهتم بها؟ لا ينطبق
"PREFERRED_CONTACT_METHOD" اختيار وسيلة الاتصال المفضّلة لك لا ينطبق
PREFERRED_LOCATION اختيار موقعك الجغرافي المفضّل لا ينطبق
PREFERRED_CONTACT_TIME ما أنسب وقت للاتصال بك؟ لا ينطبق
"PURCHASE_TIMELINE" متى تتطلع إلى الشراء؟ لا ينطبق
"YEARS_OF_EXPERIENCE" ما عدد سنوات خبرتك في العمل؟ لا ينطبق
"JOB_INDUSTRY" ما المجال الذي تعمل به؟ لا ينطبق
"LEVEL_OF_EDUCATION" ما أعلى مستوى تعليمي وصلتَ إليه؟ لا ينطبق
"Property_TYPE" ما نوع العقار الذي تبحث عنه؟ لا ينطبق
"REALTOR_HELP_GOAL" كيف تريد أن يساعدك الوسيط العقاري؟ لا ينطبق
"COMMUNITY_COMMUNITY" ما المنتدى الذي تهتم به؟ لا ينطبق
"PRICE_RANGE" ما نطاق السعر الذي تبحث عنه؟ لا ينطبق
"NUMBER_OF_BEDroomS" كم عدد غرف النوم التي تبحث عنها؟ لا ينطبق
"موقع FURNISHED_Property" هل تبحث عن عقار مفروش بالكامل؟ لا ينطبق
"PETS_ALLOWED_Location" هل تبحث عن عقارات يُسمَح فيها بالحيوانات الأليفة؟ لا ينطبق
"NEXT_PLANNED_PURCHASE" ما المنتج التالي الذي تخطط لشرائه؟ لا ينطبق
"EVENT_Session_INTEREST" هل ترغب في الاشتراك في حدث؟ لا ينطبق
"PREFERRED_SHOPPING_PLACES" ما الأماكن التي تهتم بالتسوّق منها؟ لا ينطبق
"العلامة التجارية المفضّلة" ما العلامة التجارية المفضّلة لك؟ لا ينطبق
"TRANSPORTATION_COMMERCIAL_LICENSE_TYPE" أي من أنواع التراخيص التجارية الصالحة لديك؟ لا ينطبق
"EVENT_BOOKING_INTEREST" هل تريد حجز تذكرة لحضور فعالية؟ لا ينطبق
"Destination_COUNTRY" ما بلد الوجهة؟ لا ينطبق
"الوجهة_المدينة" ما مدينة الوجهة؟ لا ينطبق
"gtin_COUNTRY" ما بلد المغادرة؟ لا ينطبق
"مطار مدينة وعرة" ما مدينة المغادرة؟ لا ينطبق
"gtin_DATE" ما تاريخ المغادرة؟ لا ينطبق
"Return_DATE" ما تاريخ العودة؟ لا ينطبق
"NUMBER_OF_TRAVELERS" كم عدد الأشخاص الذين تسافر معهم؟ لا ينطبق
"TRAVEL_BUDGET" ما ميزانية السفر؟ لا ينطبق
"TRAVEL_ACCOMMODATION" أين تريد الإقامة أثناء سفرك؟ لا ينطبق

التعامل مع العملاء المحتملين

يجب أن تستجيب المعالِجات الرئيسية للعملاء المحتملِين برموز HTTP التالية:

استجابة HTTP نص الاستجابة (JSON) هل حدث خطأ يمكن استرجاعه؟
200 {} لا ينطبق
4XX {"message: نص خطأ مجاني، يصف الخطأ في الطلب"} لا
5XX {"message: رسالة خطأ يمكن إعادة معالجتها بشكل متقطع"} نعم

جهات الاتصال المكررة

ليس من المضمون أن يتم تسليم عميل محتمل واحد مرة واحدة فقط، لذلك يجب أن تتعامل معالجة الرد التلقائي على الويب مع التكرارات على نحو سلس.