Method: activities.watch

ابدأ بتلقّي إشعارات بشأن أنشطة الحساب. لمزيد من المعلومات، يُرجى الاطّلاع على تلقّي إشعارات فورية.

طلب HTTP

POST https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}/watch

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
userKey

string

يمثّل رقم تعريف الملف الشخصي أو عنوان البريد الإلكتروني للمستخدم الذي يجب فلترة البيانات له. يمكن أن تكون القيمة all لجميع المعلومات أو userKey لرقم تعريف الملف الشخصي الفريد للمستخدم في Google Workspace أو عنوان بريده الإلكتروني الرئيسي. يجب ألّا يكون مستخدمًا تم حذفه. بالنسبة إلى مستخدم تم حذفه، يمكنك طلب users.list في Directory API باستخدام showDeleted=true، ثم استخدام ID المعروض كuserKey.
applicationName

enum (ApplicationName)

اسم التطبيق المطلوب استرداد الأحداث منه.

مَعلمات طلب البحث

المعلمات
actorIpAddress

string

عنوان بروتوكول الإنترنت (IP) للمضيف الذي تم تنفيذ الحدث عليه. هذه طريقة إضافية لفلترة ملخّص التقرير باستخدام عنوان IP للمستخدم الذي يتم تسجيل نشاطه. قد يعكس عنوان IP هذا الموقع الجغرافي الفعلي للمستخدم أو لا يعكسه. على سبيل المثال، يمكن أن يكون عنوان IP هو عنوان الخادم الوكيل للمستخدم أو عنوان الشبكة الظاهرية الخاصة (VPN). تتيح هذه المَعلمة استخدام إصدارَي العناوين IPv4 وIPv6.
customerId

string

المعرّف الفريد للعميل الذي تريد استرداد بياناته.
endTime

string

لضبط نهاية النطاق الزمني المعروض في التقرير. يتم إدخال التاريخ بـ تنسيق RFC 3339، على سبيل المثال ‎2010-10-28T10:26:35.000Z. القيمة التلقائية هي الوقت التقريبي لطلب واجهة برمجة التطبيقات. يتضمّن تقرير واجهة برمجة التطبيقات ثلاثة مفاهيم أساسية للوقت:

  • تاريخ طلب واجهة برمجة التطبيقات لتقرير: وقت إنشاء واجهة برمجة التطبيقات للتقرير واسترداده.
  • وقت بدء التقرير: بداية الفترة الزمنية المعروضة في التقرير. يجب أن يكون startTime قبل endTime (إذا تم تحديده) والوقت الحالي عند تقديم الطلب، وإلا ستعرِض واجهة برمجة التطبيقات خطأ.
  • وقت انتهاء التقرير: نهاية الفترة الزمنية المعروضة في التقرير. على سبيل المثال، يمكن أن تبدأ الفترة الزمنية للأحداث الملخّصة في تقرير معيّن في نيسان (أبريل) وتنتهي في أيار (مايو)، ويمكن طلب التقرير نفسه في آب (أغسطس).
في حال عدم تحديد endTime، يعرض التقرير جميع الأنشطة من endTime حتى الوقت الحالي أو آخر 180 يومًا إذا كان endTime قبل أكثر من 180 يومًا.startTimestartTime
eventName

string

اسم الحدث الذي تبحث عنه واجهة برمجة التطبيقات. يرتبط كل eventName بخدمة أو ميزة معيّنة في Google Workspace تنظّمها واجهة برمجة التطبيقات إلى أنواع من الأحداث. ومن الأمثلة على ذلك أحداث "تقويم Google" في تقارير تطبيق "وحدة تحكّم المشرف". تحتوي بنية إعدادات "تقويم Google" type على جميع أنشطة "تقويم Google" eventName التي تسجّلها واجهة برمجة التطبيقات. عندما يغيّر مشرف إعدادًا في "تقويم Google"، تسجِّل واجهة برمجة التطبيقات هذا النشاط في مَعلمتَي إعدادات "تقويم Google" type وeventName. لمزيد من المعلومات عن سلاسل طلبات البحث والمَعلمات في eventName، اطّلِع على قائمة أسماء الأحداث للتطبيقات المختلفة أعلاه في applicationName.
filters

string

سلسلة طلب البحث filters هي قائمة مفصولة بفواصل تتألف من مَعلمات الأحداث التي تعالجها عوامل تشغيل علائقية. تكون مَعلمات الأحداث على الشكل {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},....

تكون مَعلمات الأحداث هذه مرتبطة بـ eventName معيّن. يتم عرض تقرير فارغ إذا لم تكن مَعلمة الطلب تنتمي إلى eventName. لمزيد من المعلومات عن حقول eventName المتاحة لكل تطبيق والمَعلمات المرتبطة به، انتقِل إلى جدول ApplicationName، ثم انقر للوصول إلى صفحة "أحداث الأنشطة" في ملحق التطبيق الذي تريده.

