אחזור דוח שהוא אוסף של נכסים ונתונים סטטיסטיים של ישויות ששימשו את המשתמשים בחשבון. למידע נוסף, יש לעיין במדריך לדוחות על שימוש בישויות. למידע נוסף על הפרמטרים של דוח הישויות, כדאי לעיין במדריכי העזרה בנושא פרמטרים של שימוש בישויות.
בקשת HTTP
GET https://admin.googleapis.com/admin/reports/v1/usage/{entityType}/{entityKey or all}/dates/{date}
מייצג את המפתח של האובייקט שלפיו רוצים לסנן את הנתונים. זו מחרוזת שיכולה להכיל את הערך 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=).
ההגדרה הזו קובעת כמה רשומות פעילות יוצגו בכל דף תגובה. לדוגמה, אם הבקשה מגדירה את הערך <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.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"חסרים לי מידע או פרטים"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"התוכן מורכב מדי או עם יותר מדי שלבים"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"התוכן לא עדכני"
},{
"type": "thumb-down",
"id": "translationIssue",
"label":"בעיה בתרגום"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"בעיה בדוגמאות/בקוד"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"סיבה אחרת"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"התוכן קל להבנה"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"התוכן עזר לי לפתור בעיה"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"סיבה אחרת"
}]
{"lastModified": "\u05e2\u05d3\u05db\u05d5\u05df \u05d0\u05d7\u05e8\u05d5\u05df: 2024-08-29 (\u05e9\u05e2\u05d5\u05df UTC)."}
[[["התוכן קל להבנה","easyToUnderstand","thumb-up"],["התוכן עזר לי לפתור בעיה","solvedMyProblem","thumb-up"],["סיבה אחרת","otherUp","thumb-up"]],[["חסרים לי מידע או פרטים","missingTheInformationINeed","thumb-down"],["התוכן מורכב מדי או עם יותר מדי שלבים","tooComplicatedTooManySteps","thumb-down"],["התוכן לא עדכני","outOfDate","thumb-down"],["בעיה בתרגום","translationIssue","thumb-down"],["בעיה בדוגמאות/בקוד","samplesCodeIssue","thumb-down"],["סיבה אחרת","otherDown","thumb-down"]],["עדכון אחרון: 2024-08-29 (שעון UTC)."]]