Method: accounts.runAccessReport

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

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

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

لتقديم ملاحظاتك وآرائك عن واجهة برمجة التطبيقات هذه، يُرجى ملء نموذج تعليقات عن تقارير الوصول إلى "إحصاءات Google".

طلب HTTP

POST https://analyticsadmin.googleapis.com/v1alpha/{entity=accounts/*}: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). على سبيل المثال "أمريكا/القاهرة" أو "آسيا/طوكيو".
orderBys[]

object (AccessOrderBy)

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

boolean

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

boolean

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

boolean

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

نص الاستجابة

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

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

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

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