Method: properties.runReport

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

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

طلب HTTP

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

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

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

المَعلمات
property

string

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

مثال: Property/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
}
الحقول
dimensions[]

object (Dimension)

السمات المطلوبة وعرضها.

metrics[]

object (Metric)

المقاييس المطلوبة وعرضها.

dateRanges[]

object (DateRange)

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

dimensionFilter

object (FilterExpression)

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

metricFilter

object (FilterExpression)

عبارة فلتر المقاييس تُطبق بعد تجميع صفوف التقرير، على غرار 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)

تجميع المقاييس سيتمّ عرض قيم المقاييس المجمَّعة في الصفوف التي يتم فيها ضبط قيم السمة على "RESERVED_(MetricAggregation)".

orderBys[]

object (OrderBy)

لتحديد كيفية ترتيب الصفوف في الاستجابة.

currencyCode

string

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

cohortSpec

object (CohortSpec)

مجموعة مجموعات نموذجية مرتبطة بهذا الطلب. إذا كانت هناك مجموعة نموذجية في الطلب، يجب أن تتوفّر سمة "المجموعة النموذجية".

keepEmptyRows

boolean

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

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

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

returnPropertyQuota

boolean

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

نص الاستجابة

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

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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