Method: properties.reportTasks.query

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

طلب HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query

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

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

المعلمات
name

string

الحقل مطلوب. اسم مصدر التقرير التنسيق: properties/{property}/reportTasks/{report}

نص الطلب

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

تمثيل JSON 
{
  "offset": string,
  "limit": string
}
الحقول
offset

string (int64 format)

اختياريّ. عدد الصفوف في صف البداية في التقرير يتم احتساب الصف الأول على أنّه الصف 0.

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

لمزيد من المعلومات عن مَعلمة التقسيم إلى صفحات، اطّلِع على التقسيم إلى صفحات.
limit

string (int64 format)

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

يمكن أن تعرض واجهة برمجة التطبيقات أيضًا عددًا أقل من الصفوف من limit المطلوب، إذا لم تتوفر قيم سمات بعدد limit. يتم تقييد عدد الصفوف المتاحة لـ QueryReportTaskRequest بشكل أكبر من خلال الحدّ الأقصى لـ ReportTask المرتبط. يمكن أن يسترد طلب البحث ReportTask.limit صفوفًا كحدّ أقصى. على سبيل المثال، إذا كان ReportTask يتضمّن حدًا أقصى يبلغ 1,000، سيعرض طلب reportTasks.query الذي يتضمّن offset=900 وlimit=500 ما يصل إلى 100 صف.

لمزيد من المعلومات عن مَعلمة التقسيم إلى صفحات، اطّلِع على التقسيم إلى صفحات.

نص الاستجابة

محتوى التقرير الذي يتوافق مع مهمة التقرير

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  }
}
الحقول
dimensionHeaders[]

object (DimensionHeader)

تصف أعمدة السمات. يتطابق عدد DimensionHeaders وترتيبها مع السمات المتوفّرة في الصفوف.
metricHeaders[]

object (MetricHeader)

تصف هذه السمة أعمدة المقاييس. يتطابق عدد MetricHeaders وترتيبها مع المقاييس المتوفّرة في الصفوف.
rows[]

object (Row)

صفوف تتضمّن مجموعات من قيم السمات وقيم المقاييس في التقرير
totals[]

object (Row)

إذا طُلب ذلك، القيم الإجمالية للمقاييس
maximums[]

object (Row)

تمثّل هذه السمة الحد الأقصى لقيم المقاييس، إذا طُلب ذلك.
minimums[]

object (Row)

تمثّل هذه السمة الحد الأدنى لقيم المقاييس، إذا طُلب ذلك.
rowCount

integer

تمثّل هذه السمة إجمالي عدد الصفوف في نتيجة طلب البحث.
metadata

object (ResponseMetaData)

بيانات وصفية للتقرير

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

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

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