Method: properties.runAccessReport

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

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

تتضمّن سجلّات الوصول إلى البيانات هذه إعداد تقارير واجهة المستخدم في "إحصاءات Google 4" واستكشافات واجهة المستخدم في "إحصاءات Google 4" وData API في "إحصاءات 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

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

expandGroups

boolean

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

نص الاستجابة

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

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

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

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