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/workspace/admin/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 | نتایج فقط شامل فیلدهایی برای کاربر است که به صورت عمومی برای سایر کاربران در دامنه قابل مشاهده است. |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[],[],null,["# Method: users.watch\n\nWatches for changes in users list.\n\n### HTTP request\n\n`POST https://admin.googleapis.com/admin/directory/v1/users/watch`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `domain` | `string` Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.\" |\n| `customer` | `string` Immutable ID of the Google Workspace account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain. |\n| `event` | `enum (`[EventType](/workspace/admin/directory/reference/rest/v1/users/watch#EventType)`)` Events to watch for. |\n| `customFieldMask` | `string` Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom. |\n| `maxResults` | `integer` Maximum number of results to return. |\n| `orderBy` | `enum (`[OrderBy](/workspace/admin/directory/reference/rest/v1/users/watch#OrderBy)`)` Column to use for sorting results |\n| `pageToken` | `string` Token to specify next page in the list |\n| `projection` | `enum (`[Projection](/workspace/admin/directory/reference/rest/v1/users/watch#Projection)`)` What subset of fields to fetch for this user. |\n| `query` | `string` Query string search. Should be of the form \"\". Complete documentation is at https: //developers.google.com/workspace/admin/directory/v1/guides/search-users |\n| `showDeleted` | `string` If set to true, retrieves the list of deleted users. (Default: false) |\n| `sortOrder` | `enum (`[SortOrder](/workspace/admin/directory/reference/rest/v1/users/watch#SortOrder)`)` Whether to return results in ascending or descending order. |\n| `viewType` | `enum (`[ViewType](/workspace/admin/directory/reference/rest/v1/users/watch#ViewType)`)` Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin). |\n\n### Request body\n\nThe request body contains an instance of [SubscriptionChannel](/workspace/admin/directory/reference/rest/v1/SubscriptionChannel).\n\n### Response body\n\nIf successful, the response body contains an instance of [SubscriptionChannel](/workspace/admin/directory/reference/rest/v1/SubscriptionChannel).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/admin.directory.user`\n- `\n https://www.googleapis.com/auth/admin.directory.user.readonly`\n- `\n https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nEventType\n---------\n\nType of the Subscription event\n\n| Enums ||\n|--------------|--------------------------------|\n| `ADD` | User Created Event |\n| `DELETE` | User Deleted Event |\n| `MAKE_ADMIN` | User Admin Status Change Event |\n| `UNDELETE` | User Undeleted Event |\n| `UPDATE` | User Updated Event |\n\nOrderBy\n-------\n\n| Enums ||\n|---------------|----------------------------|\n| `EMAIL` | Primary email of the user. |\n| `FAMILY_NAME` | User's family name. |\n| `GIVEN_NAME` | User's given name. |\n\nProjection\n----------\n\n| Enums ||\n|----------|------------------------------------------------------------------|\n| `BASIC` | Do not include any custom fields for the user. |\n| `CUSTOM` | Include custom fields from schemas mentioned in customFieldMask. |\n| `FULL` | Include all fields associated with this user. |\n\nSortOrder\n---------\n\n| Enums ||\n|--------------|-------------------|\n| `ASCENDING` | Ascending order. |\n| `DESCENDING` | Descending order. |\n\nViewType\n--------\n\n| Enums ||\n|-----------------|--------------------------------------------------------------------------------------------------|\n| `admin_view` | Results include both administrator-only and domain-public fields. |\n| `domain_public` | Results only include fields for the user that are publicly visible to other users in the domain. |"]]
