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)

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

object (MetricHeader)

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

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

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

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

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

object (SchemaRestrictionResponse)

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

string

رمز العملة المستخدَم في هذا التقرير. مخصص للاستخدام في تنسيق مقاييس العملة مثل purchaseRevenue للتمثيل البصري إذا تم تحديد 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)

يتم فرض جميع القيود بشكل نشط في إنشاء التقرير. على سبيل المثال، تتضمّن 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.