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],....

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

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