Method: users.watch

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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/workspace/admin/directory/v1/guides/search-users
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

סוג האירוע Subscription

טיפוסים בני מנייה (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 התוצאות כוללות רק שדות של המשתמש שגלויים לכולם למשתמשים אחרים בדומיין.