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

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

تعرض تقارير نشاط مجموعات 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 وGoogle Workspace Enterprise.