דוח השימוש של משתמשים מחזיר את פרטי השימוש בשירות 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. מידע נוסף על הפרמטרים של מחרוזת השאילתה ומאפייני התגובות זמין בחומר העזר בנושא 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"
אחזור פעילויות שימוש של משתמש ספציפי
כדי לאחזר דוח על פעילויות של משתמש ספציפי בחשבון, צריך להשתמש בבקשת ה-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. מידע נוסף על הפרמטרים של מחרוזת השאילתה ומאפייני התגובות זמין בחומר העזר בנושא 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"
}
]
}
]
}