Method: userUsageReport.get

מאחזר דוח שהוא אוסף של נכסים ונתונים סטטיסטיים עבור קבוצה של משתמשים שיש להם את החשבון. מידע נוסף מופיע במדריך בנושא דוח השימוש במשתמש. מידע נוסף על הפרמטרים בדוח המשתמש זמין במדריכים בנושא פרמטרים של שימוש במשתמשים.

בקשת HTTP

GET https://admin.googleapis.com/admin/reports/v1/usage/users/{userKey or all}/dates/{date}

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
userKey or all

string

מייצג את מזהה הפרופיל או את כתובת האימייל של המשתמש שעבורן צריך לסנן את הנתונים. הוא יכול להיות all לכל המידע, או userKey למזהה הפרופיל הייחודי של המשתמש ב-Google Workspace או לכתובת האימייל הראשית שלו. לא יכול להיות משתמש שנמחק. עבור משתמש שנמחק, קוראים ל-users.list ב-Directory API באמצעות showDeleted=true, ואז משתמשים ב-ID שהוחזר כ-userKey.
date

string

התאריך שבו התרחש השימוש, לפי UTC-8:00 (שעון החוף המערבי של ארה"ב). חותמת הזמן היא בפורמט ISO 8601, yyyy-mm-dd.

פרמטרים של שאילתה

פרמטרים
customerId

string

המזהה הייחודי של הלקוח שלגביו רוצים לאחזר את הנתונים.
filters

string

מחרוזת השאילתה filters היא רשימה מופרדת בפסיקים של פרמטרים של אירועים של אפליקציה, שבה אופרטור יחסי משנה את ערך הפרמטר. מחרוזת השאילתה filters כוללת את שם האפליקציה שהשימוש בה מוחזר בדוח. ערכי האפליקציות בדוח השימוש במשתמשים כוללים את accounts, docs ו-gmail.

המסננים מופיעים בצורה [application name]:[parameter name][relational operator][parameter value],....

בדוגמה זו, הערך של <> 'not שווה ל-' האופרטור מקודד בכתובת ה-URL במחרוזת השאילתה של הבקשה (%3C%3E): 

GET
https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time
&filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z

האופרטורים היחסיים כוללים:

  • == - 'שווה ל-'.
  • <> – 'לא שווה ל-'. כתובת ה-URL מקודדת (%3C%3E).
  • < - 'פחות מ-'. הכתובת מקודדת בכתובת URL (%3C).
  • <= - 'פחות מ- או שווה ל-'. כתובת ה-URL מקודדת (%3C=).
  • > - 'גדול מ-'. כתובת ה-URL מקודדת (%3E).
  • >= - 'גדול מ- או שווה ל-'. כתובת ה-URL מקודדת (%3E=).
maxResults

integer (uint32 format)

ההגדרה הזו קובעת כמה רשומות פעילות יוצגו בכל דף תגובה. לדוגמה, אם הבקשה מגדירה את הערך maxResults=1 והדוח כולל שתי פעילויות, הדוח כולל שני דפים. למאפיין nextPageToken של התשובה יש את האסימון לדף השני.
מחרוזת השאילתה maxResults היא אופציונלית.
orgUnitID

string

המזהה של היחידה הארגונית שעליה רוצים לדווח. פעילות המשתמשים תוצג רק עבור משתמשים ששייכים ליחידה הארגונית שצוינה.

pageToken

string

אסימון לציון הדף הבא. דוח עם כמה דפים מכיל בתשובה נכס nextPageToken. בבקשת ההמשך לקבלת הדף הבא של הדוח, מזינים את הערך nextPageToken במחרוזת השאילתה pageToken.
parameters

string

מחרוזת השאילתה parameters היא רשימה מופרדת בפסיקים של פרמטרים של אירועים שמצמצמים את תוצאות הדוח. הפרמטר משויך לאפליקציה ספציפית. ערכי האפליקציות בדוח 'שימוש ללקוחות' כוללים את accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet ו-sites.
מחרוזת שאילתה parameters היא בפורמט CSV של app_name1:param_name1, app_name2:param_name2.

groupIdFilter

string

מזהי קבוצות מופרדים בפסיקים (obfuscated) של פעילויות של משתמשים מסוננות. כלומר, התגובה תכיל פעילויות רק עבור המשתמשים ששייכים לפחות לאחד ממזהי הקבוצות המוזכרים כאן. פורמט: "id:abc123,id:xyz456"

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע של UsageReports.

היקפי ההרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/admin.reports.usage.readonly

מידע נוסף זמין במדריך להרשאות.