API رؤى المراسلات

يشرح هذا المستند كيفية الحصول على أدوات قياس الرسائل التي أرسلها نشاطك التجاري أو استلمها بشكل برمجي. API رؤى المراسلات هي ملحق لواجهة API رؤى الصفحة وتُتيح لك الحصول على المعلومات نفسها التي تظهر في علامة تبويب "رؤى الصفحة" لصفحتك على فيسبوك.

قبل البدء

يفترض هذا الدليل أنك قد قرأت نظرة عامة على منصة Messenger ونفذت المكونات اللازمة لإرسال الرسائل والإشعارات وتلقيها.

لعرض أدوات قياس صفحة فيسبوك تملكها أو يمكنك تنفيذ مهمة ANALYZE عليها، سيحتاج تطبيقك إلى ما يلي:

  • معرف الصفحة لصفحة فيسبوك التي تريد عرض أدوات القياس الخاصة بها
    • فيما يتعلق بمراسلة Instagram، سيتعين توفير صفحة فيسبوك مرتبطة بحساب Instagram الاحترافي
  • رمز وصول صفحة
  • الأذونات التالية:
    • pages_messaging
    • pages_read_engagement
    • pages_show_list
    • read_insights
  • الوصول القياسي

لعرض أدوات القياس لصفحة فيسبوك لا تملكها أو لا يمكنك تنفيذ مهمة ANALYZE عليها، سيحتاج تطبيقك إلى:

  • معرف الصفحة لصفحة فيسبوك التي تريد عرض أدوات القياس الخاصة بها
    • فيما يتعلق بمراسلة Instagram، سيتعين توفير صفحة فيسبوك مرتبطة بحساب Instagram الاحترافي
  • رمز وصول الصفحة الذي يطلبه شخص يمكنه تنفيذ المهمة ANALYZE بالصفحة
  • الأذونات التالية عبر تسجيل دخول فيسبوك:
    • pages_messaging
    • pages_read_engagement
    • pages_show_list
    • read_insights
  • الوصول المتقدم

التقييدات

  • حتى يتم احتساب محادثة جديدة، يجب أن يكون الشخص قد اتخذ إجراءً، مثل إرسال رد إلى نشاطك التجاري. حتى يتخذ الشخص هذا الإجراء، تظهر المحادثة للشخص فقط ولا يتم احتسابها.

قراءة أدوات قياس الرؤى

لقراءة معلومات حول أداة قياس واحدة أو أكثر، أرسِل طلب GET إلى نقطة نهاية /PAGE-ID/insights يتضمن معلمة metric تم تعيينها لقائمة أدوات قياس المفصولة بفاصلة التي تريد الاطّلاع عليها.

عينة من الطلب

تم التنسيق لإمكانية القراءة.
curl -X GET "https://graph.facebook.com/LATEST-API-VERSION/PAGE-ID/insights
    ?metric=page_messages_new_conversations_unique,page_messages_blocked_conversations_unique 
    &access_token=PAGE-ACCESS-TOKEN"

عند نجاح العملية، سيتلقى تطبيقك استجابة JSON التالية:

{ 
  "data": [ 
    { 
      "name": "page_messages_new_conversations_unique", 
      "period": "day", 
      "values": [ 
        { 
          "value": "42", 
          "end_time": "1665175977" 
        }, 
      ]
    },
    { 
      "name": "page_messages_blocked_conversations_unique", 
      "period": "day", 
      "values": [ 
        { 
          "value": "0", 
          "end_time": "1665175977" 
        }, 
      ]
    } 
  ],
}

عينة من الطلب ضمن فترة زمنية إجمالية

يتناول المثال التالي إجمالي عدد المحادثات الفريدة الجديدة على مدار فترة زمنية محددة عن طريق تضمين المعلمة period المعينة إلى total_over_range مع النطاق الزمني المحدد بواسطة since ومعلمات until في استدعاء API.

تم التنسيق لإمكانية القراءة.
curl -i -X GET "https://graph.facebook.com/LATEST-API-VERSION/PAGE-ID/insights/
    ?metric=page_messages_new_conversations_unique
    &since=UNIX-TIMESTAMP-START
    &until=UNIX-TIMESTAMP-STOP
    &period=total_over_range
    &access_token=PAGE-ACCESS-TOKEN"

عند النجاح، سيتلقى تطبيقك استجابة JSON التالية مع عدد المحادثات الفريدة الجديدة ونهاية النطاق الزمني:

{
  "data": [
    {
      "name": "page_messages_new_conversations_unique",
      "period": "total_over_range",
      "values": [
        {
          "value": 27
          "end_time": "1665175977"
        }
      ],
    }
  ]
}

عينة من طلب التقسيم

يتناول المثال التالي إجمالي عدد رموز الإشعارات المتكررة خلال فترة زمنية محددة ومصنفة حسب الموضوع والتكرار.

