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/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
لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
EventType
| عمليات التعداد |
ADD |
حدث من إنشاء المستخدِم |
DELETE |
حدث حذف المستخدم |
MAKE_ADMIN |
حدث تغيير حالة المشرف للمستخدم |
UNDELETE |
حدث إلغاء حذف حساب المستخدم |
UPDATE |
حدث تم تعديله من قِبل المستخدم |
OrderBy
| عمليات التعداد |
EMAIL |
عنوان البريد الإلكتروني الأساسي للمستخدم |
FAMILY_NAME |
اسم عائلة المستخدم. |
GIVEN_NAME |
الاسم الأول للمستخدم. |
الإسقاط
| عمليات التعداد |
BASIC |
لا تُدرِج أي حقول مخصّصة للمستخدم. |
CUSTOM |
تضمين الحقول المخصّصة من المخططات المذكورة في customFieldMask |
FULL |
يجب تضمين جميع الحقول المرتبطة بهذا المستخدِم. |
SortOrder
| عمليات التعداد |
ASCENDING |
ترتيب تصاعدي |
DESCENDING |
ترتيب تنازلي |
ViewType
| عمليات التعداد |
admin_view |
وتشمل النتائج كلاً من الحقول الخاصة بالمسؤولين فقط والحقول المتاحة للجميع في النطاق. |
domain_public |
لا تتضمّن النتائج سوى حقول المستخدم التي تكون مرئية للجميع للمستخدمين الآخرين في النطاق. |
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة 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. |"]]
