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. يتم أيضًا الحد من عدد الصفوف المتاحة لطلب QueryReportTask حسب الحد الأقصى لـ ReportTask المرتبط. يمكن أن يسترجع الطلب 100 صف كحد أقصى. على سبيل المثال، إذا كان الحدّ الأقصى لعدد عناصر 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)

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

ResponseMetaData

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

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

boolean

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

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

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

لمعرفة المزيد من المعلومات، اطّلِع على لمحة عن صف (other) وتحليل عيّنات البيانات.
samplingMetadatas[]

object (SamplingMetadata)

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

وفي حال عدم تحليل عيّنات من النتائج، لن يتم تحديد هذا الحقل.
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)، على سبيل المثال "أمريكا/نيويورك" أو "آسيا/طوكيو".
emptyReason

string

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

boolean

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

SchemaRestrictionResponse

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

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

object (ActiveMetricRestriction)

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

ActiveMetricRestriction

مقياس تم حظره بشكل نشط عند إنشاء التقرير

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

enum (RestrictedMetricType)

سبب حظر هذا المقياس
metricName

string

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

RestrictedMetricType

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

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