Reports API: Users Usage Report

گزارش استفاده کاربر اطلاعات استفاده از سرویس Google Workspace را برای کاربر خاصی در دامنه‌تان برمی‌گرداند. این گزارش‌ها را می‌توان برای اطلاعات استفاده خاص سفارشی‌سازی و فیلتر کرد. دوره زمانی پیش‌فرض و حداکثر برای هر گزارش ۴۵۰ روز گذشته است.

این گزارش استفاده کاربر ممکن است فقط برای اهداف قانونی مطابق با «قرارداد مشتری» شما استفاده شود. و این گزارش‌ها برای 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"

بازیابی فعالیت‌های استفاده کاربر خاص

برای بازیابی گزارش فعالیت‌های کاربر خاصی در حسابتان، از درخواست اچ‌تی‌تی‌پی 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 است. برای اطلاعات بیشتر درباره پارامترهای رشته پُرسمان و ویژگی‌های پاسخ، به مرجع میانای برنامه‌سازی کاربردی مراجعه کنید. برای اطلاعات درباره پارامترهای گزارش استفاده کاربر، به مرجع پارامترهای استفاده کاربر مراجعه کنید.

مثال زیر گزارش استفاده را برای 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"
    }
   ]
  }
 ]
}