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

البحث عن سلسلة طلب البحث يحتوي على عبارة بحث واحدة أو أكثر، كل منها يتضمّن حقلًا وعامل تشغيل وقيمة. للاطّلاع على المستندات الكاملة، انتقِل إلى البحث عن مستخدمين.
showDeleted

string

في حال ضبطها على "صحيح"، يتم استرداد قائمة المستخدمين المحذوفين. (القيمة التلقائية: 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

نوع حدث الاشتراك

عمليات التعداد
ADD حدث من إنشاء المستخدم
DELETE حدث حذف المستخدم
MAKE_ADMIN حدث تغيير حالة مشرف المستخدم
UNDELETE حدث إلغاء حذف حساب المستخدم
UPDATE حدث تعديل المستخدم

OrderBy

عمليات التعداد
EMAIL عنوان البريد الإلكتروني الرئيسي للمستخدم
FAMILY_NAME اسم عائلة المستخدم.
GIVEN_NAME الاسم الأول للمستخدم.

الإسقاط

عمليات التعداد
BASIC لا تضمِّن أي حقول مخصّصة للمستخدم.
CUSTOM تضمين الحقول المخصّصة من المخططات المذكورة في customFieldMask
FULL أدرِج جميع الحقول المرتبطة بهذا المستخدم.

SortOrder

عمليات التعداد
ASCENDING ترتيب تصاعدي
DESCENDING ترتيب تنازلي

ViewType

عمليات التعداد
admin_view تتضمّن النتائج الحقول المتاحة للمشرفين فقط والحقول المتاحة للجميع في النطاق.
domain_public لا تتضمّن النتائج سوى الحقول الخاصة بالمستخدم والتي يمكن للمستخدمين الآخرين في النطاق الاطّلاع عليها.