في أمثلة أنشطة Drive التالية، تتألف القائمة المعروضة من جميع أحداث edit التي تتطابق فيها قيمة المَعلمة doc_id مع الشروط التي يحدّدها عامل التشغيل التعريفي. في المثال الأول، يعرض الطلب جميع المستندات المعدَّلة التي تكون قيمة doc_id فيها تساوي 12345. في المثال الثاني، يعرض التقرير أي مستندات معدّلة لا تكون فيها قيمة doc_id مساوية لـ 98765. يتم ترميز عامل التشغيل <> بترميز عنوان URL في سلسلة طلب البحث (%3C%3E):

GET...&eventName=edit&filters=doc_id==12345
GET...&eventName=edit&filters=doc_id%3C%3E98765

يتيح طلب البحث filters عوامل التشغيل التالية ذات الصلة:

  • ==: "يساوي".
  • <> — "لا يساوي". يجب أن تكون مرمَّزة بترميز URL (%3C%3E).
  • <: "أصغر من". يجب أن تكون مرمّزة بترميز URL (%3C).
  • <=: "أقل من أو يساوي". يجب أن يكون بترميز عنوان URL (%3C=).
  • >: "أكبر من". يجب أن يكون ترميزه بنظام عناوين URL (%3E).
  • >=: "أكبر من أو يساوي". يجب أن تكون مُرمّزة لعنوان URL (%3E=).

ملاحظة: لا تقبل واجهة برمجة التطبيقات قيمًا متعدّدة للمَعلمة نفسها. إذا تم تقديم مَعلمة أكثر من مرّة في طلب واجهة برمجة التطبيقات، تقبل واجهة برمجة التطبيقات القيمة الأخيرة للمَعلمة فقط. بالإضافة إلى ذلك، إذا تم تقديم مَعلمة غير صالحة في طلب واجهة برمجة التطبيقات، تتجاهل واجهة برمجة التطبيقات هذه المَعلمة وتُعرِض الردّ المقابل للمَعلمات الصالحة المتبقية. إذا لم يتم طلب أي مَعلمات، يتم عرض جميع المَعلمات.
maxResults

integer

لتحديد عدد سجلات الأنشطة التي يتم عرضها في كل صفحة استجابة. على سبيل المثال، إذا ضبط الطلب maxResults=1 وكان التقرير يتضمّن نشاطَين، يتضمّن التقرير صفحتين. تحتوي السمة nextPageToken الخاصة بالاستجابة على الرمز المميّز الخاص بالصفحة الثانية. سلسلة طلب البحث maxResults اختيارية في الطلب. القيمة التلقائية هي 1000.
orgUnitID
(deprecated)

string

Deprecated. تم إيقاف هذا الحقل نهائيًا ولم يعُد متاحًا.

رقم تعريف الوحدة التنظيمية المطلوب إعداد تقارير عنها. لن يتم عرض سجلّات الأنشطة إلا للمستخدمين الذين ينتمون إلى الوحدة التنظيمية المحدّدة.

pageToken

string

الرمز المميّز لتحديد الصفحة التالية. يحتوي التقرير الذي يتضمّن صفحات متعددة على سمة nextPageToken في الاستجابة. في طلب المتابعة للحصول على الصفحة التالية من التقرير، أدخِل قيمة nextPageToken في سلسلة طلب البحث pageToken.
startTime

string

لضبط بداية النطاق الزمني المعروض في التقرير. يتم إدخال التاريخ بـ تنسيق RFC 3339، على سبيل المثال ‎2010-10-28T10:26:35.000Z. يعرض التقرير جميع الأنشطة من ‎startTime حتى ‎endTime. يجب أن يكون startTime قبل endTime (إذا تم تحديده) والوقت الحالي عند تقديم الطلب، وإلا ستعرِض واجهة برمجة التطبيقات خطأ.
groupIdFilter

string

أرقام تعريف المجموعات مفصولة بفواصل (مموّهة) يتم فلترة أنشطة المستخدمين حسبها، أي أنّ الردّ سيتضمّن أنشطة المستخدمين الذين ينتمون إلى رقم تعريف مجموعة واحد على الأقل من أرقام التعريف المذكورة هنا. التنسيق: "id:abc123,id:xyz456"

نص الطلب

يحتوي نص الطلب على مثال SubscriptionChannel.

نص الاستجابة

قناة إشعارات تُستخدَم للتتبّع المستمر لتغييرات الموارد

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "id": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "payload": boolean,
  "params": {
    string: string,
    ...
  },
  "resourceId": string,
  "resourceUri": string,
  "kind": string
}
الحقول
id

string

معرّف UUID أو سلسلة فريدة مشابهة تُحدّد هذه القناة.
token

string

سلسلة عشوائية يتم إرسالها إلى العنوان المستهدف مع كل إشعار يتم إرساله عبر هذه القناة. اختياريّ.
expiration

string (int64 format)

