Method: properties.runReport

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

للحصول على دليل حول إنشاء الطلبات وفهم الردود، يُرجى الاطّلاع على مقالة إنشاء تقرير.

طلب HTTP

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runReport

يستخدم عنوان URL بنية تحويل الترميز إلى gRPC.

مَعلمات المسار

المعلمات
property

string

معرّف موقع على "إحصاءات Google" يتم تتبُّع أحداثه. يتم تحديده في مسار عنوان URL وليس في النص. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة كيفية العثور على رقم تعريف موقعك. في طلب مجمّع، يجب ألا يتم تحديد هذا الموقع أو يجب أن يكون متطابقًا مع الموقع على مستوى الطلب المجمّع.

مثال: properties/1234

نص الطلب

يتضمن نص الطلب بيانات بالبنية التالية:

تمثيل JSON 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
الحقول
dimensions[]

object (Dimension)

السمات المطلوبة والمعروضة
metrics[]

object (Metric)

المقاييس المطلوبة والمعروضة
dateRanges[]

object (DateRange)

النطاقات الزمنية للبيانات المطلوب قراءتها في حال طلب نطاقات زمنية متعدّدة، سيحتوي كل صف من صفوف الاستجابة على فهرس نطاق زمني يبدأ من الصفر. إذا تداخل نطاقان زمنيان، يتم تضمين بيانات الأحداث للأيام المتداخلة في صفوف الاستجابة لكلا النطاقَين الزمنيين. في طلب مجموعة متماثلة، يجب عدم تحديد dateRanges.
dimensionFilter

object (FilterExpression)

تتيح لك فلاتر السمات طلب قيم سمات معيّنة فقط في التقرير. لمزيد من المعلومات، يُرجى الاطّلاع على أمثلة في مقالة أساسيات فلاتر السمات. لا يمكن استخدام المقاييس في هذا الفلتر.
metricFilter

object (FilterExpression)

بند الفلتر للمقاييس يتم تطبيقه بعد تجميع صفوف التقرير، على غرار عبارة having في لغة SQL. لا يمكن استخدام السمات في هذا الفلتر.
offset

string (int64 format)

عدد صفوف صف البدء يُحتسب الصف الأول على أنّه الصف 0.

عند استخدام تقسيم الصفحات، لا يحدّد الطلب الأول الإزاحة، أو يضبطها على 0، ويعرض الطلب الأول أول limit من الصفوف. يضبط الطلب الثاني الإزاحة على limit للطلب الأول، ويعرض الطلب الثاني ثاني limit من الصفوف.

لمزيد من المعلومات عن مَعلمة تقسيم الصفحات هذه، يُرجى الاطّلاع على مقالة تقسيم الصفحات.
limit

string (int64 format)

عدد الصفوف المطلوب عرضها إذا لم يتم تحديدها، يتم عرض 10,000 صف. تعرِض واجهة برمجة التطبيقات 250,000 صف كحد أقصى لكل طلب، بغض النظر عن عدد الصفوف التي تطلبها. يجب أن تكون قيمة limit موجبة.

يمكن أن تعرِض واجهة برمجة التطبيقات أيضًا عددًا أقل من الصفوف من limit المطلوبة، إذا لم تكن هناك قيم سمات بقدر limit. على سبيل المثال، هناك أقل من 300 قيمة ممكنة للسمة country، لذا عند إعداد تقارير عن country فقط، لا يمكنك الحصول على أكثر من 300 صف، حتى إذا ضبطت limit على قيمة أعلى.

لمزيد من المعلومات عن مَعلمة تقسيم الصفحات هذه، يُرجى الاطّلاع على مقالة تقسيم الصفحات.
metricAggregations[]

enum (MetricAggregation)

تجميع المقاييس ستظهر قيم المقاييس المجمّعة في الصفوف التي تم ضبط dimensionValues فيها على "RESERVED_(MetricAggregation)". سيتم تجميع الإحصاءات المجمّعة التي تتضمّن كلاً من المقارنات والنطاقات الزمنية المتعدّدة استنادًا إلى النطاقات الزمنية.
orderBys[]

object (OrderBy)

تحدّد هذه المَعلمة كيفية ترتيب الصفوف في الاستجابة. ستخضع الطلبات التي تتضمّن كلاً من المقارنات والنطاقات الزمنية المتعدّدة لعمليات الترتيب حسب المقارنات.
currencyCode

string

رمز عملة بتنسيق ISO4217، مثل "AED" أو "USD" أو "JPY" إذا كان الحقل فارغًا، يستخدم التقرير العملة التلقائية للموقع.
cohortSpec

object (CohortSpec)

مجموعة المستخدِمين المتماثلة المرتبطة بهذا الطلب إذا كانت هناك مجموعة مستخدِمين متماثلة في الطلب، يجب أن تكون سمة "المجموعة المتماثلة" موجودة.
keepEmptyRows

boolean

إذا كانت القيمة false أو لم يتم تحديدها، لن يتم عرض كل صف تكون فيه جميع المقاييس مساوية للصفر. إذا كانت القيمة true، سيتم عرض هذه الصفوف إذا لم تتم إزالتها بشكل منفصل بواسطة فلتر.

بغض النظر عن إعداد keepEmptyRows هذا، لا يمكن عرض سوى البيانات التي سجّلها موقع على "إحصاءات Google" في التقرير.

على سبيل المثال، إذا لم يسجّل أحد المواقع مطلقًا حدث purchase، لن يتضمّن طلب البحث عن سمة eventName ومقياس eventCount صفًا باسم الحدث: "purchase" وعدد الأحداث: 0.
returnPropertyQuota

boolean

يؤدي هذا الخيار إلى تبديل ما إذا كان سيتم عرض الحالة الحالية لحصة موقع "إحصاءات Google" هذا. يتم عرض الحصة في PropertyQuota.
comparisons[]

object (Comparison)

اختياريّ. إعداد المقارنات المطلوبة والمعروضة لا يتطلّب الطلب سوى حقل comparisons لتلقّي عمود مقارنة في الاستجابة.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نصها على مثال RunReportResponse.

نطاقات الأذونات

يجب توفير أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics