الإصدار 2 من واجهة API إعداد التقارير

يوضح هذا الدليل كيفية تنفيذ الإصدار 2 من API إعداد تقارير Audience Network للحصول بيانات الأداء للنشاط التجاري.

المتطلبات الأساسية

التوصيات

  • نظرًا إلى الكميات الكبيرة من البيانات التي تم إرجاعها في كل استعلام، يوصى بتقسيم الصفحات استنادًا إلى المؤشر . يتم إرجاع النتائج المقسمة فورًا للطلبات المتزامنة وهو الأسلوب المفضل لاسترجاع التقسيمات.

التقييدات

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

تحديثات التجميع

مرات الظهور والإيرادات اليومية

يمكنك الاستعلام عن عدد مرات الظهور والإيرادات للموضع من1-4 مايو 2022 من خلال التقسيم اليومي.

التغييرات التي قد تحدث: قد ترى أن بعض البيانات غير متوفرة بعد التغيير.

لن يتم تضمين الإيرادات ونقاط بيانات التكلفة لكل ألف ظهور غير المتوفرة في حقل results من استجابة واجهة API نتيجةً لعدد مرات ظهور الإعلانات غير الكافي. بدلاً من ذلك، ستتم إضافة الإدخالات المقابلة إلى حقل omitted_results. ستتضمن حقول الوقت وأداة القياس والتقسيمات، ولكن لن تتضمن القيمة، يُرجى الرجوع إلى عينة من الاستجابة في الجزء السفلي من هذه الصفحة.

بنية الطلب

استخدم نقطة نهاية GET ID > adnetworkanalytics للحصول على رؤى audience network لأي نشاط تجاري أو خاصية أو تطبيق.

GET /<ID>/adnetworkanalytics

مثال على طلب GET

للحصول على رؤى، أرسل طلب GET إلى نقطة النهاية /<ID>/adnetworkanalytics مع قائمة مفصولة بفاصلة لأدوات القياس وقائمة مفصولة بفاصلة اختيارية للتقسيمات حيث يكون <ID> هو معرف النشاط التجاري أو معرف الخاصية أو معرف التطبيق من Meta. يحصل المثال التالي على أدوات القياس على مدار مدة 24 ساعة فردية مع تقييد النتائج إلى استجابتين لكل أداة قياس.

تم التنسيق لإمكانية القراءة. تأكد من استبدال قيم العنصر النائب الغامقة والمائلة بالقيم المتوفرة لديك.
curl -X GET https://graph.facebook.com/v19.0/BUSINESS_ID/adnetworkanalytics
  ?metrics=["fb_ad_network_request","fb_ad_network_imp","fb_ad_network_click","fb_ad_network_revenue"]
  &breakdowns=["placement","country"]
  &since=2021-08-06
  &until=2021-08-06
  &limit=2

مثال على الاستجابة

{
  "data": [
    {
      "query_id": "531234567890123456789012345683d6",
      "results": [
        {
          "time": "2021-08-06T07:00:00+0000",
          "metric": "fb_ad_network_imp",
          "breakdowns": [
            {
              "key": "placement",
              "value": "123456789012345"
            },
            {
              "key": "country",
              "value": "AE"
            }
          ],
          "value": "1200"
        },
        {
          "time": "2021-08-06T07:00:00+0000",
          "metric": "fb_ad_network_imp",
          "breakdowns": [
            {
              "key": "placement",
              "value": "123456789012345"
            },
            {
              "key": "country",
              "value": "AU"
            }
          ],
          "value": "35"
        },
        {
          "time": "2021-08-06T07:00:00+0000",
          "metric": "fb_ad_network_revenue",
          "breakdowns": [
            {
              "key": "placement",
              "value": "123456789012345"
            },
            {
              "key": "country",
              "value": "AE"
            }
          ],
          "value": "21.212345"
        },
        {
          "time": "2021-08-06T07:00:00+0000",
          "metric": "fb_ad_network_request",
          "breakdowns": [
            {
              "key": "placement",
              "value": "123456789012345"
            },
            {
              "key": "country",
              "value": "AD"
            }
          ],
          "value": "1"
        },
        {
          "time": "2021-08-06T07:00:00+0000",
          "metric": "fb_ad_network_request",
          "breakdowns": [
            {
              "key": "placement",
              "value": "123456789012345"
            },
            {
              "key": "country",
              "value": "AE"
            }
          ],
          "value": "12"
        },
        {
          "time": "2021-08-06T07:00:00+0000",
          "metric": "fb_ad_network_click",
          "breakdowns": [
            {
              "key": "placement",
              "value": "123456789012345"
            },
            {
              "key": "country",
              "value": "AE"
            }
          ],
          "value": "1"
        },
        {
          "time": "2021-08-06T07:00:00+0000",
          "metric": "fb_ad_network_click",
          "breakdowns": [
            {
              "key": "placement",
              "value": "123456789012345"
            },
            {
              "key": "country",
              "value": "CA"
            }
          ],
          "value": "2"
        }
      ],
      "omitted_results": [
        {
          "time": "2021-08-06T07:00:00+0000",
          "metric": "fb_ad_network_revenue",
          "breakdowns": [
            {
              "key": "placement",
              "value": "123456789012345"
            },
            {
              "key": "country",
              "value": "AU"
            }
          ]
        }
      ]
    }
  ],
  "paging": {
    "cursors": {
      "before": "MAZDZD",
      "after": "MQZDZD"
    },
    "next": "https://graph.facebook.com/v10.0/142440604406900/adnetworkanalytics?access_token=<ACCESS_TOKEN>&since=2021-08-06&until=2021-08-06&breakdowns=%5B%22placement%22%2C%22country%22%5D&limit=2&metrics=%5B%22fb_ad_network_request%22%2C%22fb_ad_network_imp%22%2C%22fb_ad_network_click%22%2C%22fb_ad_network_revenue%22%5D&after=MQZDZD"
  }
}

