Reporting API

تتيح Reporting API للتاجر التفاعل مع بيانات الأداء آليًا من خلال "لغة طلبات البحث في Merchant Center". يشبه ذلك إمكانية إنشاء تقارير مخصّصة مباشرةً في Merchant Center. توفّر Reporting API المزايا التالية:

• تتيح هذه الميزة للتجّار الكبار استيراد بيانات الأداء الخاصة ببيانات المنتجات إلى أنظمة التقارير الداخلية أو التابعة لجهات خارجية.
• تتيح هذه الإذن للمستخدمين والشركاء الخارجيين ومجمّعي البيانات الذين يديرون حسابات على Merchant Center إمكانية الوصول إلى التقارير.

يمكن لمستخدمي واجهة برمجة التطبيقات تحديد بيانات الأداء التي يريدون استردادها في استجابة طلب البحث، مثل:

• المقاييس المطلوب عرضها (على سبيل المثال: النقرات ومرّات الظهور)
• السمات التي سيتم تقسيم البيانات على أساسها (مثلاً: OfferId أو Date)
• الشروط التي يجب استيفاؤها (على سبيل المثال: النقرات > 100)

يمكن للغة طلب البحث في Reporting API أن تطلب من Content API for Shopping مقاييس الأداء (عدد النقرات ومرات الظهور)، ويمكن تقسيمها حسب سمات مختلفة (سمات الأحداث المُبلغ عنها، مثل البرنامج والتاريخ، وسمات المنتجات، مثل العلامة التجارية والفئة وما إلى ذلك)، وذلك باستخدام الطريقة Search في الخدمة Reports.

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

طلب البحث عن المقاييس

يمكنك طلب البحث عن المقاييس (النقرات ومرّات الظهور ونسبة النقر إلى الظهور وما إلى ذلك) التي تريد عرضها. يجب إضافة فلتر على النطاق الزمني للاستعلام عن خدمة التقارير. يعرِض نموذج طلب البحث أدناه صفًا واحدًا: المبلغ الإجمالي للنقرات ضمن الشرط المضاف لنطاق زمني.

SELECT metrics.clicks
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-21';

نموذج إجابة

يوضّح نموذج استجابة رمز JSON أدناه أنّ هذا التاجر تلقّى 4,440 نقرة مجمّعة على مستوى جميع منتجاته وجميع وجهاته بين 1 كانون الأول (ديسمبر) 2020 و21 كانون الأول (ديسمبر) 2020.

{"results": [
    {
      "metrics": {
        "clicks": "4,440"
      }
    }
]}

طلب البحث عن الشرائح

بالإضافة إلى المقاييس، يمكنك أيضًا طلب البحث عن شرائح، والتي يمكن أن تكون سمة خاصة بمنتج (offer_id أو brand أو category أو غير ذلك) أو سمة خاصة بحدث تم تسجيله (date أو program). والحدث المسجّل هو ظهور المنتج أو النقر عليه.

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

SELECT
  segments.date,
  metrics.clicks
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-03'
ORDER BY metrics.clicks DESC;

نموذج إجابة

يوضّح نموذج استجابة رمز JSON أدناه أنّ هذا التاجر تلقّى 1,546 نقرة على جميع منتجاته في جميع وجهاته في 1 كانون الأول (ديسمبر) 2020، و829 نقرة على جميع منتجاته في جميع وجهاته في 2 كانون الأول (ديسمبر) 2020. لن يتم عرض أي عنصر لتاريخ 3 ديسمبر 2020 لأنّ التاجر لم يتلقَّ أي نقرات في ذلك اليوم.

{
  "results": [
    {
      "segments": {
        "date": {
          "year": 2020,
          "month": 12,
          "day": 1
        }
      },
      "metrics": {
        "clicks": "1546"
      }
    },
    {
      "segments": {
        "date": {
          "year": 2020,
          "month": 12,
          "day": 2
        }
      },
      "metrics": {
        "clicks": "829"
      }
    }
]}