curl -i -X GET "https://graph.facebook.com/LATEST-API-VERSION/PAGE-ID/insights/
    ?metric=recurring_notifications_tokens   
    &since=UNIX-TIMESTAMP-START
    &until=UNIX-TIMESTAMP-STOP
    &period=total_over_range
    &breakdown=recurring_notifications_topic,recurring_notifications_frequency 
    &access_token=PAGE-ACCESS-TOKEN"

عند نجاح العملية، سيتلقى تطبيقك استجابة JSON التالية مع رموز مجمعة حسب الموضوع، "newproducts" و"10percentsale"، ومعدل تكرار الرسائل المتوفر لكل موضوع، "يومي" و"أسبوعي" و"شهري" لـ "newproducts" و"يومي" و"أسبوعيا" لـ "10percentsale":

{
  "data": [
    {
      "name": "recurring_notifications_tokens",
      "period": "total_over_range",
      "values": [ 
        {
          "value": 3,
          "end_time": "1665175977",
          "recurring_notifications_topic": "newproducts",
          "recurring_notifications_frequency": "daily"
        },
        {
          "value": 15,
          "end_time": "1665175977",
          "recurring_notifications_topic": "newproducts",
          "recurring_notifications_frequency": "weekly"
        },
        {
          "value": 8,
          "end_time": "1665175977",
          "recurring_notifications_topic": "newproducts",
          "recurring_notifications_frequency": "monthly"
        },
        {
          "value": 17,
          "end_time": "1665175977",
          "recurring_notifications_topic": "10percentsale",
          "recurring_notifications_frequency": "daily"
        },
        {
          "value": 14,
          "end_time": "1665175977",
          "recurring_notifications_topic": "10percentsale",
          "recurring_notifications_frequency": "weekly"
        },
      ]
    }
  ]
}

معلمات الرؤى

المعلمة الوصف

breakdown

الأبعاد التي يتم تجميع الاستجابة بها. قد تكون واحدة أو أكثر مما يلي:

الاسمالوصف

campaign_id

يمكن عرض البيانات حسب رقم معرف الحملة الإعلانية. الأمثلة هي "abc123" و"حملة الصيف الإعلانية المستندة إلى المراسلة" و"تخفيضات الربيع 2"

engagement_source

يمكن عرض البيانات حسب نوع التفاعل مع الإشعارات المتكررة. الأمثلة هي معرف الدعوة لاتخاذ الإجراء الأساسي والثانوي (أي دعوة لاتخاذ إجراء تم النقر عليها)

message_type

يمكن عرض البيانات حسب نوع الرسالة التي أرسلها النشاط التجاري. الأمثلة هي الرسائل التسويقية

messaging_channel

يمكن عرض البيانات حسب القناة المستخدمة لتسليم الرسائل إلى المستخدمين. الأمثلة هي Messenger وInstagram

recurring_notifications_entry_point

يمكن عرض البيانات حسب نقطة الإدخال في الإشعارات المتكررة. الأمثلة هي سلسلة الرسائل والمكون الإضافي "دردشة" وإعلانات النقر لفتح محادثة في Messenger والمكون الإضافي"مربع الاختيار" وروابط m.me أو ig.me وصفحة فيسبوك

recurring_notifications_frequency

يمكن عرض البيانات حسب معدل تكرار المسموح من خلال اشتراك الإشعارات المتكررة. الأمثلة هي يوميًا وأسبوعيًا وشهريًا

recurring_notifications_topic

يمكن عرض البيانات حسب موضوع الإشعارات المتكررة. الأمثلة هي الرسائل الترويجية وعمليات طرح المنتجات والعروض

date_preset

نطاق التاريخ النسبي والذي يمكن استخدامه بدلاً من since وuntil. قد يكون last_week وlast_month وlast_quarter وغير ذلك الكثير. اطلع على المزيد من القيم في دليل رؤى الصفحات.

metric

مطلوب. قائمة مفصولة بفاصلة تضم أدوات القياس المطلوب إرجاعها

period

التجميع المقدَّم ضمن نطاق منذ/حتى أو نطاق date_preset. تقدم قيمة total_over_range قيمة واحدة لأداة القياس على مدار نطاق التاريخ المحدد. قد تكون day أو week أو month أو days_28 أو total_over_range.

since

تاريخ بدء نطاق التاريخ الذي ترغب في عرض البيانات خلاله. يتضمن بيانات التاريخ المحدد بدءًا من الساعة 12:00 صباحًا. تنسيق القيمة هو YYYY-MM-DD. ستوفر القيمة 2022-01-31 البيانات من 31 يناير 2022 الساعة 12:00 صباحًا.

until

تاريخ انتهاء نطاق التاريخ الذي ترغب في عرض البيانات خلاله. يُستثنى بيانات التاريخ المحدد بدءًا من الساعة 12:00 صباحًا. تنسيق القيمة هو YYYY-MM-DD. ستوفر القيمة 2022-02-01 البيانات حتى 31 يناير 2022 الساعة 11:59 مساءً.

