Method: userUsageReport.get

string

מייצג את מזהה הפרופיל או את כתובת האימייל של המשתמש שעבורו צריך לסנן את הנתונים. הוא יכול להיות all לכל המידע, או userKey למזהה הפרופיל הייחודי של המשתמש ב-Google Workspace או לכתובת האימייל הראשית שלו. המשתמש לא יכול להיות משתמש שנמחק. למשתמש שנמחק, קוראים ל-users.list ב-Directory API עם showDeleted=true, ואז משתמשים ב-ID שהוחזר כ-userKey.

string

התאריך שבו התרחש השימוש, לפי שעון החוף המערבי (PST)‏ -8:00 (UTC). חותמת הזמן היא בפורמט ISO 8601, yyyy-mm-dd.

string

המזהה הייחודי של הלקוח שעבורו רוצים לאחזר נתונים.

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/users/all/dates/2013-03-03
?parameters=accounts:last_login_time
&filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z 

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

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

integer (uint32 format)

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

string

המזהה של היחידה הארגונית שרוצים לדווח עליה. פעילות המשתמשים תוצג רק למשתמשים ששייכים ליחידה הארגונית שצוינה.

string

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

string

מחרוזת השאילתה parameters היא רשימה של פרמטרים של אירועים המופרדים בפסיקים, שמשמשת לטיהור התוצאות של דוח. הפרמטר משויך לאפליקציה ספציפית. הערכים של האפליקציות בדוח 'שימוש של לקוחות' כוללים את הערכים הבאים: accounts,‏ app_maker,‏ apps_scripts,‏ calendar,‏ classroom,‏ cros,‏ docs,‏ gmail,‏ gplus,‏ device_management,‏ meet ו-sites.
מחרוזת שאילתה של parameters בפורמט CSV של app_name1:param_name1, app_name2:param_name2.

string

מזהי קבוצות מופרדים בפסיקים (מעומעמים) שבהם מסוננות פעילויות המשתמשים, כלומר התגובה תכיל פעילויות רק של משתמשים שהם חלק מאחד לפחות ממזהי הקבוצות שצוינו כאן. פורמט: "id:abc123,id:xyz456"