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

جستجوی رشته پرس و جو باید به شکل " ". اسناد کامل در 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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

نوع رویداد

نوع رویداد اشتراک

Enums
ADD رویداد ایجاد شده توسط کاربر
DELETE رویداد حذف شده توسط کاربر
MAKE_ADMIN رویداد تغییر وضعیت ادمین کاربر
UNDELETE رویداد حذف شده توسط کاربر
UPDATE رویداد به روز شده توسط کاربر

سفارش توسط

Enums
EMAIL ایمیل اصلی کاربر
FAMILY_NAME نام خانوادگی کاربر
GIVEN_NAME نام داده شده کاربر

فرافکنی

Enums
BASIC هیچ فیلد سفارشی برای کاربر درج نکنید.
CUSTOM شامل فیلدهای سفارشی از طرحواره های ذکر شده در customFieldMask.
FULL شامل تمام فیلدهای مرتبط با این کاربر باشد.

مرتب سازی

Enums
ASCENDING ترتیب صعودی.
DESCENDING ترتیب نزولی.

ViewType

Enums
admin_view نتایج شامل فیلدهای فقط مدیر و دامنه عمومی است.
domain_public نتایج فقط شامل فیلدهایی برای کاربر است که به صورت عمومی برای سایر کاربران در دامنه قابل مشاهده است.