תתחיל לקבל התראות לגבי פעילויות בחשבון. למידע נוסף, ראו קבלת התראות בדחיפה.
בקשת HTTP
POST https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}/watch
בכתובת ה-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" |
גוף הבקשה
גוף הבקשה מכיל מופע של SubscriptionChannel
.
גוף התשובה
ערוץ התראות שמשמש לצפייה בשינויים במשאבים.
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "id": string, "token": string, "expiration": string, "type": string, "address": string, "payload": boolean, "params": { string: string, ... }, "resourceId": string, "resourceUri": string, "kind": string } |
שדות | |
---|---|
id |
מזהה ייחודי אוניברסלי (UUID) או מחרוזת ייחודית דומה שמזהה את הערוץ הזה. |
token |
מחרוזת שרירותית נמסרת לכתובת היעד בכל הודעה שנשלחת בערוץ הזה. אפשרות. |
expiration |
התאריך והשעה של תפוגת התוקף של ערוץ ההתראות, מבוטאים בחותמת זמן של Unix, באלפיות השנייה. אפשרות. |
type |
סוג מנגנון ההעברה שבו נעשה שימוש בערוץ הזה. הערך צריך להיות |
address |
הכתובת שאליה נשלחות הודעות לגבי הערוץ הזה. |
payload |
ערך בוליאני שמציין אם רוצים להשתמש במטען ייעודי (payload). מטען ייעודי (payload) הוא נתונים שנשלחים בגוף הודעת HTTP POST, PUT או PATCH, ומכילים מידע חשוב על הבקשה. אפשרות. |
params |
פרמטרים נוספים ששולטים בהתנהגות של ערוץ העברה. אפשרות. אובייקט שמכיל רשימה של |
resourceId |
מזהה אטום שמזהה את המשאב שבו צופים בערוץ הזה. עקביות בגרסאות API שונות. |
resourceUri |
מזהה ספציפי לגרסה של המשאב שנצפה. |
kind |
מזהה הערוץ הזה כערוץ התראות שמשמש למעקב אחר שינויים במשאב, ' |
היקפי הרשאות
נדרש היקף ההרשאות הבא של 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. |