דף זה תורגם על ידי Cloud Translation API.

Method: activities.watch

בקשת HTTP
פרמטרים של נתיב
פרמטרים של שאילתה
גוף הבקשה
גוף התגובה
- ייצוג JSON
היקפי הרשאה
ApplicationName

להתחיל לקבל התראות על פעילויות בחשבון. מידע נוסף זמין במאמר בנושא קבלת התראות Push.

בקשת HTTP

POST https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}/watch

כתובת ה-URL משתמשת בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים

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

userKey or all

string

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

applicationName

enum (ApplicationName)

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

פרמטרים של שאילתה

פרמטרים
`actorIpAddress`	`string` כתובת פרוטוקול האינטרנט (IP) של המארח שבו בוצע האירוע. זו דרך נוספת לסנן את הסיכום של דוח לפי כתובת ה-IP של המשתמש שהפעילות שלו מדווחת. יכול להיות שכתובת ה-IP הזו תשקף את המיקום הפיזי של המשתמש, ויכול להיות שלא. לדוגמה, כתובת ה-IP יכולה להיות הכתובת של שרת ה-proxy של המשתמש או כתובת של רשת וירטואלית פרטית (VPN). הפרמטר הזה תומך בגרסאות של כתובות IPv4 ו-IPv6.
`customerId`	`string` המזהה הייחודי של הלקוח שאליו רוצים לאחזר נתונים.
`endTime`	`string` מגדיר את סוף טווח הזמן שמוצג בדוח. התאריך הוא בפורמט RFC 3339, לדוגמה 2010-10-28T10:26:35.000Z. ערך ברירת המחדל הוא הזמן המשוער של בקשת ה-API. בדוח API יש שלושה מושגי זמן בסיסיים: התאריך של בקשת ה-API לדוח: התאריך שבו ה-API יצר ואחזר את הדוח. שעת ההתחלה של הדוח: תחילת טווח הזמן שמוצג בדוח. הערך של `startTime` צריך להיות לפני הערך של `endTime` (אם הוא צוין) ולפני השעה הנוכחית בזמן שליחת הבקשה, אחרת ה-API יחזיר שגיאה. שעת הסיום של הדוח: סוף טווח הזמן שמוצג בדוח. לדוגמה, טווח הזמן של אירועים שמסוכמים בדוח יכול להתחיל באפריל ולהסתיים במאי. אפשר לבקש את הדוח עצמו באוגוסט. אם לא מציינים את `endTime`, הדוח מחזיר את כל הפעילויות מ-`startTime` עד השעה הנוכחית, או מ-180 הימים האחרונים אם `startTime` חל לפני יותר מ-180 ימים.
`eventName`	`string` שם האירוע שנשלח לגביו שאילתה באמצעות ה-API. כל `eventName` קשור לשירות או לתכונה ספציפיים של Google Workspace, שה-API מארגן לסוגים של אירועים. דוגמה לכך היא האירועים ביומן Google בדוחות של אפליקציית מסוף Admin. המבנה של Calendar Settings `type` כולל את כל הפעילויות ביומן `eventName` שמדווחות על ידי ה-API. כשאדמין משנה הגדרה ביומן, ה-API מדווח על הפעילות הזו בפרמטרים של הגדרות היומן `type` ו-`eventName`. מידע נוסף על פרמטרים ומחרוזות של שאילתות זמין ברשימת שמות האירועים לאפליקציות שונות שלמעלה בקטע `applicationName`.`eventName`
`filters`	`string` מחרוזת השאילתה `filters` היא רשימה מופרדת בפסיקים שמורכבת מפרמטרים של אירועים שעברו מניפולציה על ידי אופרטורים יחסיים. הפרמטרים של האירועים הם מהצורה `{parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...` פרמטרים של אירועים כאלה משויכים ל`eventName` ספציפי. אם הפרמטר של הבקשה לא שייך ל-`eventName`, יוחזר דוח ריק. מידע נוסף על השדות הזמינים `eventName` לכל אפליקציה והפרמטרים שמשויכים אליהם זמין בטבלה ApplicationName. כדי לעבור לדף Activity Events (אירועי פעילות) באפליקציה הרצויה, לוחצים על הקישור בנספח. בדוגמאות הבאות של פעילות ב-Drive, הרשימה שמוחזרת כוללת את כל האירועים מסוג `edit` שבהם ערך הפרמטר `doc_id` תואם לתנאים שהוגדרו על ידי האופרטור הרלציוני. בדוגמה הראשונה, הבקשה מחזירה את כל המסמכים שנערכו עם ערך `doc_id` ששווה ל-`12345`. בדוגמה השנייה, הדוח מחזיר את כל המסמכים שנערכו שבהם הערך של `doc_id` לא שווה ל-`98765`. האופרטור `<>` מקודד בכתובת ה-URL במחרוזת השאילתה של הבקשה (`%3C%3E`): `GET...&eventName=edit&filters=doc_id==12345 GET...&eventName=edit&filters=doc_id%3C%3E98765` `filters` שאילתה תומכת באופרטורים הרלציוניים הבאים: `==` – 'שווה ל'. ‫`<>` – 'לא שווה לערך'. הקידוד חייב להיות לפי כתובת URL (%3C%3E). ‫`<`—'פחות מ'. חייב להיות מקודד בקידוד URL ‏ (%3C). ‫`<=` – 'קטן מ- או שווה ל-'. חייב להיות מקודד בקידוד URL ‏ (%3C=). `>` – 'גדול מ'. חייב להיות מקודד בקידוד URL ‏ (%3E). ‫`>=`—'גדול מ- או שווה ל-'. הקידוד חייב להיות לפי כתובת URL ‏ (%3E=). הערה: ה-API לא מקבל כמה ערכים של אותו פרמטר. אם פרמטר מסופק יותר מפעם אחת בבקשת ה-API, ה-API מקבל רק את הערך האחרון של הפרמטר הזה. בנוסף, אם בבקשת ה-API מצוין פרמטר לא תקין, ה-API מתעלם מהפרמטר הזה ומחזיר את התגובה שמתאימה לפרמטרים התקינים שנותרו. אם לא נשלחת בקשה לפרמטרים, כל הפרמטרים מוחזרים.
`maxResults`	`integer` קובע כמה רשומות של פעילות מוצגות בכל דף של תשובות. לדוגמה, אם הבקשה מגדירה `maxResults=1` והדוח כולל שתי פעילויות, הדוח כולל שני דפים. המאפיין `nextPageToken` בתגובה מכיל את הטוקן של הדף השני. מחרוזת השאילתה `maxResults` היא אופציונלית בבקשה. ערך ברירת המחדל הוא 1,000.
`orgUnitID (deprecated)`	`string` ‫`Deprecated`. השדה הזה הוצא משימוש ולא נתמך יותר. המזהה של היחידה הארגונית שעליה רוצים לדווח. רשומות הפעילות יוצגו רק למשתמשים ששייכים ליחידה הארגונית שצוינה. נתונים מלפני 17 בדצמבר 2018 לא יופיעו בתוצאות המסוננות.
`pageToken`	`string` הטוקן שמשמש לציון הדף הבא. דוח עם כמה דפים כולל את המאפיין `nextPageToken` בתשובה. בבקשה הבאה לקבלת הדף הבא של הדוח, מזינים את הערך של `nextPageToken` במחרוזת השאילתה `pageToken`.
`startTime`	`string` מגדיר את תחילת טווח הזמן שמוצג בדוח. התאריך הוא בפורמט RFC 3339, לדוגמה 2010-10-28T10:26:35.000Z. הדוח מחזיר את כל הפעילויות מ-`startTime` עד `endTime`. הערך של `startTime` צריך להיות לפני הערך של `endTime` (אם הוא צוין) ולפני השעה הנוכחית בזמן שליחת הבקשה, אחרת ה-API יחזיר שגיאה.
`groupIdFilter (deprecated)`	`string` ‫`Deprecated`. השדה הזה הוצא משימוש ולא נתמך יותר. מזהי קבוצות (מוסתרים) מופרדים בפסיקים שפעילויות המשתמשים מסוננות לפיהם, כלומר התגובה תכיל פעילויות רק של משתמשים ששייכים לפחות לאחד ממזהי הקבוצות שמוזכרים כאן. פורמט: id:abc123,id:xyz456 חשוב: כדי לסנן לפי קבוצות, צריך להוסיף את הקבוצות באופן מפורש לרשימת ההיתרים של קבוצות הסינון. מידע נוסף על הוספת קבוצות לרשימת ההיתרים של קבוצות הסינון זמין במאמר בנושא סינון תוצאות לפי קבוצה ב-Google

