Method: properties.batchRunReports

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

طلب HTTP

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

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

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

المعلمات
property

string

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

مثال: properties/1234

نص الطلب

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

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

object (RunReportRequest)

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

نص الاستجابة

الردّ المجمّع الذي يحتوي على تقارير متعددة

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

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

object (RunReportResponse)

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

string

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

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

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

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

RunReportRequest

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

تمثيل 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,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
الحقول
property

string

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

مثال: properties/1234
dimensions[]

object (Dimension)

السمات المطلوبة والمعروضة
metrics[]

object (Metric)

المقاييس المطلوبة والمعروضة
dateRanges[]

object (DateRange)

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

object (FilterExpression)

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

object (FilterExpression)

عبارة الفلتر الخاصة بالمقاييس. يتم تطبيقها بعد تجميع صفوف التقرير، على غرار عبارة having في SQL. لا يمكن استخدام السمات في هذا الفلتر.
offset

string (int64 format)

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

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

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

string (int64 format)

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

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

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

enum (MetricAggregation)

تجميع المقاييس سيتم عرض قيم المقاييس المجمّعة في الصفوف التي تم ضبط dimensionValues فيها على "RESERVED_(MetricAggregation)". سيتم تجميع المقاييس التي تتضمّن كلاً من المقارنات والنطاقات الزمنية المتعددة استنادًا إلى النطاقات الزمنية.
orderBys[]

object (OrderBy)

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

string

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

object (CohortSpec)

مجموعة المجموعة النموذجية المرتبطة بهذا الطلب. إذا كانت هناك مجموعة نموذجية في الطلب، يجب توفُّر السمة "المجموعة النموذجية".
keepEmptyRows

boolean

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

بغض النظر عن إعداد keepEmptyRows هذا، لا يمكن عرض سوى البيانات التي يسجّلها موقع على "إحصاءات Google" في التقرير.

على سبيل المثال، إذا لم يسجّل موقع purchase أيّ حدث، لن يتضمّن طلب البحث عن السمة eventName والمقياس eventCount صفًا eventName: "purchase" وeventCount: 0.
returnPropertyQuota

boolean

يحدّد ما إذا كان سيتم عرض الحالة الحالية لحصة هذا الموقع على "إحصاءات Google". يتم عرض الحصة في PropertyQuota.
comparisons[]

object (Comparison)

اختياريّ. إعدادات المقارنات المطلوبة والمعروضة لا يتطلّب الطلب سوى حقل مقارنات لتلقّي عمود مقارنة في الردّ.