אחזור דוח שהוא אוסף של נכסים ונתונים סטטיסטיים לקבוצת משתמשים בחשבון. למידע נוסף, עיינו במדריך לדוחות על שימוש במשתמשים. למידע נוסף על הפרמטרים של דוח המשתמשים, אפשר לעיין במדריכי העזר פרמטרים של שימוש של משתמשים.
בקשת HTTP
GET https://admin.googleapis.com/admin/reports/v1/usage/users/{userKey or all}/dates/{date}
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
userKey or all |
מייצג את מזהה הפרופיל או את כתובת האימייל של המשתמש שלגביהם צריך לסנן את הנתונים. הערך יכול להיות |
date |
מייצג את התאריך שבו בוצע השימוש, לפי UTC-8:00 (לפי שעון החוף המערבי של ארה"ב). חותמת הזמן היא בפורמט ISO 8601, |
פרמטרים של שאילתה
פרמטרים | |
---|---|
customerId |
המזהה הייחודי של הלקוח שעבורו מאחזרים נתונים. |
filters |
מחרוזת השאילתה המסננים מופיעים בצורה בדוגמה הזו, האופרטור 'לא שווה ל-' 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 האופרטורים היחסים כוללים:
|
maxResults |
ההגדרה הזו קובעת כמה רשומות פעילות יוצגו בכל דף תגובה. לדוגמה, אם הבקשה מגדירה את הערך |
orgUnitID |
המזהה של היחידה הארגונית שעליה רוצים לדווח. פעילות המשתמשים תוצג רק למשתמשים השייכים ליחידה הארגונית שצוינה. |
pageToken |
אסימון לציון הדף הבא. דוח עם כמה דפים כולל את המאפיין |
parameters |
מחרוזת השאילתה |
groupIdFilter |
מזהי קבוצות מופרדים בפסיקים (obfuscated) שבהם פעילויות משתמש מסוננות. כלומר, התגובה תכלול פעילויות רק למשתמשים שהם חלק ממזהה אחד לפחות של הקבוצה המוזכרים כאן. פורמט: "id:abc123,id:xyz456" |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע של UsageReports
.
היקפי הרשאות
נדרש היקף OAuth הבא:
https://www.googleapis.com/auth/admin.reports.usage.readonly
למידע נוסף, ניתן לעיין במדריך ההרשאות.