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

يحصل المثال التالي على تقرير الاستخدام للعنوان sami@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"
    }
   ]
  }
 ]
}