- בקשת HTTP
- פרמטרים של נתיב
- פרמטרים של שאילתה
- גוף הבקשה
- גוף התשובה
- היקפי הרשאות
- EntityType
- רוצים לנסות?
אחזור דוח שהוא אוסף של נכסים ונתונים סטטיסטיים עבור הישויות שבהן משתמשים המשתמשים בחשבון. למידע נוסף, ניתן לעיין במדריך לדוחות שימוש בישויות. מידע נוסף על הפרמטרים בדוח הישויות זמין במדריכי העזר פרמטרים של שימוש בישויות.
בקשת HTTP
GET https://admin.googleapis.com/admin/reports/v1/usage/{entityType}/{entityKey or all}/dates/{date}
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
entityType |
מייצג את סוג הישות בדוח. |
entityKey or all |
מייצג את המפתח של האובייקט שלפיו יש לסנן את הנתונים. זוהי מחרוזת שיכולה להשתמש בערך |
date |
מייצג את התאריך שבו בוצע השימוש, לפי UTC-8:00 (לפי שעון החוף המערבי של ארה"ב). חותמת הזמן היא בפורמט ISO 8601, |
פרמטרים של שאילתה
פרמטרים | |
---|---|
customerId |
המזהה הייחודי של הלקוח שעבורו רוצים לאחזר נתונים. |
filters |
מחרוזת השאילתה המסננים מופיעים בצורה בדוגמה הזו, האופרטור 'לא שווה ל-' GET https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-01 ?parameters=gplus:community_name,gplus:num_total_members &filters=gplus:num_total_members%3C%3E0 האופרטורים היחסים כוללים:
|
maxResults |
ההגדרה הזו קובעת כמה רשומות פעילות יוצגו בכל דף תגובה. לדוגמה, אם הבקשה מגדירה את הערך |
pageToken |
אסימון לציון הדף הבא. דוח עם כמה דפים כולל את המאפיין |
parameters |
מחרוזת השאילתה |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע של UsageReports
.
היקפי הרשאות
נדרש היקף OAuth הבא:
https://www.googleapis.com/auth/admin.reports.usage.readonly
למידע נוסף, ניתן לעיין במדריך ההרשאות.
EntityType
טיפוסים בני מנייה (enums) | |
---|---|
gplus_communities |
הפונקציה מחזירה דוח על קהילות ב-Google+. |