- בקשת HTTP
- פרמטרים של נתיב
- פרמטרים של שאילתות
- גוף הבקשה
- גוף התשובה
- היקפי הרשאה
- EntityType
- רוצים לנסות?
אחזור דוח שהוא אוסף של נכסים ונתונים סטטיסטיים של ישויות ששימשו את המשתמשים בחשבון. מידע נוסף זמין במדריך לדוח 'שימוש בישויות'. מידע נוסף על הפרמטרים של דוח הישויות זמין במדריכי העזרה בנושא פרמטרים של שימוש בישויות.
בקשת HTTP
GET https://admin.googleapis.com/admin/reports/v1/usage/{entityType}/{entityKey or all}/dates/{date}
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
entity |
מייצג את סוג הישות בדוח. |
entity |
מייצג את המפתח של האובייקט שדרכו מסננים את הנתונים. זהו מחרוזת שיכולה לקבל את הערך |
date |
התאריך שבו התרחש השימוש, לפי שעון החוף המערבי (PST) -8:00 (UTC). חותמת הזמן היא בפורמט ISO 8601, |
פרמטרים של שאילתה
פרמטרים | |
---|---|
customer |
המזהה הייחודי של הלקוח שעבורו רוצים לאחזר נתונים. |
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 האופרטורים היחסיים כוללים:
|
max |
קובע כמה רשומות פעילות יוצגו בכל דף תגובה. לדוגמה, אם הבקשה מגדירה את |
page |
אסימון לציון הדף הבא. בדוח עם כמה דפים מופיע המאפיין |
parameters |
מחרוזת השאילתה |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם הפעולה מצליחה, גוף התגובה מכיל מופע של UsageReports
.
היקפי הרשאה
נדרש היקף ההרשאות הבא של OAuth:
https://www.googleapis.com/auth/admin.reports.usage.readonly
מידע נוסף זמין במדריך להרשאות.
EntityType
טיפוסים בני מנייה (enum) | |
---|---|
gplus_communities |
הפונקציה מחזירה דוח על קהילות ב-Google+. |