Method: userUsageReport.get

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

طلب HTTP

GET https://admin.googleapis.com/admin/reports/v1/usage/users/{userKey or all}/dates/{date}

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

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

المعلمات
userKey or all

string

رقم تعريف الملف الشخصي أو البريد الإلكتروني للمستخدم الذي يجب تصفية البيانات من أجله. يمكن أن تكون القيمة all لجميع المعلومات أو userKey لرقم تعريف الملف الشخصي الفريد للمستخدم في Google Workspace أو عنوان بريده الإلكتروني الرئيسي. يجب ألا يكون مستخدمًا محذوفًا. بالنسبة إلى مستخدم محذوف، يمكنك طلب users.list في Directory API باستخدام showDeleted=true، ثم استخدام ID الذي تم عرضه باعتباره userKey.
date

string

يمثل تاريخ حدوث الاستخدام، استنادًا إلى التوقيت العالمي المنسق -8:00 (توقيت المحيط الهادئ الرسمي). يظهر الطابع الزمني بالتنسيق ISO 8601، وهو yyyy-mm-dd.

معامِلات طلب البحث

المعلمات
customerId

string

المعرّف الفريد للعميل لاسترداد البيانات له
filters

string

سلسلة طلب البحث filters هي قائمة مفصولة بفواصل لمَعلمات أحداث التطبيق ويتم فيها معالجة قيمة المَعلمة بواسطة عامل علائقي. تتضمن سلسلة طلب البحث filters اسم التطبيق الذي يتم عرض استخدامه في التقرير. تتضمن قيم التطبيقات في تقرير استخدام المستخدمين accounts وdocs وgmail.

تكون الفلاتر بالصيغة [application name]:[parameter name][relational operator][parameter value],....

في هذا المثال، تشير قيمة <> إلى "not equal to" بترميز عنوان URL في سلسلة استعلام الطلب (%3C%3E): 

GET
https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time
&filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z

تشمل العوامل الارتباطية ما يلي:

  • == - "يساوي".
  • <> - "لا يساوي". ويكون بترميز عنوان URL (%3C%3E).
  • < - "أقل من". ويكون بترميز عنوان URL (%3C).
  • <= - "أقل من أو يساوي". ويكون بترميز عنوان URL (%3C=).
  • > - "أكبر من". ويكون بترميز عنوان URL (%3E).
  • >= - "أكبر من أو يساوي". ويكون بترميز عنوان URL (%3E=).
maxResults

integer (uint32 format)

يحدد عدد سجلات النشاط التي يتم عرضها في كل صفحة استجابة. على سبيل المثال، إذا ضبط الطلب maxResults=1 وكان التقرير يتضمّن نشاطَين، يتضمّن التقرير صفحتين. تحتوي السمة nextPageToken الخاصة بالاستجابة على الرمز المميّز الخاص بالصفحة الثانية.
سلسلة طلب البحث maxResults اختيارية.
orgUnitID

string

رقم تعريف الوحدة التنظيمية المطلوب إعداد تقارير عنها. لن يظهر نشاط المستخدم إلا للمستخدمين الذين ينتمون إلى الوحدة التنظيمية المحدّدة.

pageToken

string

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

string

سلسلة طلب البحث parameters هي قائمة بمَعلمات الأحداث التي تحسّن نتائج التقرير، ويتم الفصل بينها بفواصل. ترتبط المَعلمة بتطبيق معيّن. تتضمن قيم التطبيقات في تقرير "استخدام العملاء" accounts وapp_maker وapps_scripts وcalendar وclassroom وcros وdocs وgmail وgplus وdevice_management وmeet وsites.
تكون سلسلة طلب البحث parameters بتنسيق CSV على شكل app_name1:param_name1, app_name2:param_name2.

groupIdFilter

string

معرّفات المجموعات المفصولة بفواصل (مع إخفاء مفاتيح فك تشفير) بشأن أنشطة المستخدمين التي تتم فلترتها، أي أنّ الردّ سيحتوي فقط على أنشطة لهؤلاء المستخدمين الذين يشكّلون جزءًا من واحد على الأقل من معرّفات المجموعات المذكورة هنا. التنسيق: "id:abc123,id:xyz456"

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

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

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

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/admin.reports.usage.readonly

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.