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 لا تتضمّن النتائج سوى حقول المستخدم التي تكون مرئية للجميع للمستخدمين الآخرين في النطاق.