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

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

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