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],....

في هذا المثال، تم ترميز عامل التشغيل <> "لا يساوي" باستخدام عنوان 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

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