Method: activities.list

استرداد قائمة الأنشطة لحساب وتطبيق عميل معين مثل تطبيق وحدة تحكم المشرف أو تطبيق Google Drive. لمزيد من المعلومات، يُرجى الاطّلاع على أدلة تقارير نشاط المشرف وGoogle Drive. لمزيد من المعلومات عن مَعلمات تقرير النشاط، يمكنك الاطّلاع على الأدلة المرجعية لمَعلمات النشاط.

طلب HTTP

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

يستخدم عنوان 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

string

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

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"

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

نموذج JSON لمجموعة من الأنشطة

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

تمثيل JSON
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (Activity)
    }
  ],
  "nextPageToken": string
}
الحقول
kind

string

نوع مورد واجهة برمجة التطبيقات. بالنسبة إلى تقرير النشاط، تكون القيمة هي reports#activities.

etag

string

علامة ETag للمورد.

items[]

object (Activity)

كل سجل نشاط في الرد.

nextPageToken

string

رمز مميز لاسترداد الصفحة التالية للمتابعة من التقرير. يتم استخدام قيمة nextPageToken في سلسلة طلب البحث pageToken الخاصة بالطلب.

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

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

النشاط

نموذج JSON لمورد النشاط

تمثيل JSON
{
  "kind": string,
  "etag": string,
  "ownerDomain": string,
  "ipAddress": string,
  "events": [
    {
      "type": string,
      "name": string,
      "parameters": [
        {
          "messageValue": {
            "parameter": [
              {
                object (NestedParameter)
              }
            ]
          },
          "name": string,
          "value": string,
          "multiValue": [
            string
          ],
          "intValue": string,
          "multiIntValue": [
            string
          ],
          "boolValue": boolean,
          "multiMessageValue": [
            {
              "parameter": [
                {
                  object (NestedParameter)
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "id": {
    "time": string,
    "uniqueQualifier": string,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "profileId": string,
    "email": string,
    "callerType": string,
    "key": string
  }
}
الحقول
kind

string

نوع مورد واجهة برمجة التطبيقات. بالنسبة إلى تقرير النشاط، تكون القيمة هي audit#activity.

etag

string

علامة ETag للإدخال.

ownerDomain

string

هذا هو النطاق الذي سيتأثر بحدث التقرير. على سبيل المثال، نطاق وحدة تحكّم المشرف أو مالك مستند تطبيق Drive.

ipAddress

string

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

events[]

object

أحداث النشاط في التقرير

events[].type

string

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

events[].name

string

اسم الحدث هذا هو الاسم المحدّد للنشاط الذي تم الإبلاغ عنه من خلال واجهة برمجة التطبيقات. ويرتبط كل eventName بخدمة أو ميزة معيّنة في Google Workspace تنظّم واجهة برمجة التطبيقات هذه البيانات ضمن أنواع أحداث.
بالنسبة إلى معلَمات طلب eventName بشكل عام:

  • وإذا لم يتم تقديم eventName، يعرض التقرير جميع حالات استخدام eventName المحتمَلة.
  • عند طلب eventName، يعرض استجابة واجهة برمجة التطبيقات جميع الأنشطة التي تحتوي على eventName.

لمزيد من المعلومات عن خصائص eventName، يمكنك الاطّلاع على قائمة أسماء الأحداث للتطبيقات المختلفة أعلاه في applicationName.

events[].parameters[]

object

أزواج من قيم المَعلمات لتطبيقات مختلفة. لمزيد من المعلومات عن مَعلمات eventName، اطّلِع على قائمة أسماء الأحداث للتطبيقات المختلفة أعلاه في applicationName.

events[].parameters[].messageValue

object

أزواج قيم المَعلمات المتداخلة المرتبطة بهذه المَعلمة. يتم عرض نوع القيمة المعقد للمَعلمة كقائمة من قيم المَعلمات. على سبيل المثال، قد تكون قيمة معلَمة العنوان هي [{parameter: [{name: city, value: abc}]}].

events[].parameters[].messageValue.parameter[]

object (NestedParameter)

قيم المَعلمات

events[].parameters[].name

string

اسم المَعلمة.

events[].parameters[].value

string

قيمة سلسلة المعلَمة

events[].parameters[].multiValue[]

string

قيم السلسلة للمَعلمة

events[].parameters[].intValue

string (int64 format)

قيمة عدد صحيح للمعلَمة

events[].parameters[].multiIntValue[]

string (int64 format)

تمثّل هذه السمة القيم الصحيحة للمَعلمة.

events[].parameters[].boolValue

boolean

قيمة منطقية للمَعلمة

events[].parameters[].multiMessageValue[]

object

activity.قائمة من messageValue عنصر.

events[].parameters[].multiMessageValue[].parameter[]

object (NestedParameter)

قيم المَعلمات

id

object

المعرّف الفريد لكل سجلّ نشاط

id.time

string

وقت حدوث النشاط. هذا الوقت في حقبة UNIX بالثواني.

id.uniqueQualifier

string (int64 format)

مؤهِّل فريد إذا كانت هناك أحداث متعدّدة في الوقت نفسه.

id.applicationName

string

اسم التطبيق الذي ينتمي إليه الحدث. للاطّلاع على القيم المحتمَلة، راجِع قائمة التطبيقات أعلاه في applicationName.

id.customerId

string

المعرّف الفريد لحساب Google Workspace

actor

object

المستخدم الذي ينفّذ الإجراء.

actor.profileId

string

تمثّل هذه السمة رقم التعريف الفريد للملف الشخصي للممثِّل على Google Workspace. قد تكون هذه القيمة غير متوفرة إذا لم يكن المنفِّذ من مستخدمي Google Workspace، أو قد يكون الرقم 105250506097979753968 الذي يعمل كرقم تعريف عنصر نائب.

actor.email

string

عنوان البريد الإلكتروني الرئيسي للمنفِّذ قد لا يتوفّر هذا الخيار إذا لم يكن هناك عنوان بريد إلكتروني مرتبط بالمنفِّذ.

actor.callerType

string

تمثّل هذه السمة نوع الممثل.

actor.key

string

لا يتوفّر العرض إلا عندما تكون قيمة الحقل "callerType" هي "KEY". يمكن أن يكون consumer_key لمقدِّم طلبات البيانات من واجهة برمجة التطبيقات OAuth 2LO أو معرِّفًا لحسابات برامج الروبوت.