المرجع

معلمات الاستعلام

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

aggregation_period

aggregation_period=hour|day|total


تجميع النتائج حسب day (الإعداد الافتراضي) أو hour أو total. التقييدات: لتجميع النتائج حسب الساعة، عليك الاستعلام عن النتائج لمدة يومين على الأقل باستخدام since وuntil.

breakdowns

breakdowns=['breakdown_1', 'breakdown_2',...]


لا يوجد حد أقصى لعدد التقسيمات التي يمكن تضمينها في الطلبات المتزامنة.

أنواع التقسيماتالوصف

ad_space

يمثل التقسيم حسب المساحة الإعلانية

country

التقسيم حسب البلد

delivery_method

التقسيم إما حسب standard أو bidding عندما تأتي أداة القياس من إعلان تم عرضه عبر عروض أسعار Audience Network. لا يتوفر إلا للناشرين الذين يستخدمون مدير الأرباح.

fail_reason

لا يتوفر إلا لأداتي القياس fb_ad_network_no_fill وfb_ad_network_no_bid.

placement

يمثل التقسيم حسب معرف الموضع. يتعذر استخدامه مع placement_name.

placement_name

التقسيم حسب معرف الموضع واسمه. يتعذر استخدامه مع placement.

platform

التقسيم حسب المنصة. ios أو android أو mobile_web أو instant_games. لا يتوفر إلا للناشرين الذين يستخدمون مدير الأرباح.

property

التقسيم حسب معرف الخاصية

filters

filters=[{'field':'country', 'operator':'in', 'values':['US', 'JP']}]


فلترة الاستجابات للحصول على المزيد من النتائج المحددة. أزواج القيم الأساسية field وoperator وvalues مطلوبة. حيث إن values هي قائمة مفصولة بفاصلة للقيم. لا يتم حاليًا سوى دعم المشغّل in.

fieldvalues

country

قائمة مفصولة بفاصلة لاختصارات البلد من حرفين

placement

معرفات الموضع. التقييدات:REDACTED إذا كان عدد مرات ظهور الإعلان غير كافي.

delivery_method

standard أو bidding

platform

يمكن أن يكون ios (تطبيق هاتف محمول) أو android (تطبيق هاتف محمول) أو mobile_web أو instant_games.

limit

limit=500


عدد الصفوف التي سيتم إرجاعها. التقييدات: يتوفر لدى الطلبات المتزامنة حد أقصى 2,000.

metrics

مطلوب.


metrics=['metric_1', 'metric_2',...]


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

ordering_column

ordering_column=time|value


الترتيب حسب النتائج بالوقت أو القيمة. يتم التعيين افتراضيًا على time في حالة عدم تضمينه.

ordering_type

ordering_column=ascending|descending


يتم التعيين افتراضيًا على descending في حالة عدم تضمينه.

since

since=YYYY-MM-DD أو since=1548880485


يمثل الحد الأقصى لبداية الاستعلام. يتم التعيين افتراضيًا على آخر 7 أيام في حالة عدم التضمين.

التقييدات:

  • لاستخدام الطوابع الزمنية بتنسيق Unix، يجب الاستعلام عن ساعة واحدة على الأقل.
  • يمكنك طلب ما يصل إلى 8 أيام في الطلبات المتزامنة.
  • يتم الاحتفاظ بالبيانات لمدة 540 يومًا فقط. لن ترجع الطلبات للبيانات بعد $currentDate - 539 days بيانات إضافية.

