واجهة برمجة التطبيقات Reports API: تقرير استخدام المستخدمين

يعرض تقرير استخدام المستخدم معلومات استخدام خدمة Google Workspace لمستخدم معيّن في نطاقك. يمكن تخصيص هذه التقارير وفلترتها لعرض معلومات استخدام محدَّدة. الفترة الزمنية التلقائية والحد الأقصى لكل تقرير هي آخر 450 يومًا.

لا يمكن استخدام تقرير استخدام المستخدم هذا إلا لأغراض قانونية وفقًا لاتفاقية العملاء. وتنطبق هذه التقارير أيضًا على Google Workspace وEducation.

استرداد جميع أنشطة استخدام المستخدم

لاسترداد تقرير عن جميع أنشطة المستخدمين في حسابك، استخدِم طلب HTTP التالي من GET وأدرِج الرمز المميّز للتفويض الموضّح في مستندات التفويض. لتسهيل القراءة، يتم تنسيق المثال التالي باستخدام إرجاع الأسطر:

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/yyyy-mm-dd date
?parameters=application: user usage parameter,...
&filters=application: user usage parameter relational operator usage parameter's value,...
&maxResults=number of events listed on each page of the report

تشير القيمة dates إلى تاريخ حدوث الاستخدام، ويظهر الطابع الزمني بتنسيق ISO 8601، yyyy-mm-dd. لمزيد من المعلومات عن معلَمات سلسلة طلب البحث وخصائص الاستجابة، يُرجى الاطّلاع على مرجع واجهة برمجة التطبيقات. للحصول على معلومات عن مَعلمات تقرير استخدام المستخدِم، اطّلِع على مرجع مَعلمات استخدام المستخدِم.

يحصل المثال التالي على تقرير عن جميع أنشطة المستخدمين للحساب.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all
/dates/2013-03-03?maxResults=2

يحصل المثال التالي على تقرير عن جميع أنشطة المستخدمين لحساب عميل معيّن.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all
/dates/2013-03-03?customerId=C03az79cb

يحصل المثال التالي على تقرير عن الطوابع الزمنية الأخيرة لتسجيل الدخول للمستخدمين في الحساب. للحصول على مثال على استجابة واجهة برمجة التطبيقات، يمكنك الاطّلاع على مثال على استجابة JSON.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time&maxResults=2

يحصل المثال التالي على تقرير عن الطوابع الزمنية الأخيرة لتسجيل الدخول للمستخدمين في الحساب، وتتم فلترته حسب المستخدمين الذين سجّلوا الدخول بعد وقت محدّد. للحصول على مثال على استجابة واجهة برمجة التطبيقات، يمكنك الاطّلاع على مثال على استجابة JSON.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time&filters=accounts:last_login_time
>2010-10-28T10:26:35.000Z"

يحصل المثال التالي على تقرير عن الطوابع الزمنية الأخيرة لتسجيل الدخول وحالة تعليق المستخدمين في الحساب. للحصول على مثال على استجابة واجهة برمجة التطبيقات، يمكنك الاطّلاع على مثال على استجابة JSON.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time,accounts:is_disabled"

استرداد أنشطة الاستخدام لمستخدم معين

لاسترداد تقرير عن أنشطة مستخدم معيّن في حسابك، يمكنك استخدام طلب HTTP التالي GET وتضمين الرمز المميز للتفويض الموضح في مستندات التفويض. لتسهيل القراءة، يتم تنسيق المثال التالي باستخدام إرجاع الأسطر.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/userKey/dates/yyyy-mm-dd date
?parameters=application: user usage parameter,...
&filters=application: user usage parameter relational operator usage parameter's value,...
&maxResults=number of events listed on each page of the report

يمكن أن يكون userKey إما عنوان البريد الإلكتروني الرئيسي للمستخدم الوارد في التقرير أو عنوان البريد الإلكتروني الفريد للمستخدم في Google Workspace profileId. تشير القيمة dates إلى تاريخ حدوث الاستخدام، ويظهر الطابع الزمني بتنسيق ISO 8601، yyyy-mm-dd. لمزيد من المعلومات عن معلَمات سلسلة طلب البحث وخصائص الاستجابة، يُرجى الاطّلاع على مرجع واجهة برمجة التطبيقات. للحصول على معلومات عن مَعلمات تقرير استخدام المستخدِم، اطّلِع على مرجع مَعلمات استخدام المستخدِم.

يحصل المثال التالي على تقرير الاستخدام لـ john@example.com.

https://admin.googleapis.com/admin/reports/v1/usage/users/john@example.com/dates/2013-03-03

مثال على استجابة JSON في تقرير الاستخدام

عند الاستجابة الناجحة، يتم عرض رمز الحالة HTTP 200. بالإضافة إلى رمز الحالة، يعرض الرد تقريرًا.

استجابة JSON لتقرير المستخدم

{
 "kind": "reports#usageReports",
 "warnings": [
    {
      "code": warning machine-readable code,
      "message": warning human-readable message,
      "data": [
        {
          "key": key for key-value pair that gives detailed warning information,
          "value": value for key-value pair giving detailed warning information
        }
      ]
    }
  ],
 "nextPageToken": "N:NNN:NNN:N:C03az79cb",
 "usageReports": [
{
   "kind": "usageReport",
   "date": "2013-03-03",
   "entity": {
    "type": "USER",
    "customerId": "C03az79cb",
    "userEmail": "liz@example.com",
    "profileId": "user's unique Google Workspace ID"
   },
   "parameters": [
    {
      "name": "accounts:is_disabled",
      "boolValue": false
     },
    {
     "name": "accounts:disabled_reason",
     "stringValue": "reason description"
    },
    {
     "name": "accounts:first_name",
     "stringValue": "Liz"
    },
    {
     "name": "accounts:is_2sv_enforced",
     "boolValue": false
    },
    {
     "name": "accounts:is_2sv_enrolled",
     "boolValue": false
    },
    {
     "name": "accounts:last_name",
     "stringValue": "Smith"
    },
    {
     "name": "accounts:creation_time",
     "datetimeValue": "2010-10-28T10:26:35.000Z"
    },
    {
     "name": "accounts:last_login_time",
     "datetimeValue": "1970-01-01T00:00:00.000Z"
    },
    {
     "name": "accounts:last_sso_time",
     "datetimeValue": "1970-01-01T00:00:00.000Z"
    }
   ]
  }
 ]
}