- בקשת 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
טיפוסים בני מנייה (enum) | |
---|---|
access_transparency |
בדוחות הפעילות של Google Workspace Access Transparency מוחזר מידע על סוגים שונים של אירועי פעילות של שקיפות גישה. |
admin |
דוחות הפעילות של האפליקציה של מסוף Admin מחזירים פרטי חשבון לגבי סוגים שונים של אירועי פעילות של אדמין. |
calendar |
דוחות הפעילות של אפליקציית יומן Google מחזירים מידע על אירועי פעילות שונים ביומן. |
chat |
בדוחות הפעילות ב-Chat מוצג מידע על אירועי פעילות שונים ב-Chat. |
drive |
בדוחות הפעילות של אפליקציית Google Drive מוצגים מידע לגבי אירועי פעילות שונים ב-Google Drive. דוח הפעילות ב-Drive זמין רק ללקוחות Google Workspace Business ו-Enterprise. |
gcp |
דוחות הפעילות של אפליקציית Google Cloud Platform מחזירים מידע על אירועי פעילות שונים של GCP. |
gplus |
דוחות הפעילות של אפליקציית Google+ מחזירים מידע לגבי אירועי פעילות שונים ב-Google+. |
groups |
בדוחות הפעילות של האפליקציה 'קבוצות Google' מוצגים מידע על אירועי פעילות שונים בקבוצות 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 וב-ChromeOS. |
data_studio |
בדוחות הפעילות ב-Data Studio מוחזר מידע על סוגים שונים של אירועי פעילות ב-Data Studio. |
keep |
בדוחות הפעילות של אפליקציית Keep מוחזרות מידע על אירועי פעילות שונים ב-Google Keep. דוח הפעילות ב-Keep זמין רק ללקוחות Google Workspace Business ו-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 |
צמדים של ערכי פרמטר בתוך פרמטרים שמשויכים לפרמטר הזה. סוג הערך המורכב של הפרמטר מוחזר כרשימה של ערכי פרמטרים. לדוגמה, יכול להיות שהערך של פרמטר הכתובת יהיה |
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 |
מוצג רק כשהערך בשדה |