Method: activities.watch

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

طلب HTTP

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

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

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

المعلمات
userKey or all

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، سيعرض التقرير جميع الأنشطة من startTime حتى الوقت الحالي أو آخر 180 يومًا إذا كان startTime أكثر من 180 يومًا في الماضي.
eventName

string

اسم الحدث الذي تبحث عنه واجهة برمجة التطبيقات. ترتبط كل eventName بخدمة أو ميزة معيّنة في Google Workspace تنظّمها واجهة برمجة التطبيقات على شكل أنواع من الأحداث. ومن الأمثلة على ذلك أحداث "تقويم Google" في تقارير تطبيق "وحدة تحكّم المشرف". تحتوي بنية إعدادات التقويم type على جميع أنشطة تقويم eventName التي تم الإبلاغ عنها من خلال واجهة برمجة التطبيقات. عندما يغيّر المشرف إعداد "تقويم Google"، تسجّل واجهة برمجة التطبيقات هذا النشاط في المَعلمتَين type وeventName في إعدادات "تقويم Google". لمزيد من المعلومات عن سلاسل طلبات البحث والمَعلمات الخاصة بـ 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 معلومات حول أحداث أنشطة Google Cloud Platform المختلفة.
gplus تعرض تقارير نشاط تطبيق +Google معلومات حول أحداث أنشطة +Google المتنوعة.
groups

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

تعرض تقارير نشاط "مجموعات Google" معلومات عن أحداث أنشطة مجموعة 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.