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

string

מייצג את המפתח של האובייקט שדרכו מסננים את הנתונים. זהו מחרוזת שיכולה לקבל את הערך all כדי לקבל אירועי פעילות לכל המשתמשים, או כל ערך אחר לישות ספציפית לאפליקציה. פרטים על אופן קבלת הערך של entityKey עבור entityType מסוים מופיעים במדריכים של פרמטרים של שימוש בישויות.
date

string

התאריך שבו התרחש השימוש, לפי שעון החוף המערבי (PST)‏ -8:00 (UTC). חותמת הזמן היא בפורמט 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

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

  • == – 'equal to'.
  • <> – 'not equal to'. כתובת ה-URL מקודדת (%3C%3E).
  • < - 'פחות מ-'. הוא מקודד ככתובת URL (‎%3C).
  • <= – 'less than or equal to' (קטן מ- או שווה ל-). הוא מקודד ככתובת 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+‎.