گزارش استفاده کاربر، اطلاعات استفاده از سرویس Google Workspace را برای یک کاربر خاص در دامنه شما برمی‌گرداند. این گزارش ها را می توان برای اطلاعات استفاده خاص سفارشی و فیلتر کرد. دوره زمانی پیش‌فرض و حداکثر برای هر گزارش 450 روز گذشته است.
این گزارش استفاده از کاربر ممکن است فقط برای اهداف قانونی مطابق با توافق نامه مشتری شما استفاده شود. و این گزارش‌ها برای Google Workspace و Education اعمال می‌شود.
بازیابی تمام فعالیت های استفاده از کاربر
برای بازیابی گزارشی از تمام فعالیت‌های کاربر در حساب خود، از درخواست GET HTTP زیر استفاده کنید و کد مجوز شرح داده شده در اسناد مجوز را اضافه کنید. برای خوانایی، مثال زیر با بازگشت خط فرمت شده است:
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 است. برای اطلاعات بیشتر در مورد پارامترهای رشته پرس و جو و خواص پاسخ، به مرجع API مراجعه کنید. برای اطلاعات در مورد پارامترهای گزارش استفاده کاربر، به مرجع پارامترهای استفاده کاربر مراجعه کنید.
مثال زیر گزارشی از تمام فعالیت های کاربر برای حساب دریافت می کند.
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
مثال زیر گزارشی از آخرین مهرهای زمانی ورود به سیستم کاربران در حساب دریافت می کند. برای مثالی از پاسخ API، به مثال پاسخ JSON مراجعه کنید.
GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?parameters=accounts:last_login_time&maxResults=2
مثال زیر گزارشی از آخرین مهرهای زمانی ورود کاربران در حساب دریافت می‌کند که توسط کاربرانی که پس از یک زمان خاص وارد شده‌اند فیلتر شده است. برای مثالی از پاسخ API، به مثال پاسخ 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"
مثال زیر گزارشی از آخرین مهرهای زمانی ورود به سیستم و وضعیت تعلیق کاربران در حساب دریافت می‌کند. برای مثالی از پاسخ API، به مثال پاسخ 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 HTTP زیر استفاده کنید و کد مجوز شرح داده شده در مستندات مجوز را اضافه کنید. برای خوانایی، مثال زیر با بازگشت خط فرمت شده است.
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 است. برای اطلاعات بیشتر در مورد پارامترهای رشته پرس و جو و خواص پاسخ، به مرجع API مراجعه کنید. برای اطلاعات در مورد پارامترهای گزارش استفاده کاربر، به مرجع پارامترهای استفاده کاربر مراجعه کنید.
مثال زیر گزارش استفاده را برای 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"
}
]
}
]
}