- בקשת HTTP
- פרמטרים של נתיב
- פרמטרים של שאילתה
- גוף הבקשה
- גוף התשובה
- היקפי ההרשאות
- ApplicationName
- פעילות
- רוצים לנסות?
אחזור של רשימת פעילויות בחשבון ובאפליקציה של לקוח ספציפי, כמו אפליקציית מסוף Admin או אפליקציית Google Drive. למידע נוסף, ניתן לעיין במדריכים לדוחות פעילות של אדמין ושל Google Drive. מידע נוסף על הפרמטרים של דוח הפעילות זמין במדריכי העזר לפרמטרים של פעילות.
בקשת HTTP
GET https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
userKey or all |
מזהה הפרופיל או כתובת האימייל של המשתמש שעבורם יש לסנן את הנתונים. יכול להיות |
applicationName |
שם האפליקציה שעבורה רוצים לאחזר את האירועים. |
פרמטרים של שאילתה
פרמטרים | |
---|---|
actorIpAddress |
כתובת פרוטוקול האינטרנט (IP) של המארח שבו בוצע האירוע. זוהי דרך נוספת לסנן סיכום דוח באמצעות כתובת ה-IP של המשתמש שהפעילות שלו מדווחת. כתובת IP זו עשויה לשקף את מיקומו הפיזי של המשתמש, וייתכן שלא. לדוגמה, כתובת ה-IP יכולה להיות כתובת שרת ה-proxy של המשתמש, או כתובת רשת וירטואלית פרטית (VPN). הפרמטר הזה תומך בגרסאות של כתובות IPv4 ו-IPv6. |
customerId |
המזהה הייחודי של הלקוח שעבורו רוצים לאחזר נתונים. |
endTime |
קביעת הסוף של טווח הזמן שמוצג בדוח. התאריך הוא בפורמט RFC 3339, לדוגמה 2010-10-28T10:26:35.000Z. ערך ברירת המחדל הוא הזמן המשוער של בקשת ה-API. דוח API כולל שלושה מושגי זמן בסיסיים:
endTime , הדוח מחזיר את כל הפעילויות מ-startTime עד השעה הנוכחית או 180 הימים האחרונים אם startTime מכיל יותר מ-180 ימים בעבר.
|
eventName |
שם האירוע שה-API שולח לו שאילתה. כל |
filters |
מחרוזת השאילתה הפרמטרים האלה של האירועים משויכים לערך בדוגמאות הבאות של פעילויות ב-Drive, הרשימה שהוחזרה כוללת את כל האירועים מסוג
שאילתת
הערה: ה-API לא מקבל כמה ערכים של אותו פרמטר. אם פרמטר סופק יותר מפעם אחת בבקשת ה-API, ה-API מקבל רק את הערך האחרון של אותו פרמטר. בנוסף, אם צוין פרמטר לא חוקי בבקשת ה-API, ה-API מתעלם מהפרמטר הזה ומחזיר את התשובה שתואמת לשאר הפרמטרים החוקיים. אם לא מבקשים פרמטרים, מוחזרים כל הפרמטרים. |
maxResults |
ההגדרה הזו קובעת כמה רשומות פעילות יוצגו בכל דף תגובה. לדוגמה, אם הבקשה מגדירה את הערך |
orgUnitID |
המזהה של היחידה הארגונית שעליה רוצים לדווח. רשומות הפעילות יוצגו רק למשתמשים השייכים ליחידה הארגונית שצוינה. |
pageToken |
האסימון לציון הדף הבא. דוח עם כמה דפים כולל את המאפיין |
startTime |
מגדיר את תחילת טווח הזמן שמוצג בדוח. התאריך הוא בפורמט RFC 3339, לדוגמה 2010-10-28T10:26:35.000Z. הדוח מחזיר את כל הפעילויות מ- |
groupIdFilter |
מזהי קבוצות מופרדים בפסיקים (obfuscated) שבהם פעילויות המשתמש מסוננות. כלומר, התגובה תכלול פעילויות רק עבור המשתמשים שנכללים לפחות באחד ממזהי הקבוצות המוזכרים כאן. פורמט: "id:abc123,id:xyz456" |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
תבנית JSON לאוסף של פעילויות.
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"kind": string,
"etag": string,
"items": [
{
object ( |
שדות | |
---|---|
kind |
הסוג של משאב ה-API. בדוח פעילות, הערך הוא |
etag |
ה-ETag של המשאב. |
items[] |
כל רשומה של פעילות בתגובה. |
nextPageToken |
אסימון לאחזור דף המעקב הבא של הדוח. הערך |
היקפי הרשאות
נדרש היקף ההרשאות הבא של OAuth:
https://www.googleapis.com/auth/admin.reports.audit.readonly
למידע נוסף, עיינו במדריך ההרשאות.
ApplicationName
טיפוסים בני מנייה (enums) | |
---|---|
access_transparency |
בדוחות הפעילות של Google Workspace Access Transparency מוצגים מידע על סוגים שונים של אירועי פעילות של Access Transparency. |
admin |
דוחות הפעילות של אפליקציית מסוף Admin מחזירים פרטי חשבון לגבי סוגים שונים של אירועי פעילות של אדמין. |
calendar |
דוחות הפעילות של אפליקציית יומן Google מחזירים מידע על אירועי פעילות שונים ביומן. |
chat |
בדוחות הפעילות ב-Chat מוצג מידע על אירועים שונים של פעילות ב-Chat. |
drive |
דוחות הפעילות של אפליקציית Google Drive מחזירים מידע על אירועי פעילות שונים ב-Google Drive. דוח הפעילות ב-Drive זמין רק ללקוחות Google Workspace Business ו-Google Workspace Enterprise. |
gcp |
בדוחות הפעילות של אפליקציית Google Cloud Platform מוצג מידע על אירועי פעילות שונים ב-GCP. |
gplus |
דוחות הפעילות של אפליקציית Google+ מחזירים מידע על אירועי פעילות שונים ב-Google+. |
groups |
בדוחות הפעילות של אפליקציית קבוצות Google מוצג מידע על אירועים שונים של פעילות בקבוצות. |
groups_enterprise |
דוחות הפעילות בקבוצות Enterprise מציגים מידע על אירועים שונים של פעילות בקבוצות Enterprise. |
jamboard |
בדוחות הפעילות ב-Jamboard מוצג מידע על אירועי פעילות שונים ב-Jamboard. |
login |
דוחות הפעילות של אפליקציית ההתחברות מחזירים פרטי חשבון לגבי סוגים שונים של אירועי פעילות התחברות. |
meet |
בדוח פעילות הביקורת ב-Meet מוצג מידע על סוגים שונים של אירועי פעילות ביקורת ב-Meet. |
mobile |
בדוח 'פעילות ביקורת מכשירים' מוצג מידע על סוגים שונים של אירועי פעילות ביקורת מכשירים. |
rules |
בדוח הפעילות של הכללים מוצג מידע על סוגים שונים של אירועי פעילות בכללים. |
saml |
דוח הפעילות של SAML מחזיר מידע על סוגים שונים של אירועי פעילות SAML. |
token |
דוחות הפעילות של אפליקציית האסימון מחזירים פרטי חשבון לגבי סוגים שונים של אירועים של פעילות אסימונים. |
user_accounts |
דוחות הפעילות של האפליקציה 'חשבונות משתמש' מחזירים פרטי חשבון על סוגים שונים של אירועי פעילות בחשבונות משתמשים. |
context_aware_access |
בדוחות 'פעילות מבוססת-הקשר' מוצג מידע על אירועים של דחיית גישה של משתמשים בגלל כללים לבקרת גישה מבוססת-הקשר. |
chrome |
דוחות הפעילות ב-Chrome מחזירים מידע על אירועים בדפדפן Chrome וב-Chrome OS. |
data_studio |
דוחות הפעילות ב-Data Studio מציגים מידע על סוגים שונים של אירועי פעילות ב-Data Studio. |
keep |
דוחות הפעילות של אפליקציית Keep מחזירים מידע על אירועי פעילות שונים ב-Google Keep. דוח הפעילות ב-Keep זמין רק ללקוחות Google Workspace Business ו-Google Workspace Enterprise. |
vault |
בדוחות הפעילות ב-Vault מוצגים מידע על סוגים שונים של אירועי פעילות ב-Vault. |
פעילות
תבנית JSON למשאב הפעילות.
ייצוג JSON |
---|
{ "kind": string, "etag": string, "ownerDomain": string, "ipAddress": string, "events": [ { "type": string, "name": string, "parameters": [ { "messageValue": { "parameter": [ { object ( |
שדות | |
---|---|
kind |
הסוג של משאב ה-API. בדוח פעילות, הערך הוא |
etag |
ה-ETag של הרשומה. |
ownerDomain |
זהו הדומיין שמושפע מהאירוע בדוח. לדוגמה, הדומיין של מסוף Admin או הבעלים של המסמך של אפליקציית Drive. |
ipAddress |
כתובת ה-IP של המשתמש שמבצע את הפעולה. זוהי כתובת פרוטוקול האינטרנט (IP) של המשתמש כשהוא מתחבר ל-Google Workspace, והיא לא בהכרח משקפת את המיקום הפיזי של המשתמש. לדוגמה, כתובת ה-IP יכולה להיות כתובת שרת ה-proxy של המשתמש, או כתובת רשת וירטואלית פרטית (VPN). ה-API תומך ב-IPv4 וב-IPv6. |
events[] |
אירועי פעילות בדוח. |
events[].type |
סוג האירוע. השירות או התכונה של Google Workspace שאדמין משנה מזוהים בנכס |
events[].name |
שם האירוע. זהו השם הספציפי של הפעילות שמדווחת על ידי ה-API. כל
מידע נוסף על נכסי eventName זמין ברשימת שמות האירועים השונים של האפליקציות שלמעלה בקטע applicationName .
|
events[].parameters[] |
זוגות של ערכי פרמטרים לאפליקציות שונות. למידע נוסף על פרמטרים של |
events[].parameters[].messageValue |
צמדים של ערכי פרמטר מקוננים המשויכים לפרמטר הזה. סוג של ערך מורכב של פרמטר מוחזר כרשימה של ערכי פרמטרים. לדוגמה, לפרמטר address יכול להיות ערך |
events[].parameters[].messageValue.parameter[] |
ערכי פרמטרים |
events[].parameters[].name |
שם הפרמטר. |
events[].parameters[].value |
ערך המחרוזת של הפרמטר. |
events[].parameters[].multiValue[] |
ערכי המחרוזת של הפרמטר. |
events[].parameters[].intValue |
ערך מספר שלם של הפרמטר. |
events[].parameters[].multiIntValue[] |
מספרים שלמים של הפרמטר. |
events[].parameters[].boolValue |
ערך בוליאני של הפרמטר. |
events[].parameters[].multiMessageValue[] |
activity.list של |
events[].parameters[].multiMessageValue[].parameter[] |
ערכי פרמטרים |
id |
מזהה ייחודי לכל רשומת פעילות. |
id.time |
שעת ההתרחשות של הפעילות. מדובר בפרק זמן של מערכת UNIX בשניות. |
id.uniqueQualifier |
מזהה ייחודי אם למספר אירועים יש את אותו זמן. |
id.applicationName |
שם האפליקציה שהאירוע שייך אליה. לערכים אפשריים ברשימת האפליקציות שלמעלה, אפשר לעיין ב |
id.customerId |
המזהה הייחודי של חשבון Google Workspace. |
actor |
המשתמש מבצע את הפעולה. |
actor.profileId |
מזהה הפרופיל הייחודי של מבצע הפעולה ב-Google Workspace. יכול להיות שהערך הזה חסר אם הגורם אינו משתמש ב-Google Workspace, או שהוא יכול להיות המספר 105250506097979753968 המשמש כמזהה placeholder. |
actor.email |
כתובת האימייל הראשית של מבצע הפעולה. השדה הזה יכול להיות חסר אם אין כתובת אימייל שמשויכת לשחקן. |
actor.callerType |
סוג השחקן. |
actor.key |
מוצג רק אם הערך של |