Method: userUsageReport.get

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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,‏ chat,‏ docs ו-gmail.

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

בדוגמה הזו, האופרטור <> 'לא שווה' מקודד ככתובת 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

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

  • == – 'שווה ל'.
  • <> – 'not equal to'. הוא מקודד ככתובת 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, chat, classroom, cros, docs, gmail, gplus, device_management, meet ו-sites.
מחרוזת השאילתה parameters היא בפורמט CSV של app_name1:param_name1, app_name2:param_name2.

groupIdFilter

string

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

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאה

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

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

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