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 في واجهة برمجة تطبيقات الدليل باستخدام showDeleted=true، ثم استخدم ID الذي تم عرضه باعتباره userKey.

date

string

يمثل تاريخ حدوث الاستخدام، استنادًا إلى UTC-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

لمزيد من المعلومات، راجِع دليل التفويض.