גוף הבקשה

גוף הבקשה מכיל מופע של SubscriptionChannel.

גוף התשובה

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

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON
{ "id": string, "token": string, "expiration": string, "type": string, "address": string, "payload": boolean, "params": { string: string, ... }, "resourceId": string, "resourceUri": string, "kind": string }

ייצוג ב-JSON

{
  "id": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "payload": boolean,
  "params": {
    string: string,
    ...
  },
  "resourceId": string,
  "resourceUri": string,
  "kind": string
}

שדות
`id`	`string` מזהה UUID או מחרוזת ייחודית דומה שמזהה את הערוץ.
`token`	`string` מחרוזת שרירותית שמועברת לכתובת היעד עם כל התראה שמועברת בערוץ הזה. אופציונלי.
`expiration`	`string (int64 format)` התאריך והשעה של תפוגת ערוץ ההתראות, בפורמט חותמת זמן של מערכת Unix, באלפיות השנייה. אופציונלי.
`type`	`string` סוג מנגנון המסירה שמשמש בערוץ הזה. הערך צריך להיות `"web_hook"`.
`address`	`string` הכתובת שאליה נשלחות ההתראות מהערוץ הזה.
`payload`	`boolean` ערך בוליאני שמציין אם נדרש מטען ייעודי. מטען ייעודי הוא נתונים שנשלחים בגוף של הודעת HTTP POST, ‏ PUT או PATCH, ומכילים מידע חשוב על הבקשה. אופציונלי.
`params`	`map (key: string, value: string)` פרמטרים נוספים ששולטים בהתנהגות של ערוץ המסירה. אופציונלי. אובייקט שמכיל רשימה של `"key": value` זוגות. דוגמה: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`
`resourceId`	`string` מזהה אטום שמזהה את המשאב שנמצא במעקב בערוץ הזה. יציב בגרסאות שונות של ה-API.
`resourceUri`	`string` מזהה ספציפי לגרסה של המשאב שנמצא במעקב.
`kind`	`string` הערך הזה מציין שזהו ערוץ התראות שמשמש למעקב אחרי שינויים במשאב, שהוא `api#channel`.

היקפי הרשאה

נדרש היקף ההרשאות הבא של OAuth:

https://www.googleapis.com/auth/admin.reports.audit.readonly

מידע נוסף זמין במדריך ההרשאות.

ApplicationName