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 هو 1000، فإن طلب 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)

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

object (MetricHeader)

لوصف أعمدة المقاييس. يتطابق عدد MetricHeaders وترتيبها 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

ResponseMetaData

البيانات الوصفية للردّ التي تتضمّن معلومات إضافية عن محتوى التقرير

تمثيل JSON 
{
  "dataLossFromOtherRow": boolean,
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
الحقول
dataLossFromOtherRow

boolean

إذا كانت القيمة صحيحة، يشير ذلك إلى أنّه يتمّ تضمين بعض مجموعات مجموعات السمات في الصف "(other)". وقد يحدث ذلك في التقارير التي تتضمّن عددًا كبيرًا من القيم.

تتم تعبئة بيانات مَعلمة البيانات الوصفية dataLossFromOtherRow استنادًا إلى جدول البيانات المجمَّعة المستخدَمة في التقرير. ستتمّ تعبئة المَعلمة بدقة بغضّ النظر عن الفلاتر والقيود الواردة في التقرير.

على سبيل المثال، يمكن حذف الصف (other) من التقرير لأنّ الطلب يحتوي على فلتر في sessionSource = google. ستتم تعبئة هذه المَعلمة في حال عدم ظهور بيانات من صف آخر ضمن البيانات المجمّعة التي تم إدخالها لإنشاء هذا التقرير.

لمزيد من المعلومات، يُرجى الاطّلاع على المقالة لمحة عن صف (other) وتحليل عينات البيانات.
schemaRestrictionResponse

object (SchemaRestrictionResponse)

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

string

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

رموز العملات هي ترميزات سلاسل لأنواع العملات وفقًا لمعيار ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217)، على سبيل المثال USD وEUR وJPY. لمعرفة المزيد من المعلومات، يُرجى الاطّلاع على https://support.google.com/analytics/answer/9796179.
timeZone

string

تشير هذه السمة إلى المنطقة الزمنية الحالية للموقع. مخصَّصة لتفسير السمات المستندة إلى الوقت، مثل hour وminute. ويتم تنسيقها كسلاسل من قاعدة بيانات المنطقة الزمنية التي وضعتها هيئة أرقام الإنترنت المخصصة (IANA) (https://www.iana.org/time-zones)، على سبيل المثال "America/New_York" أو "آسيا/طوكيو".
emptyReason

string

إذا تم تحديد سبب فارغ، يكون التقرير فارغًا لهذا السبب.
subjectToThresholding

boolean

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

SchemaRestrictionResponse

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

تمثيل JSON 
{
  "activeMetricRestrictions": [
    {
      object (ActiveMetricRestriction)
    }
  ]
}
الحقول
activeMetricRestrictions[]

object (ActiveMetricRestriction)

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

ActiveMetricRestriction

أحد المقاييس محظور بشكل نشط في إنشاء التقرير.

تمثيل JSON 
{
  "restrictedMetricTypes": [
    enum (RestrictedMetricType)
  ],
  "metricName": string
}
الحقول
restrictedMetricTypes[]

enum (RestrictedMetricType)

سبب تقييد هذا المقياس.
metricName

string

اسم المقياس المحظور.

RestrictedMetricType

فئات البيانات التي قد يُحظر عليك الاطّلاع عليها في مواقع معيّنة على "إحصاءات Google 4"

عمليات التعداد
RESTRICTED_METRIC_TYPE_UNSPECIFIED نوع غير محدَّد.
COST_DATA مقاييس التكلفة مثل adCost
REVENUE_DATA مقاييس الأرباح مثل purchaseRevenue