Method: users.watch

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

בקשת HTTP

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

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

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

פרמטרים
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

חיפוש מחרוזת שאילתה. מכיל סעיף חיפוש אחד או יותר, שלכל אחד מהם יש שדה, אופרטור וערך. לעיון במסמכי העזרה המלאים, אפשר לעבור אל חיפוש משתמשים.
showDeleted

string

אם המדיניות מוגדרת כ-True, המערכת מאחזרת את רשימת המשתמשים שנמחקו. (ברירת מחדל: false)
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

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

EventType

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

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

OrderBy

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

היטל

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

SortOrder

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

ViewType

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