Method: accounts.runAccessReport

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

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

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

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

طلب HTTP

POST https://analyticsadmin.googleapis.com/v1beta/{entity=accounts/*}:runAccessReport

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

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

المعلمات
entity

string

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

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

نص الطلب

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

تمثيل 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)

تتيح لك فلاتر المقاييس حصر استجابة التقرير بقيم مقاييس معيّنة تتطابق مع الفلتر. يتم تطبيق فلاتر المقاييس بعد تجميع صفوف التقرير، تمامًا مثل عبارة having في لغة الاستعلامات البنيوية (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

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

boolean

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

نص الاستجابة

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

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

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

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