Method: properties.batchRunReports

عرض تقارير متعددة بشكل مجمّع يجب أن تكون جميع التقارير لموقع "إحصاءات Google" 4 نفسه.

طلب HTTP

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

يستخدم عنوان URL بنية gRPC Transcoding.

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

المَعلمات
property

string

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

مثال: الخصائص/1234

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

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

object (RunReportRequest)

الطلبات الفردية. لكل طلب رد منفصل في التقرير. يُسمح لكل طلب مجمّع بما يصل إلى 5 طلبات.

نص الاستجابة

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

استجابة مجمّعة تحتوي على تقارير متعددة.

تمثيل JSON
{
  "reports": [
    {
      object (RunReportResponse)
    }
  ],
  "kind": string
}
الحقول
reports[]

object (RunReportResponse)

ردود فردية. لكل ردّ طلب تقرير منفصل.

kind

string

لتحديد نوع المورد لهذه الرسالة. ويكون kind دائمًا هو السلسلة الثابتة "analyticsData#batchRunReporting&quot. يفيد في التمييز بين أنواع الاستجابة في JSON.

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

يتطلّب أحد نطاقات OAuth التالية:

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

طلب تقرير

طلب إنشاء تقرير.

تمثيل JSON
{
  "property": string,
  "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
}
الحقول
property

string

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

مثال: الخصائص/1234

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 صف. تعرض واجهة برمجة التطبيقات 100,000 صف كحد أقصى لكل طلب، بغض النظر عن العدد الذي تطلبه. يجب أن تكون قيمة limit موجبة.

يمكن أن تعرض واجهة برمجة التطبيقات أيضًا صفوفًا أقل من الصفوف المطلوبة limit، إذا لم تكن هناك قيم أبعاد مثل limit. على سبيل المثال، هناك أقل من 300 قيمة محتملة للسمة "country"، لذا عند إعداد التقارير عن "country" فقط، لا يمكنك الحصول على أكثر من 300 صف، حتى إذا ضبطت limit على قيمة أعلى.

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

metricAggregations[]

enum (MetricAggregation)

تجميع المقاييس سيتم عرض قيم المقياس المجمّعة في الصفوف التي يتم فيها ضبط قيم ValueTrack على &&;;ERERVED_(MetricAggregation)&quot؛

orderBys[]

object (OrderBy)

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

currencyCode

string

رمز عملة بتنسيق ISO4217، مثل "AED","USD"&&;;JPY" وإذا كان الحقل فارغًا، يستخدم التقرير العملة التلقائية للموقع.

cohortSpec

object (CohortSpec)

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

keepEmptyRows

boolean

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

returnPropertyQuota

boolean

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