التنفيذ

مخطط 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". يسمح المنتج الحالي بإرفاق نموذج على مستوى الحملة (مقارنةً بالإرفاق على مستوى المجموعة الإعلانية أو الإعلان). الآثار المترتبة: لا يمكن تقسيم العملاء المحتملين إلا على مستوى form_id (أي على مستوى الحملة). على العملاء استخدام عدد صحيح يبلغ 8 بايت للمعالجة.
campaign_id	رقم تعريف حملة "إعلانات Google" أو رقم تعريف العنصر (مساحة العرض والفيديو 360) لنموذج العملاء المحتمَلين المرفق. على العملاء استخدام عدد صحيح 8 بايت للمعالجة.
adgroup_id	يتمّ استخدام رقم تعريف المجموعة الإعلانية على "إعلانات Google" للتمييز بين المجموعة الإعلانية المعيّنة في الحملة. (متاحة للعملاء المحتملين من إعلانات الفيديو والإعلانات أثناء التصفّح فقط) على العملاء استخدام عدد صحيح 8 بايت للمعالجة.
creative_id	ويتم استخدام رقم تعريف تصميم الإعلان على "إعلانات Google" لتمييز تصميم الإعلان المعيّن في المجموعة الإعلانية. (متاحة للعملاء المحتملين من إعلانات الفيديو والإعلانات أثناء التصفّح فقط) على العملاء استخدام عدد صحيح 8 بايت للمعالجة.
gcl_id	رقم تعريف النقرة من Google، وهو مَعلمة فريدة تُستخدَم لتتبُّع كل نقرة على أحد الإعلانات.
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" اسم العائلة للمستخدِم. "اسم العائلة" "EMAIL" عنوان البريد الإلكتروني للمستخدِم. "البريد الإلكتروني للمستخدم" "PHONE_NUMBER" هاتف المستخدم بالتنسيق E.164، على سبيل المثال، "+11234567890". "هاتف المستخدم" "POSTAL_CODE" (رمز_البريدي) الرمز البريدي للمستخدم "الرمز البريدي" "COMPANY_NAME" اسم شركة المستخدِم. "اسم الشركة" "JOB_TITLE" المسمى الوظيفي للمستخدم. "Job Title" (المسمى الوظيفي) "WORK_EMAIL" عنوان البريد الإلكتروني المخصّص للعمل للمستخدم. "البريد الإلكتروني للعمل" "WORK_PHONE" هاتف المستخدم الخاص بالعمل "هاتف العمل" "STREET_ADDRESS" عنوان شارع المستخدِم. "عنوان الشارع" "CITY" مدينة المستخدِم. "المدينة" "المنطقة" منطقة المستخدم. "المنطقة" "COUNTRY" (البلد) بلد المستخدم. "Country (البلد)" "VEHICLE_MODEL" ما الطراز الذي تهتم به؟ لا ينطبق "VEHICLE_TYPE" ما نوع المركبة التي تهتم بها؟ لا ينطبق PREFERRED_DEALERSHIP اختيار الوكيل المفضّل لك لا ينطبق "VEHICLE_PURCHASE_TIMELINE" متى تخطط لشراء مركبة؟ لا ينطبق "VEHICLE_الحالة" ما نوع حالة المركبة الذي تهتم به؟ لا ينطبق "VEHICLE_OWNERSHIP" هل لديك مركبة؟ "لا ينطبق" "VEHICLE_PAYMENT_TYPE" ما خيار ملكية المركبة الذي تهتم به؟ لا ينطبق "COMPANY_SIZE" ما حجم شركتك؟ لا ينطبق "ANNUAL_SALES" ما حجم مبيعاتك السنوية؟ لا ينطبق "Year_IN_BUSINESS" كم عدد السنوات التي قضيتها في مزاولة النشاط التجاري؟ لا ينطبق "JOB_DEPARTMENT" ما الإدارة الوظيفية؟ لا ينطبق "JOB_role" ما دورك الوظيفي؟ لا ينطبق "EDUCATION_program" ما البرنامج الذي تهتم به؟ لا ينطبق "EDUCATION_COURSE" ما الدورة التدريبية التي تهتم بها؟ لا ينطبق "PRODUCT" ما المنتج الذي تهتم به؟ لا ينطبق "SERVICE" ما الخدمة التي تهتم بها؟ لا ينطبق "عرض" ما العرض الذي تهتم به؟ لا ينطبق "CATEGORY" ما الفئة التي تهتم بها؟ لا ينطبق "PREFERRED_CONTACT_METHOD" اختيار وسيلة الاتصال المفضّلة لك لا ينطبق "PREFERRED_LOCATION" اختيار موقعك الجغرافي المفضّل لا ينطبق "PREFERRED_CONTACT_TIME" ما أنسب وقت للاتصال بك؟ لا ينطبق "PURCHASE_TIMELINE" متى تتطلع إلى الشراء؟ لا ينطبق "سنوات_OF_EXPERIENCE" ما عدد سنوات خبرتك في العمل؟ لا ينطبق "JOB_INDUSTRY" ما المجال الذي تعمل به؟ لا ينطبق "LEVEL_OF_EDUCATION" ما أعلى مستوى تعليمي وصلتَ إليه؟ لا ينطبق "property_TYPE" ما نوع العقار الذي تبحث عنه؟ لا ينطبق "REALTOR_HELP_GOAL" كيف تريد أن يساعدك الوسيط العقاري؟ لا ينطبق "الموقع_المجتمع" ما المنتدى الذي تهتم به؟ لا ينطبق "PRICE_RANGE" ما نطاق السعر الذي تبحث عنه؟ لا ينطبق "NUMBER_OF_BEDROOMS" كم عدد غرف النوم التي تبحث عنها؟ لا ينطبق "FURNISHED_property" هل تبحث عن عقار مفروش بالكامل؟ لا ينطبق "PETS_ALLOWED_PROPERTY" هل تبحث عن عقارات يُسمَح فيها بالحيوانات الأليفة؟ لا ينطبق "NEXT_PLANNED_PURCHASE" ما المنتج التالي الذي تخطط لشرائه؟ لا ينطبق "EVENT_START_INTEREST" هل ترغب في الاشتراك في حدث؟ لا ينطبق "PREFERRED_SHOPPING_PLACES" ما الأماكن التي تهتم بالتسوّق منها؟ لا ينطبق "FAVORITE_BRAND" ما العلامة التجارية المفضّلة لك؟ لا ينطبق "TRANSPORTATION_COMMERCIAL_LICENSE_TYPE" أي من أنواع التراخيص التجارية الصالحة لديك؟ لا ينطبق "EVENT_BOOKING_INTEREST" هل تريد حجز تذكرة لحضور فعالية؟ لا ينطبق "DESTINATION_COUNTRY" ما بلد الوجهة؟ لا ينطبق "destination_CITY" ما مدينة الوجهة؟ لا ينطبق " إغلاق_COUNTRY" ما بلد المغادرة؟ لا ينطبق "NUM_CITY" ما مدينة المغادرة؟ لا ينطبق "NUM_DATE" ما تاريخ المغادرة؟ لا ينطبق "Return_DATE" ما تاريخ العودة؟ لا ينطبق "NUMBER_OF_TRAVELERS" كم عدد الأشخاص الذين تسافر معهم؟ لا ينطبق TRAVEL_BUDGET ما ميزانية السفر؟ لا ينطبق "TRAVEL_ACCOMMODATION" أين تريد الإقامة أثناء سفرك؟ لا ينطبق

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

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

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

أغانٍ متكرّرة

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