דוח השימוש של לקוחות צובר פרטים על השימוש בשירות Google Workspace, עבור כל המשתמשים בכל הדומיין. דוח השימוש של המשתמשים מחזיר את פרטי השימוש בשירות Google Workspace מכל החשבון שלכם. פרטי השימוש מאורגנים לפי סוג האפליקציה, שמורכבים מפרמטרים ספציפיים לאותה אפליקציה. תקופת ברירת המחדל ותקופת הזמן המקסימלית לכל דוח היא 450 הימים האחרונים.
ניתן להשתמש בדוח השימוש הזה רק למטרות חוקיות בהתאם להסכם הלקוח שלך. כמו כן, הדוחות האלה רלוונטיים ל-Google Workspace ול-Education.
אחזור של דוח שימוש של לקוח
כדי לאחזר דוח על הפעילויות בחשבון, צריך להשתמש בבקשת ה-HTTP הבאה של GET ולכלול את אסימון ההרשאה
שמתואר במסמכי התיעוד. כדי לשפר את הקריאוּת,
הדוגמה הבאה מעוצבת עם החזרות שורה:
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 הימים האחרונים, ורשימה של
אפליקציות מורשות עם מספר הרשאות המשתמשים לכל אפליקציה, החל מ-3 במרץ 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
},
...
]
}
]
}
]
}