يراقب التغييرات في قائمة المستخدمين.
طلب HTTP
POST https://admin.googleapis.com/admin/directory/v1/users/watch
يستخدم عنوان URL بنية تحويل الترميز gRPC.
معلمات طلب البحث
المَعلمات | |
---|---|
domain |
اسم النطاق. املأ هذا الحقل للحصول على مستخدمين من هذا النطاق فقط. لعرض جميع المستخدمين في حقل متعدد النطاقات، يُرجى ملء حقل العميل بدلاً من ذلك". |
customer |
رقم تعريف غير قابل للتغيير لحساب Google Workspace في حال تعدد النطاقات، يجب ملء هذا الحقل بدلاً من النطاق لاسترجاع جميع المستخدمين لأحد العملاء. |
event |
أحداث يجب التنبّه إليها |
customFieldMask |
قائمة مفصولة بفواصل تتضمّن أسماء المخططات. يتم استرجاع جميع الحقول من هذه المخططات. يجب تعيين هذا فقط عندما يكون projection=custom. |
maxResults |
الحد الأقصى لعدد النتائج المطلوب عرضها. |
orderBy |
عمود لاستخدامه لفرز النتائج |
pageToken |
رمز مميز لتحديد الصفحة التالية في القائمة |
projection |
المجموعة الفرعية من الحقول المطلوب جلبها لهذا المستخدم. |
query |
البحث في سلسلة طلب البحث يجب أن يكون على الشكل " |
showDeleted |
في حال ضبطها على "صحيح"، سيتم استرداد قائمة المستخدمين المحذوفين. (الخيار التلقائي: خطأ) |
sortOrder |
يمكنك تحديد ما إذا كان سيتم عرض النتائج بترتيب تصاعدي أم تنازلي. |
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 |
لا تتضمّن النتائج سوى حقول المستخدم التي تظهر بشكل علني للمستخدمين الآخرين في النطاق. |