event_name string (سلسلة) | مطلوب. اسم حدث قياسي أو حدث مخصص. يتم استخدام هذا الحقل لإلغاء تكرار الأحداث التي يتم إرسالها من جانب كل من الويب (عبر بيكسل Meta) أو التطبيق (عبر مجموعة SDK أو واجهة API أحداث التطبيق) وواجهة API التحويلات. يتم استخدام المعلمة event_id أيضًا في إلغاء التكرار.
بالنسبة لإجراء العميل ذاته، يتطابق event الوارد من حدث المتصفح أوالتطبيق مع event_name الوارد من حدث الخادم. وإذا وجدنا تطابقًا بين الأحداث المرسلة في غضون 48 ساعة من تلقي كل منها، فسننظر في الحدث الأول فقط. إذا وصل حدث الخادم والمتصفح/التطبيق في الوقت ذاته تقريبًا (في غضون 5 دقائق من تلقي كل منهما)، فإننا نفضل حدث المتصفح/التطبيق. تعرف على المزيد حول إلغاء تكرار أحداث الخادم والبيكسل. |
event_time integer (عدد صحيح) | مطلوب. طابع زمني بتنسيق Unix بالثواني يشير إلى الوقت الفعلي الذي وقع فيه الحدث. وقد يكون الوقت المحدد مبكرًا عن الوقت الذي ترسل فيه الحدث إلى فيسبوك. ذلك من أجل تمكين المعالجة المجمّعة وتحسين أداء الخادم. كما يجب إرسال هذا التاريخ بالمنطقة الزمنية بتوقيت جرينتش.
يمكن أن يصل event_time إلى 7 أيام قبل إرسال الحدث إلى فيسبوك. إذا كان event_time في data أكبر من 7 أيام في الماضي، فإننا نُرجع رسالة خطأ على الطلب بأكمله ولا نعالج أي أحداث. |
user_data object (كائن) | مطلوب. خريطة تحتوي على بيانات معلومات العميل. للحصول على الخيارات، راجع معلمات معلومات العميل. راجع المطابقة المتقدمة للتعرف على الخيارات المتوفرة التي يمكن مقارنتها للبيانات المرسلة عبر بيكسل Meta. |
custom_data object (كائن) | اختياري. خريطة تتضمن بيانات إضافية للنشاط التجاري حول الحدث. راجع معلمات البيانات المخصصة لمزيد من المعلومات. |
event_source_url string (سلسلة) | اختياري. عنوان URL للمتصفح حيث وقع الحدث. يجب أن يطابق عنوان URL النطاق الذي تم التحقق منه.
ملاحظة: يُعد event_source_url مطلوبًا لأحداث موقع الويب التي تتم مشاركتها باستخدام واجهة API التحويلات. |
opt_out boolean (قيمة منطقية) | اختياري. علامة تشير إلى أنه يجب ألا نستخدم هذا الحدث بغرض تحسين عرض الإعلانات. إذا تم التعيين على القيمة true ، فلن نستخدم الحدث إلا للإسناد فقط. |
event_id string (سلسلة) | اختياري. يمكن أن يكون هذا المعرف أي سلسلة فريدة يتم اختيارها بواسطة المعلن. يتم استخدام المعلمتين event_id وevent_name لإلغاء تكرار الأحداث من جانب كل من الويب (عبر بيكسل Meta) أو التطبيق (عبر مجموعة SDK أو واجهة API أحداث التطبيق) وواجهة API التحويلات. لاحظ أنه على الرغم من تحديد event_id كاختياري، فإنه يوصى باستخدامه لإلغاء تكرار الحدث.
بالنسبة لعملية إلغاء التكرار، يجب أن يتطابق المعرف eventID الوارد من حدث المتصفح أو التطبيق مع المعرف event_id الموجود في حدث الخادم المقابل. تعرف على المزيد حول معالجة تكرار أحداث البيكسل وواجهة API التحويلات.
رقم الطلب أو معرف المعاملة هما نوعان من المعرفات المحتملة التي يمكن استخدامها في event_id . على سبيل المثال، إذا قام العميل بعمليتي شراء على موقع الويب من خلال أرقام الطلب 123 و456، فسيتعين أن يتضمن كل استدعاء واجهة API التحويلات رقم الطلب الخاص في event_id . يسمح لنا ذلك بالتمييز بشكل صحيح بين حدثي الشراء هذين كطلبات مميزة. سيحتاج حدثا شراء البيكسل المتوافقان في المتصفح أيضًا إلى إرسال أرقام الطلب ذاتها في المعلمة eventID حتى ندرك أنه كان هناك حدثان فقط، وليس أربع عمليات شراء فريدة.
بالنسبة إلى الأحداث الأخرى التي لا تحتوي على رقم معرف فعلي، يمكن استخدام رقم عشوائي (طالما يتم إرسال الرقم العشوائي ذاته بين أحداث المتصفح والخادم). |
action_source string (سلسلة) | مطلوب يسمح لك هذا الحقل بتحديد مكان حدوث التحويلات. تساعد معرفة مكان وقوع الأحداث في التأكد من وصول إعلاناتك إلى الأشخاص المناسبين. بمجرد استخدام واجهة API التحويلات، فإنك توافق على أن المعلمة action_source دقيقة حسب معلوماتك.
فيما يلي القيم التي يمكنك إرسالها في الحقل action_source :
email — حدث التحويل عبر البريد الإلكتروني.
website — تم إجراء التحويل على موقع الويب.
app — تم إجراء التحويل عبر تطبيق الهواتف المحمولة.
phone_call — تم إجراء التحويل عبر الهاتف.
chat — تم إجراء التحويل عبر تطبيق مراسلة أو رسالة SMS أو ميزة المراسة على الإنترنت.
physical_store — تم إجراء التحويل بصفة شخصية داخل متجرك الفعلي.
system_generated — حدث التحويل تلقائيًا، على سبيل المثال، تجديد الاشتراك الذي يتم تعيينه إلى الدفع التلقائي كل شهر.
business_messaging — تم التحويل من إعلانات النقر لفتح محادثة في Messenger أو Instagram أو واتساب.
other — حدث التحويل بطريقة مختلفة عن الطرق المدرجة.
ملحوظة: تعمل كل قيم مصادر الإجراء على تمكين إمكانات قياس الإعلانات وإنشاء الجمهور المخصص. تعمل كل مصادر الإجراء باستثناء physical_store على تمكين إمكانات تحسين الإعلان. |
data_processing_options array (مصفوفة) | اختياري. خيارات المعالجة التي تريد تمكينها في حدث محدد. علمًا بأن القيمة الحالية المقبولة هي LDU فيما يتعلق بالاستخدام المحدود للبيانات. يمكن إرسال مصفوفة فارغة لتحديد أنه لا يجب معالجة هذا الحدث بوضوح مع فرض تقييدات الاستخدام المحدود للبيانات. تعرف على المزيد حول خيارات معالجة البيانات. يمكنك الرجوع إلى أمثلة على تنفيذ واجهة API التحويلات. |
data_processing_options_country integer (عدد صحيح) | مطلوب، إذا أرسلت LDU ضمن data_processing_options . البلد الذي تريد ربطه بخيار معالجة البيانات هذا. علمًا بأن القيم الحالية المقبولة هي 1 للولايات المتحدة الأمريكية، أو 0 لطلب تحديد الموقع الجغرافي لهذا الحدث. تعرف على المزيد حول خيارات معالجة البيانات. يمكنك الرجوع إلى أمثلة على تنفيذ واجهة API التحويلات. |
data_processing_options_state integer (عدد صحيح) | مطلوب في بعض الحالات. (راجع الملاحظة أدناه للحصول على تفاصيل.) الولاية التي تريد ربطها بخيار معالجة البيانات هذا. علمًا بأن القيم الحالية المقبولة هي 1000 لولاية كاليفورنيا، أو 0 لطلب تحديد الموقع الجغرافي لهذا الحدث.
ملاحظة: تعرف على المزيد حول خيارات معالجة البيانات. يمكنك الرجوع إلى أمثلة على تنفيذ واجهة API التحويلات. |
app_data
object (كائن) | مطلوب لأحداث التطبيق معلمات مشاركة بيانات التطبيق ومعلومات الجهاز مع واجهة API التحويلات. extinfo هي معلمة فرعية للمعلمة app_data .
|
extinfo
object (كائن) | مطلوب لأحداث التطبيق معلومات الجهاز الموسعة، مثل عرض الشاشة وارتفاعها. هذه المعلمة عبارة عن مصفوفة حيث تكون القيم مفصولة بفاصلة. عند استخدام extinfo، تكون كل القيم مطلوبة ويجب إدراجها حسب الترتيب المفهرس أدناه. إذا كانت هناك قيمة مفقودة، فيمكنك إدخال سلسلة فارغة كعنصر نائب.
ملاحظة:
يجب أن يتوفر version بالقيمة a2 لنظام Android يجب أن يتوفر version بالقيمة i2 لنظام iOS
|
0
string (سلسلة) | مطلوب إصدار extinfo
مثال: i2 |
1
string (سلسلة) | اسم حزمة التطبيق
مثال: com.facebook.sdk.samples.hellofacebook |
2
string (سلسلة) | الإصدار القصير (int (عدد صحيح) أو string (سلسلة))
مثال: 1.0 |
3
string (سلسلة) | الإصدار الكامل
مثال: 1.0 long |
4
string (سلسلة) | مطلوب إصدار نظام التشغيل
مثال: 13.4.1 |
5
string (سلسلة) | اسم طراز الجهاز
مثال: iPhone5,1 |
6
string (سلسلة) | اللغة المحلية
مثال: En_US |
7
string (سلسلة) | اختصار المنطقة الزمنية
مثال: PDT |
8
string (سلسلة) | مزوّد شبكة الهاتف المحمول
مثال: AT&T |
9
int64 | عرض الشاشة
مثال: 320 |
10
int64 | ارتفاع الشاشة
مثال: 568 |
11
string (سلسلة) | كثافة الشاشة
مثال: 2 |
12
int64 | أنوية وحدة المعالجة المركزية (CPU)
مثال: 2 |
13
int64 | حجم مساحة التخزين الخارجية بالجيجابايت
مثال: 13 |
14
int64 | المساحة الفارغة في مساحة التخزين الخارجية بالجيجابايت
مثال: 8 |
15
string (سلسلة) | المنطقة الزمنية للجهاز
مثال: USA/New York |
referrer_url string (سلسلة) | اختياري. عنوان مرجع HTTP كما تعرضه الصفحة التي تقوم بتشغيل واجهة API التحويلات أو حدث بيكسل Meta. عادةً ما تكون هذه هي الصفحة السابقة في المتصفح. |
original_event_data object (كائن) | اختياري. جميع حقول البيانات التعريفية يمكن للمعلنين استخدامها لتحديد كيفية ربط حدث "متأخر" بحدث اكتساب سابق. نوصي بشدة باستخدام original_event_data عندما يكون هناك تأخير بين وقت إرسال حدث ما وحدث الاكتساب السابق الذي يجب ربطه به. راجع معلمات بيانات الأحداث الأصلية لمزيد من المعلومات. |