until

until=YYYY-MM-DD أو until=1548880485+86400


الحد الأقصى لنهاية الاستعلام

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

أداة القياسالوصف

fb_ad_network_bidding_bid_rate

معدل استجابات عروض الأسعار

fb_ad_network_bidding_request

عدد طلبات عروض الأسعار

fb_ad_network_bidding_response

عدد استجابات عروض الأسعار

fb_ad_network_bidding_win_rate

معدل مرات فوز مقدم عرض الأسعار بالمزاد

fb_ad_network_click

عدد النقرات

fb_ad_network_cpm

التكلفة الفعالة لكل ألف ظهور (eCPM)

fb_ad_network_ctr

المعدل التقديري للنقر

fb_ad_network_fill_rate

معدل تعبئة طلبات عرض الإعلانات

fb_ad_network_filled_request

عدد مرات تعبئة طلبات عرض الإعلانات

fb_ad_network_imp

عدد مرات ظهور الإعلان

fb_ad_network_no_bid

يمثل عدد أبرز أسباب عدم تقديم عرض الأسعار


لا يتوفر إلا إذا كان مُستخدَمًا كأداة قياس واحدة لتقسيم fail_reason

fb_ad_network_no_fill

يمثل عدد أبرز أسباب عدم التعبئة


لا يتوفر إلا إذا كان مُستخدَمًا كأداة قياس واحدة لتقسيم fail_reason

fb_ad_network_request

طلبات عرض الإعلانات

fb_ad_network_revenue

الإيرادات التقديرية

fb_ad_network_show_rate

مرات الظهور المُقسمة حسب التعبئة

استكشاف الأخطاء وإصلاحها

مصحح أخطاء رمز الوصول

استخدم أداة تصحيح رمز الوصول للحصول على المعلومات التفصيلية حول رمز الوصول، بما في ذلك الأذونات والصلاحية والوصول إلى الأصول ومعرف التطبيق المرتبط بالرمز.

رسائل الخطأ

رسالة خطأ / مشكلةالحل

رمز منتهي الصلاحية

لتوفير أفضل تجربة مستخدم، استخدِم رموز وصول طويلة الأجل

"اكتشف فيسبوك أن [تطبيقك] لا يستخدم شبكة اتصال آمنة لنقل الأخطاء في المعلومات عند استخدام نطاق read_audience_network_insights".

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

"قراءة رؤى خاصة بصفحة أو نشاط تجاري أو تطبيق أو نطاق أو مجموعة مصادر حدث غير مملوكة للمستخدم أو التطبيق المستعلِم".

راجِع إعدادات النشاط التجاري للتأكُّد من طلبك لبيانات مملوكة للنشاط التجاري الذي تقوم بالاستعلام له.

"طلب GET غير مدعوم. والكائن بالمعرف 'X' غير موجود ولا يمكن تحميله بسبب الأذونات المفقودة أو لأنه لا يدعم هذه العملية. اطَّلع على وثائق واجهة Graph API".

راجِع الأصل للتأكُّد من طلبك لبيانات الأصل الذي تمتلكه.

"لقد تم تغيير طريقة الوصول إلى الإصدار 2 من "واجهة API إعداد التقارير". عليك الآن تنفيذ تسجيل دخول فيسبوك ليتمكن تطبيقك من الوصول إلى API هذه. اطَّلِع على التعليمات هنا: https://developers.facebook.com/docs/facebook-login/"

لقد حاولت الاستعلام عن الإصدار 2 من "واجهة API إعداد التقارير" باستخدام رمز مستخدم النظام. لذا؛ استخدِم تسجيل دخول فيسبوك لإجراء استعلامات أو أعِد استخدام الإصدار 1 (ولكن ستحتاج إلى تنفيذ تسجيل دخول فيسبوك على كل حال في المستقبل).

"arg سيئ: يجب أن تمتلك جميع التطبيقات أصلاً"

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

""يُرجى تقليل كم البيانات الذي تطالب به، ثم أعِد محاولة إرسال الطلب".

  • إذا كنت تستخدم فترة التجميع بالقيمة day أو hour، فيمكنك تعيين قيمة أقل في المعلمة limit.
  • إذا كنت تستخدم فترة التجميع بالقيمة total، فقلل مدة نطاق التاريخ المحدد حسب المعلمات since/until.

"يمكنك إجراء 250 استعلامًا في الدقيقة بحد أقصى"

تتيح إصدار 2 من "واجهة API إعداد التقارير" إنشاء طلبات باستخدام معلمات متعددة، واستخدام تقسيم الصفحات. يُرجى الاطلاع على طرق استخدام طلبات API أقل إن أمكن.