Reports API: گزارش استفاده از مشتریان

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

این گزارش استفاده ممکن است فقط برای اهداف قانونی مطابق با توافق نامه مشتری شما استفاده شود. همچنین، این گزارش‌ها برای Google Workspace و Education اعمال می‌شود.

گزارش استفاده از مشتری را بازیابی کنید

برای بازیابی گزارش فعالیت‌های حساب خود از درخواست GET HTTP زیر استفاده کنید و رمز مجوز شرح داده شده در اسناد مجوز را درج کنید. برای خوانایی، مثال زیر با بازگشت خط فرمت شده است:

GET https://admin.googleapis.com/admin/reports/v1/usage/dates/yyyy-mm-dd date
?parameters=app name: usage parameter,...
&customerId=the customer's ID
&maxResults=number of events listed on each page of the report

مقدار dates ، تاریخ استفاده است و مهر زمانی در قالب ISO 8601 ، yyyy-mm-dd است. توصیه می کنیم برای این کار از منطقه زمانی حساب خود استفاده کنید. برای اطلاعات بیشتر در مورد رشته‌های درخواست و ویژگی‌های پاسخ، به مرجع API و مرجع پارامترهای گزارش استفاده مشتری مراجعه کنید.

مثال زیر گزارشی با مجموع همه ورودهای موفقیت آمیز به حساب شما در 30 روز گذشته و لیستی از برنامه های کاربردی مجاز، با تعداد مجوزهای کاربر در هر برنامه، از 03/03/2013 دریافت می کند. رشته پرس و جو maxResults نشان می دهد که این گزارش دو رویداد را در هر صفحه گزارش برمی گرداند:

GET https://admin.googleapis.com/admin/reports/v1/usage/dates/2013-03-03
?parameters=accounts:num_30day_logins%2Caccounts:authorized_apps&maxResults=2

پاسخ 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": "CUSTOMER",
    "customerId": "C03az79cb"
   },
   "parameters": [
    {
     "name": "accounts:num_1day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_30day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_7day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_disabled_accounts",
     "intValue": "5"
    },
    {
     "name": "accounts:authorized_apps",
     "msgValue": [
      {
       "client_id": "1234.apps.googleusercontent.com",
       "client_name": "www.example.com",
       "num_users": 2
      },
      {
       "client_id": "4567.apps.googleusercontent.com",
       "client_name": "Example",
       "num_users": 1
      },
     ...
     ]
    }
   ]
  }
 ]
}