أدوات القياس المتوفرة

تتوفر أدوات القياس التالية عبر API رؤى المراسلات:

metric الاسمالوصف

page_messages_blocked_conversations_unique

عدد المحادثات مع الصفحة التي تم حظرها.

page_messages_engagement

عدد مرات تفاعل العملاء مع الرسائل التسويقية التي أرسلتها صفحة نشاطك التجاري، عن طريق الضغط على زر دعوة لاتخاذ إجراء.

قيم breakdown الممكنة:

  • campaign_id
  • engagement_source
  • message_type
  • messaging_channel
  • recurring_notifications_topic

أداة القياس هذه قيد التطوير.

page_messages_new_conversations_unique

عدد محادثات المراسلة على Messenger التي بدأت مع أشخاص لم يراسلوا نشاطك التجاري من قبل.

page_messages_order_count

عدد المرات التي قمت فيها بإنشاء طلب في المحادثات عبر الرسائل أو في التطبيقات أو مواقع الويب التابعة لجهات خارجية المستخدمة لإدارة المحادثات عبر الرسائل.


أداة القياس هذه قيد التطوير.

page_messages_paid_order_earnings

المبلغ المالي التقريبي الذي ربحته من الطلبات التي تم إنشاؤها من خلال محادثات المراسلات أو من خلال تطبيقات أو مواقع ويب الجهات الخارجية المستخدمة لإدارة محادثات المراسلات. قد تختلف الأرباح النهائية نتيجةً لتحويلات العملة.


أداة القياس هذه قيد التطوير.

page_messages_read_ratio

عدد الرسائل التسويقية المقروءة مقسومًا على عدد الرسائل التسويقية المرسلة بواسطة صفحتك.

قد لا يتم تسجيل بعض مرات قراءة الرسائل، كما في حالة قيام أحد العملاء بإيقاف تشغيل مؤشرات قراءة الرسائل.

قيم breakdown الممكنة:

  • campaign_id
  • message_type
  • messaging_channel
  • recurring_notifications_topic

أداة القياس هذه قيد التطوير.

page_messages_reported_conversations_unique

عدد المحادثات من صفحتك التي تم الإبلاغ عنها من قِبَل الأشخاص لأسباب مثل المحتوى غير المهم أو الاحتيالي أو احتوائها على محتوى غير لائق.

page_messages_sent

عدد الرسائل التسويقية التي أرسلتها صفحة نشاطك التجاري إلى العملاء.


قيم breakdown الممكنة:

  • campaign_id
  • messsage_type
  • messaging_channel
  • recurring_notifications_topic

أداة القياس هذه قيد التطوير.

page_messages_total_messaging_connections

عدد الأشخاص الذين يمكن لنشاطك التجاري إرسال رسائل إليهم.


تعرض أداة القياس هذه عدد الأشخاص الذين أرسلوا رسالة إلى نشاطك التجاري على Messenger، دون تضمين الأشخاص الذين قاموا بحظر نشاطك التجاري أو أبلغوا عنه على Messenger. قد تكون هناك بعض القيود على قدرتك على إرسال رسائل إلى جهات التواصل، مثل القيود على عدد الرسائل التي يمكنك إرسالها خلال أُطر زمنية معينة. تشمل أداة القياس هذه أيضًا جهات التواصل التي تمت إضافتها منذ شهر أكتوبر 2016 عند توفُّر البيانات.

page_messages_with_business_outcomes

عدد جهات التواصل عبر الرسائل مع طلب واحد على الأقل تم إنشاؤه.


أداة القياس هذه قيد التطوير.

recurring_notifications_tokens

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


كيفية الاحتساب: تحسب أداة القياس هذه عدد مرات موافقة الحسابات على استلام الرسائل المتكررة ناقصًا عدد مرات إلغاء اشتراك الحسابات.


قيم breakdown الممكنة:

  • messaging_channel
  • recurring_notifications_frequency
  • recurring_notifications_topic

أداة القياس هذه قيد التطوير.

تعرَّف على المزيد حول أدوات القياس قيد التطوير.

خصائص الاستجابة

يمكن إرجاع المعلومات التالية في مكالمة مع API الرؤى.

الخاصية الوصف

data

array of objects (مصفوفة الكائنات)

قائمة بكائنات أدوات القياس

name
string (سلسلة)

اسم أداة القياس

period
string (سلسلة)

الفترة الزمنية التي تم خلالها تسجيل البيانات

values
array of objects (مصفوفة الكائنات)

قائمة البيانات الخاصة بأداة القياس.

value
int (عدد صحيح)

عدد أداوات القياس المطلوبة خلال نطاق التاريخ المحدد

end_time
unix timestamp (طابع unix الزمني)

طابع UTC الزمني لوقت انتهاء أداة القياس