Method: entityUsageReports.get

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

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
entityType

enum (EntityType)

מייצג את סוג הישות של הדוח.
entityKey or all

string

מייצג את המפתח של האובייקט שלפיו רוצים לסנן את הנתונים. זו מחרוזת שיכולה להכיל את הערך all כדי לקבל אירועי פעילות לכל המשתמשים, או כל ערך אחר של ישות ספציפית לאפליקציה. להסבר איך להשיג את entityKey עבור entityType מסוים, כדאי לעיין במדריכי העזרה בנושא פרמטרים של שימוש בישויות.
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],....

בדוגמה זו, הערך של <> 'not שווה ל-' האופרטור מקודד בכתובת ה-URL במחרוזת השאילתה של הבקשה (%3C%3E): 

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

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

  • == - 'שווה ל-'.
  • <> – 'לא שווה ל-'. כתובת ה-URL מקודדת (%3C%3E).
  • < - 'פחות מ-'. הכתובת מקודדת בכתובת URL (%3C).
  • <= - 'פחות מ- או שווה ל-'. כתובת ה-URL מקודדת (%3C=).
  • > - 'גדול מ-'. כתובת ה-URL מקודדת (%3E).
  • >= - 'גדול מ- או שווה ל-'. כתובת ה-URL מקודדת (%3E=).
אפשר להחיל מסננים רק על פרמטרים מספריים.
maxResults

integer (uint32 format)

ההגדרה הזו קובעת כמה רשומות פעילות יוצגו בכל דף תגובה. לדוגמה, אם הבקשה מגדירה את הערך <span>maxResults=1</span> והדוח כולל שתי פעילויות, הדוח כולל שני דפים. למאפיין <span>nextPageToken</span> של התשובה יש את האסימון לדף השני.
pageToken

string

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

string

מחרוזת השאילתה parameters היא רשימה מופרדת בפסיקים של פרמטרים של אירועים שמצמצמים את תוצאות הדוח. הפרמטר משויך לאפליקציה ספציפית. ערכי האפליקציה של דוח השימוש בישויות הם רק gplus.
מחרוזת שאילתה parameter היא בפורמט CSV של [app_name1:param_name1], [app_name2:param_name2]....

גוף הבקשה

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

גוף התשובה

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

היקפי ההרשאות

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

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

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

EntityType

טיפוסים בני מנייה (enum)
gplus_communities מחזיר דוח על קהילות ב-Google+.