تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

Method: activities.watch

طلب HTTP
مَعلمات المسار
معامِلات طلب البحث
نص الطلب
نص الاستجابة
- تمثيل JSON
نطاقات التفويض
ApplicationName

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

طلب 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)` اسم التطبيق الذي سيتم استرداد الأحداث منه

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` ضمن "إعدادات التقويم". لمزيد من المعلومات عن سلاسل طلبات البحث والمَعلمات في `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`. تم إيقاف هذا الحقل نهائيًا ولم يعُد متاحًا للاستخدام. معرّف الوحدة التنظيمية التي سيتم إعداد تقرير عنها. لن يتم عرض سجلّات النشاط إلا للمستخدمين الذين ينتمون إلى الوحدة التنظيمية المحدّدة. لن تظهر البيانات المسجّلة بتاريخ يسبق 17 ديسمبر 2018 ضمن النتائج التي تمت فلترتها.
`pageToken`	`string` الرمز المميز لتحديد الصفحة التالية. يتضمّن التقرير الذي يحتوي على صفحات متعددة السمة `nextPageToken` في الردّ. في طلب المتابعة للحصول على الصفحة التالية من التقرير، أدخِل قيمة `nextPageToken` في سلسلة طلب البحث `pageToken`.
`startTime`	`string` تحدّد هذه السمة بداية النطاق الزمني المعروض في التقرير. يكون التاريخ بتنسيق RFC 3339، مثلاً 2010-10-28T10:26:35.000Z. يعرض التقرير جميع الأنشطة من ‎`startTime` إلى ‎`endTime`. يجب أن يكون `startTime` قبل `endTime` (إذا تم تحديده) والوقت الحالي عند تقديم الطلب، وإلا ستعرض واجهة برمجة التطبيقات رسالة خطأ.
`groupIdFilter (deprecated)`	`string` `Deprecated`. تم إيقاف هذا الحقل نهائيًا ولم يعُد متاحًا للاستخدام. أرقام تعريف المجموعات المفصولة بفواصل (تم إخفاء هويتها) التي يتم فلترة أنشطة المستخدمين عليها، أي أنّ الردّ سيتضمّن أنشطة للمستخدمين الذين يشكّلون جزءًا من رقم تعريف مجموعة واحد على الأقلّ من أرقام التعريف المذكورة هنا. التنسيق: "id:abc123,id:xyz456" ملاحظة مهمة: للفلترة حسب المجموعات، يجب إضافة المجموعات بوضوح إلى القائمة المسموح بها لمجموعات الفلترة. لمزيد من المعلومات حول إضافة مجموعات إلى القائمة المسموح بها لمجموعات الفلترة، يُرجى الاطّلاع على فلترة النتائج حسب "مجموعة Google" .

نص الطلب

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

نص الاستجابة

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

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

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

تمثيل 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