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

Method: users.watch

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

בקשת HTTP

POST https://admin.googleapis.com/admin/directory/v1/users/watch

כתובת ה-URL כוללת תחביר של קידוד gRPC.

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

פרמטרים
`domain`	`string` שם הדומיין. יש למלא את השדה הזה כדי לקבל משתמשים רק מהדומיין הזה. כדי להחזיר את כל המשתמשים בשדה לקוח שמכיל כמה דומיינים, צריך במקום זאת למלא את השדה הזה.
`customer`	`string` המזהה הקבוע של חשבון Google Workspace. במקרה של ריבוי דומיינים, כדי לאחזר את כל המשתמשים של לקוח, ממלאים את השדה הזה במקום את הדומיין.
`event`	`enum (EventType)` אירועים שכדאי לבדוק.
`customFieldMask`	`string` רשימה של שמות סכימה מופרדים בפסיקים. כל השדות מהסכימות האלה מאוחזרים. צריך להגדיר זאת רק כאשר Projection=custom.
`maxResults`	`integer` מספר התוצאות המקסימלי להחזרה.
`orderBy`	`enum (OrderBy)` עמודה למיון תוצאות
`pageToken`	`string` אסימון לציון הדף הבא ברשימה
`projection`	`enum (Projection)` איזו קבוצת משנה של שדות לאחזור עבור המשתמש הזה.
`query`	`string` חיפוש מחרוזת שאילתה. הכתובת צריכה להיות בפורמט "". את המסמכים המלאים אפשר למצוא בכתובת: https: //developers.google.com/admin-sdk/directory/v1/guides/search-users
`showDeleted`	`string` אם המדיניות מוגדרת כ-True, המערכת מאחזרת את רשימת המשתמשים שנמחקו. (ברירת המחדל: לא נכון)
`sortOrder`	`enum (SortOrder)` האם להחזיר תוצאות בסדר עולה או יורד.
`viewType`	`enum (ViewType)` האם לאחזר את התצוגה הציבורית של משתמש עבור מנהל מערכת בלבד או ברמת הדומיין. מידע נוסף מופיע בקטע אחזור של משתמש שאינו מנהל מערכת.

גוף הבקשה

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

גוף התשובה

אם הפעולה בוצעה בהצלחה, גוף התגובה מכיל מופע של SubscriptionChannel.

היקפי הרשאה

מחייב אחד מהיקפי ההרשאות הבאים של OAuth:

https://www.googleapis.com/auth/admin.directory.user
https://www.googleapis.com/auth/admin.directory.user.readonly
https://www.googleapis.com/auth/cloud-platform

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

סוג האירוע

סוג אירוע המינוי

טיפוסים בני מנייה (enum)
`ADD`	אירוע שנוצר על ידי המשתמש
`DELETE`	אירוע של משתמש שנמחק
`MAKE_ADMIN`	אירוע שינוי סטטוס של אדמין משתמש
`UNDELETE`	אירוע של משתמש שלא נמחק
`UPDATE`	אירוע שעודכן על ידי המשתמש

סדר לפי

טיפוסים בני מנייה (enum)
`EMAIL`	כתובת האימייל הראשית של המשתמש.
`FAMILY_NAME`	שם המשפחה של המשתמש.
`GIVEN_NAME`	השם הפרטי של המשתמש.

תחזית

טיפוסים בני מנייה (enum)
`BASIC`	אין לכלול שדות מותאמים אישית למשתמש.
`CUSTOM`	כולל שדות מותאמים אישית מסכימות שצוינו ב-customFieldMask.
`FULL`	יש לכלול את כל השדות המשויכים למשתמש הזה.

SortOrder

טיפוסים בני מנייה (enum)
`ASCENDING`	סדר עולה.
`DESCENDING`	סדר יורד.

סוג התצוגה המפורטת

טיפוסים בני מנייה (enum)
`admin_view`	התוצאות כוללות הן שדות של אדמין בלבד והן של דומיין ציבורי.
`domain_public`	התוצאות כוללות רק שדות עבור המשתמש שגלויים למשתמשים אחרים בדומיין.