Method: properties.runAccessReport

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

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

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

طلب HTTP

POST https://analyticsadmin.googleapis.com/v1alpha/{entity=properties/*}:runAccessReport

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

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

المَعلمات
entity

string

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

لتقديم طلب على مستوى الموقع، يجب أن يكون الكيان مثل "properties/123" إذا كان "123" هو رقم تعريف موقعك على "إحصاءات Google 4". لتقديم طلب على مستوى الحساب، يجب أن يكون الكيان على سبيل المثال "accounts/1234" إذا كان "1234" هو رقم تعريف حسابك على "إحصاءات Google 4".

نص الطلب

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

تمثيل JSON
{
  "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
}
الحقول
dimensions[]

object (AccessDimension)

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

metrics[]

object (AccessMetric)

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

dateRanges[]

object (AccessDateRange)

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

dimensionFilter

object (AccessFilterExpression)

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

metricFilter

object (AccessFilterExpression)

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

offset

string (int64 format)

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

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

limit

string (int64 format)

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

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

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

timeZone

string

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

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

orderBys[]

object (AccessOrderBy)

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

returnEntityQuota

boolean

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

includeAllUsers

boolean

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

expandGroups

boolean

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

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال RunAccessReportResponse.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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