تاريخ ووقت انتهاء صلاحية قناة الإشعارات، مُعبَّرًا عنه كطابع زمني لنظام التشغيل UNIX، بالمللي ثانية اختياريّ.
type

string

نوع آلية الإرسال المستخدَمة لهذه القناة. يجب ضبط القيمة على "web_hook".
address

string

العنوان الذي يتم إرسال الإشعارات إليه لهذه القناة.
payload

boolean

قيمة منطقية للإشارة إلى ما إذا كان يتم طلب الحمولة الحمولة هي البيانات التي يتم إرسالها في نص رسالة HTTP POST أو PUT أو PATCH وتحتوي على معلومات مهمة حول الطلب. اختياريّ.
params

map (key: string, value: string)

مَعلمات إضافية تتحكّم في سلوك قناة الإرسال اختياريّ.

عنصر يحتوي على قائمة بأزواج "key": value مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }
resourceId

string

معرّف مبهم يحدد المورد الذي تتم مشاهدته على هذه القناة. أن تكون مستقرة في جميع إصدارات واجهة برمجة التطبيقات المختلفة
resourceUri

string

معرّف خاص بالإصدار للمورد الذي تتم مشاهدته
kind

string

يحدّد هذا الحقل على أنّه قناة إشعارات تُستخدَم لرصد التغييرات في أحد الموارد، وهو "api#channel".

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/admin.reports.audit.readonly

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

ApplicationName

اسم التطبيق المطلوب استرداد الأحداث منه.

عمليات التعداد
access_transparency

تعرض تقارير نشاط "شفافية الوصول إلى Google Workspace" معلومات عن الأنواع المختلفة من أحداث نشاط "شفافية الوصول".
admin

تعرض تقارير النشاط في تطبيق وحدة تحكم المشرف معلومات الحساب حول أنواع مختلفة من أحداث نشاط المشرف.
calendar

تعرِض تقارير النشاط في تطبيق "تقويم Google" معلومات عن أحداث نشاط "تقويم Google" المختلفة.
chat تعرِض تقارير نشاط Chat معلومات عن أحداث نشاط Chat المختلفة.
drive

تعرض تقارير النشاط في تطبيق Google Drive معلومات عن أحداث نشاط Google Drive المختلفة. لا يتوفّر تقرير نشاط Drive إلا لعملاء Google Workspace Business وGoogle Workspace Enterprise.
gcp تعرض تقارير نشاط تطبيق Google Cloud Platform معلومات حول أحداث أنشطة GCP مختلفة.
gplus تعرِض تقارير النشاط في تطبيق Google+ معلومات عن أحداث النشاط على Google+ المختلفة.
groups

تعرِض تقارير النشاط في تطبيق "مجموعات Google" معلومات عن أحداث نشاط "مجموعات Google" المختلفة.
groups_enterprise

تعرِض تقارير نشاط "مجموعات Google" لإصدار Enterprise معلومات عن أحداث نشاط مجموعات Enterprise المختلفة.
jamboard تعرِض تقارير نشاط Jamboard معلومات عن أحداث نشاط Jamboard المختلفة.
login

تعرض تقارير نشاط تطبيق "تسجيل الدخول" معلومات الحساب عن الأنواع المختلفة من أحداث نشاط تسجيل الدخول.
meet يعرض تقرير نشاط تدقيق Meet معلومات عن أنواع مختلفة من أحداث نشاط تدقيق Meet.
mobile يعرض تقرير نشاط تدقيق الجهاز معلومات حول الأنواع المختلفة من أحداث أنشطة تدقيق الجهاز.
rules

يعرض تقرير "نشاط القواعد" معلومات عن أنواع مختلفة من أحداث نشاط القواعد.
saml

يعرض تقرير نشاط SAML معلومات عن أنواع مختلفة من أحداث نشاط SAML.
token

تعرض تقارير نشاط تطبيق الرمز المميّز معلومات الحساب عن الأنواع المختلفة من أحداث نشاط الرمز المميّز.
user_accounts

تعرِض تقارير نشاط تطبيق "حسابات المستخدمين" معلومات الحساب حول أنواع مختلفة من أحداث نشاط حسابات المستخدمين.
context_aware_access

تعرض تقارير نشاط "الوصول الواعي بالسياق" معلومات عن أحداث رفض وصول المستخدمين بسبب قواعد الوصول الواعي بالسياق.
chrome

تعرِض تقارير أنشطة Chrome معلومات عن أحداث متصفّح Chrome ونظام التشغيل Chrome.
data_studio تعرِض تقارير الأنشطة في "مركز البيانات" معلومات عن أنواع مختلفة من أحداث الأنشطة في "مركز البيانات".
keep تعرِض تقارير النشاط في تطبيق Keep معلومات عن أحداث النشاط في Google Keep المختلفة. لا يتوفّر تقرير نشاط Keep إلا لعملاء Google Workspace Business وEnterprise.