Method: properties.runAccessReport

{
  "dimensions": [
    {
      object (AccessDimension)
    }
  ],
  "metrics": [
    {
      object (AccessMetric)
    }
  ],
  "dateRanges": [
    {
      object (AccessDateRange)
    }
  ],
  "dimensionFilter": {
    object (AccessFilterExpression)
  },
  "metricFilter": {
    object (AccessFilterExpression)
  },
  "offset": string,
  "limit": string,
  "timeZone": string,
  "orderBys": [
    {
      object (AccessOrderBy)
    }
  ],
  "returnEntityQuota": boolean,
  "includeAllUsers": boolean,
  "expandGroups": boolean
}

object (AccessDimension)

السمات المطلوبة والمعروضة في الردّ يُسمح بالطلبات لما يصل إلى 9 سمات.

object (AccessMetric)

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

object (AccessDateRange)

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

object (AccessFilterExpression)

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

object (AccessFilterExpression)

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

string (int64 format)

عدد صفوف صف البداية. يتم احتساب الصف الأول على أنه الصف 0. إذا لم يتم تحديد الإزاحة، يتم التعامل معها على أنّها 0. إذا كانت الإزاحة صفرًا، فستُرجع هذه الطريقة الصفحة الأولى من النتائج التي تحتوي على إدخالات limit.

لمزيد من المعلومات عن مَعلمة تقسيم النتائج على صفحات، يمكنك الاطّلاع على مقالة التقسيم على صفحات.

string (int64 format)

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

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

لمزيد من المعلومات عن مَعلمة تقسيم النتائج على صفحات، يمكنك الاطّلاع على مقالة التقسيم على صفحات.

string

المنطقة الزمنية لهذا الطلب، إذا تم تحديدها. في حال عدم تحديد هذه السمة، يتم استخدام المنطقة الزمنية للموقع. تُستخدم المنطقة الزمنية للطلب لتفسير وقت البدء وتواريخ انتهاء التقرير.

يتم تنسيقها كسلاسل من قاعدة بيانات المنطقة الزمنية الصادرة عن IANA (https://www.iana.org/time-zones). على سبيل المثال "أمريكا/القاهرة" أو "آسيا/طوكيو".

object (AccessOrderBy)

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

boolean

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

boolean

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

boolean

اختياريّ. يحدِّد هذا الإعداد ما إذا كان سيتم عرض المستخدمين ضمن مجموعات المستخدمين. لا يعمل هذا الحقل إلا عند ضبط addAllUsers على "صحيح". إذا كانت القيمة true، سيتم عرض جميع المستخدمين الذين لديهم إذن الوصول إلى الموقع أو الحساب المحدّدَين. إذا كانت القيمة "false"، فلن يتم عرض سوى المستخدمين الذين لديهم الإذن بالوصول المباشر.