Method: activities.list

فهرستی از فعالیت‌ها را برای حساب و برنامه یک مشتری خاص مانند برنامه کنسول Admin یا برنامه Google Drive بازیابی می‌کند. برای اطلاعات بیشتر، به راهنمای گزارش‌های فعالیت سرپرست و Google Drive مراجعه کنید. برای اطلاعات بیشتر در مورد پارامترهای گزارش فعالیت، به راهنمای مرجع پارامترهای فعالیت مراجعه کنید.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
user Key

string

نشان دهنده شناسه نمایه یا ایمیل کاربری است که داده ها باید فیلتر شوند. می‌تواند برای all اطلاعات باشد، یا userKey برای شناسه نمایه Google Workspace منحصربه‌فرد کاربر یا آدرس ایمیل اصلی او باشد. نباید کاربر حذف شده باشد. برای کاربر حذف شده، users.list در Directory API با showDeleted=true فراخوانی کنید، سپس ID برگشتی به عنوان userKey استفاده کنید.

application Name

enum ( ApplicationName )

نام برنامه ای که رویدادها باید برای آن بازیابی شوند.

پارامترهای پرس و جو

پارامترها
actor Ip Address

string

آدرس پروتکل اینترنت (IP) میزبانی که رویداد در آن انجام شده است. این یک راه اضافی برای فیلتر کردن خلاصه گزارش با استفاده از آدرس IP کاربری است که فعالیتش گزارش شده است. این آدرس IP ممکن است مکان فیزیکی کاربر را منعکس کند یا نباشد. به عنوان مثال، آدرس IP می تواند آدرس سرور پروکسی کاربر یا یک آدرس شبکه خصوصی مجازی (VPN) باشد. این پارامتر از هر دو نسخه آدرس IPv4 و IPv6 پشتیبانی می کند.

customer Id

string

شناسه منحصر به فرد مشتری برای بازیابی داده ها.

end Time

string

پایان بازه زمانی نشان داده شده در گزارش را تنظیم می کند. تاریخ در قالب RFC 3339 است، برای مثال 2010-10-28T10:26:35.000Z. مقدار پیش فرض زمان تقریبی درخواست API است. یک گزارش API دارای سه مفهوم زمانی اساسی است:

  • تاریخ درخواست API برای گزارش : زمانی که API گزارش را ایجاد و بازیابی کرد.
  • زمان شروع گزارش : ابتدای بازه زمانی نشان داده شده در گزارش. startTime باید قبل از endTime (در صورت مشخص شدن) و زمان فعلی هنگام درخواست باشد، در غیر این صورت API خطایی را برمی‌گرداند.
  • زمان پایان گزارش : پایان بازه زمانی نشان داده شده در گزارش. به عنوان مثال، بازه زمانی رویدادهای خلاصه شده در یک گزارش می تواند از آوریل شروع شود و در ماه می به پایان برسد. گزارش خود را می توان در ماه اوت درخواست کرد.
اگر endTime مشخص نشده باشد، گزارش تمام فعالیت‌ها را از startTime تا زمان فعلی یا 180 روز اخیر را برمی‌گرداند اگر startTime در گذشته بیش از 180 روز باشد.

event Name

string

نام رویدادی که توسط API درخواست شده است. هر eventName مربوط به یک سرویس یا ویژگی خاص Google Workspace است که API آن را در انواع رویدادها سازماندهی می کند. یک مثال، رویدادهای تقویم Google در گزارش‌های برنامه کنسول مدیریت است. ساختار type تنظیمات تقویم دارای تمام فعالیت‌های Calendar eventName گزارش‌شده توسط API است. وقتی یک سرپرست یک تنظیم تقویم را تغییر می‌دهد، API این فعالیت را در پارامترهای type تنظیمات تقویم و eventName گزارش می‌کند. برای اطلاعات بیشتر در مورد رشته ها و پارامترهای پرس و جو eventName ، لیست نام رویدادها را برای برنامه های مختلف در بالا در applicationName ببینید.

filters

string

رشته پرس و جو filters یک لیست جدا شده با کاما است که از پارامترهای رویداد که توسط عملگرهای رابطه ای دستکاری شده اند تشکیل شده است. پارامترهای رویداد به شکل {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...

این پارامترهای رویداد با یک eventName خاص مرتبط هستند. اگر پارامتر درخواست متعلق به eventName نباشد، یک گزارش خالی برگردانده می‌شود. برای اطلاعات بیشتر در مورد فیلدهای eventName موجود برای هر برنامه و پارامترهای مرتبط با آنها، به جدول ApplicationName بروید، سپس روی صفحه Activity Events در پیوست برای برنامه مورد نظر خود کلیک کنید.

در مثال‌های فعالیت Drive زیر، فهرست بازگشتی شامل تمام رویدادهای edit است که مقدار پارامتر doc_id با شرایط تعریف‌شده توسط عملگر رابطه‌ای مطابقت دارد. در مثال اول، درخواست تمام اسناد ویرایش شده را با مقدار doc_id برابر با 12345 برمی گرداند. در مثال دوم، گزارش هر سند ویرایش شده ای را که مقدار doc_id برابر با 98765 نیست، برمی گرداند. عملگر <> در رشته درخواست درخواست کدگذاری شده است ( %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=).

توجه: API چندین مقدار از یک پارامتر را نمی پذیرد. اگر یک پارامتر بیش از یک بار در درخواست API ارائه شود، API فقط آخرین مقدار آن پارامتر را می‌پذیرد. علاوه بر این، اگر یک پارامتر نامعتبر در درخواست API ارائه شود، API آن پارامتر را نادیده می گیرد و پاسخ مربوط به پارامترهای معتبر باقی مانده را برمی گرداند. اگر هیچ پارامتری درخواست نشود، تمام پارامترها برگردانده می شوند.

max Results

integer

تعیین می کند که چه تعداد رکورد فعالیت در هر صفحه پاسخ نشان داده می شود. به عنوان مثال، اگر درخواست maxResults=1 تنظیم کند و گزارش دارای دو فعالیت باشد، گزارش دارای دو صفحه است. ویژگی nextPageToken پاسخ دارای نشانه صفحه دوم است. رشته پرس و جو maxResults در درخواست اختیاری است. مقدار پیش فرض 1000 است.

org Unit I D

string

شناسه واحد سازمانی برای گزارش. سوابق فعالیت فقط برای کاربرانی که به واحد سازمانی مشخص شده تعلق دارند نشان داده می شود.

page Token

string

نشانه برای تعیین صفحه بعدی. یک گزارش با چندین صفحه دارای ویژگی nextPageToken در پاسخ است. در درخواست بعدی خود برای دریافت صفحه بعدی گزارش، مقدار nextPageToken را در رشته پرس و جو pageToken وارد کنید.

start Time

string

شروع بازه زمانی نشان داده شده در گزارش را تنظیم می کند. تاریخ در قالب RFC 3339 است، برای مثال 2010-10-28T10:26:35.000Z. این گزارش همه فعالیت‌ها را از startTime تا endTime برمی‌گرداند. startTime باید قبل از endTime (در صورت مشخص شدن) و زمان فعلی هنگام درخواست باشد، در غیر این صورت API خطایی را برمی‌گرداند.

group Id Filter

string

شناسه‌های گروه جدا شده با کاما (مبهم) که فعالیت‌های کاربر بر روی آنها فیلتر می‌شوند، یعنی پاسخ فقط شامل فعالیت‌هایی برای آن دسته از کاربرانی می‌شود که بخشی از حداقل یکی از شناسه‌های گروه ذکر شده در اینجا هستند. قالب: "id:abc123,id:xyz456"

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

قالب JSON برای مجموعه ای از فعالیت ها.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (Activity)
    }
  ],
  "nextPageToken": string
}
فیلدها
kind

string

نوع منبع API. برای گزارش فعالیت، مقدار reports#activities است.

etag

string

ETag منبع

items[]

object ( Activity )

ثبت هر فعالیت در پاسخ.

next Page Token

string

نشانه برای بازیابی صفحه بعدی گزارش. مقدار nextPageToken در رشته پرس و جو pageToken درخواست استفاده می شود.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

نام برنامه

Enums
access_transparency

گزارش فعالیت Google Workspace Access Transparency، اطلاعات مربوط به انواع مختلف رویدادهای فعالیت Access Transparency را گزارش می‌کند.

admin

گزارش‌های فعالیت برنامه کنسول مدیریت، اطلاعات حساب مربوط به انواع مختلف رویدادهای فعالیت سرپرست را برمی‌گرداند.

calendar

گزارش‌های فعالیت برنامه Google Calendar اطلاعات مربوط به رویدادهای مختلف فعالیت تقویم را برمی‌گرداند.

chat فعالیت Chat اطلاعات مربوط به رویدادهای مختلف فعالیت گپ را گزارش می دهد.
drive

گزارش‌های فعالیت برنامه Google Drive اطلاعات مربوط به رویدادهای مختلف فعالیت Google Drive را برمی‌گرداند. گزارش فعالیت Drive فقط برای مشتریان Google Workspace Business و Enterprise در دسترس است.

gcp گزارش‌های فعالیت برنامه Google Cloud Platform اطلاعات مربوط به رویدادهای مختلف فعالیت GCP را برمی‌گرداند.
gplus گزارش‌های فعالیت برنامه Google+‎ اطلاعات مربوط به رویدادهای مختلف فعالیت Google+ ‎ را برمی‌گرداند.
groups

گزارش‌های فعالیت برنامه Google Groups اطلاعات مربوط به رویدادهای مختلف فعالیت گروه‌ها را برمی‌گرداند.

groups_enterprise

گزارش فعالیت Enterprise Groups اطلاعات مربوط به رویدادهای مختلف فعالیت گروه Enterprise را گزارش می دهد.

jamboard فعالیت Jamboard اطلاعات مربوط به رویدادهای مختلف فعالیت Jamboard را گزارش می‌کند.
login

گزارش‌های فعالیت برنامه ورود به سیستم، اطلاعات حساب مربوط به انواع مختلف رویدادهای فعالیت ورود به سیستم را برمی‌گرداند.

meet گزارش فعالیت Meet Audit اطلاعات مربوط به انواع مختلف رویدادهای فعالیت Meet Audit را برمی گرداند.
mobile گزارش فعالیت حسابرسی دستگاه اطلاعات مربوط به انواع مختلف رویدادهای فعالیت حسابرسی دستگاه را برمی گرداند.
rules

گزارش فعالیت قوانین اطلاعات مربوط به انواع مختلف رویدادهای فعالیت قوانین را برمی گرداند.

saml

گزارش فعالیت SAML اطلاعات مربوط به انواع مختلف رویدادهای فعالیت SAML را برمی گرداند.

token

گزارش‌های فعالیت برنامه Token اطلاعات حساب مربوط به انواع مختلف رویدادهای فعالیت Token را برمی‌گرداند.

user_accounts

گزارش‌های فعالیت برنامه حساب‌های کاربری اطلاعات حساب مربوط به انواع مختلف رویدادهای فعالیت حساب‌های کاربری را برمی‌گرداند.

context_aware_access

گزارش فعالیت دسترسی آگاه از زمینه، اطلاعات مربوط به رویدادهای ممنوعه دسترسی کاربران را به دلیل قوانین دسترسی متن‌آگاه برمی‌گرداند.

chrome

گزارش فعالیت Chrome اطلاعات مربوط به مرورگر Chrome و رویدادهای سیستم عامل Chrome را برمی‌گرداند.

data_studio گزارش فعالیت Data Studio اطلاعات مربوط به انواع مختلف رویدادهای فعالیت Data Studio را برمی گرداند.
keep گزارش‌های فعالیت برنامه Keep اطلاعات مربوط به رویدادهای مختلف فعالیت Google Keep را برمی‌گرداند. گزارش فعالیت Keep فقط برای مشتریان Google Workspace Business و 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

نوع منبع API. برای گزارش فعالیت، مقدار audit#activity است.

etag

string

ETag ورودی.

owner Domain

string

این دامنه ای است که تحت تأثیر رویداد گزارش قرار می گیرد. به عنوان مثال دامنه کنسول Admin یا مالک سند برنامه Drive.

ip Address

string

آدرس IP کاربری که اقدام را انجام می دهد. این آدرس پروتکل اینترنت (IP) کاربر هنگام ورود به Google Workspace است، که ممکن است مکان فیزیکی کاربر را نشان دهد یا نباشد. به عنوان مثال، آدرس IP می تواند آدرس سرور پروکسی کاربر یا یک آدرس شبکه خصوصی مجازی (VPN) باشد. API از IPv4 و IPv6 پشتیبانی می کند.

events[]

object

رویدادهای فعالیت در گزارش

events[]. type

string

نوع رویداد. سرویس یا ویژگی Google Workspace که مدیر آن را تغییر می‌دهد، در ویژگی type که یک رویداد را با استفاده از ویژگی eventName شناسایی می‌کند، شناسایی می‌شود. برای فهرست کامل دسته‌های type API، فهرست نام رویدادها را برای برنامه‌های مختلف در بالا در applicationName ببینید.

events[]. name

string

نام رویداد. این نام خاص فعالیت گزارش شده توسط API است. و هر eventName به یک سرویس یا ویژگی خاص Google Workspace مربوط می شود که API آن را در انواع رویدادها سازماندهی می کند.
برای پارامترهای درخواست eventName به طور کلی:

  • اگر eventName داده نشود، گزارش تمام نمونه‌های ممکن eventName را برمی‌گرداند.
  • وقتی یک eventName درخواست می‌کنید، پاسخ API همه فعالیت‌هایی را که حاوی آن eventName هستند برمی‌گرداند.

برای اطلاعات بیشتر درباره ویژگی های eventName ، لیست نام رویدادها را برای برنامه های مختلف در بالا در applicationName ببینید.

events[]. parameters[]

object

جفت مقدار پارامتر برای برنامه های مختلف. برای اطلاعات بیشتر در مورد پارامترهای eventName ، لیست نام رویدادها را برای برنامه های مختلف در بالا در applicationName ببینید.

events[]. parameters[]. message Value

object

جفت مقدار پارامتر تو در تو مرتبط با این پارامتر. نوع مقدار پیچیده برای یک پارامتر به عنوان لیستی از مقادیر پارامتر برگردانده می شود. به عنوان مثال، پارامتر آدرس ممکن است مقداری به عنوان [{parameter: [{name: city, value: abc}]}] داشته باشد.

events[]. parameters[]. message Value. parameter[]

object ( NestedParameter )

مقادیر پارامتر

events[]. parameters[]. name

string

نام پارامتر.

events[]. parameters[]. value

string

مقدار رشته پارامتر

events[]. parameters[]. multi Value[]

string

مقادیر رشته ای پارامتر

events[]. parameters[]. int Value

string ( int64 format)

مقدار صحیح پارامتر

events[]. parameters[]. multi Int Value[]

string ( int64 format)

مقادیر صحیح پارامتر

events[]. parameters[]. bool Value

boolean

مقدار بولی پارامتر.

events[]. parameters[]. multi Message Value[]

object

فعالیت ها.لیست اشیاء messageValue .

events[]. parameters[]. multi Message Value[]. parameter[]

object ( NestedParameter )

مقادیر پارامتر

id

object

شناسه منحصر به فرد برای هر رکورد فعالیت.

id. time

string

زمان وقوع فعالیت. این در زمان یونیکس در ثانیه است.

id. unique Qualifier

string ( int64 format)

واجد شرایط منحصر به فرد اگر چندین رویداد زمان یکسان داشته باشند.

id. application Name

string

نام برنامه ای که رویداد به آن تعلق دارد. برای مقادیر ممکن، لیست برنامه های کاربردی بالا را در applicationName ببینید.

id. customer Id

string

شناسه منحصر به فرد برای حساب Google Workspace.

actor

object

کاربر در حال انجام عمل

actor. profile Id

string

شناسه منحصر به فرد نمایه Google Workspace بازیگر. اگر بازیگر کاربر Google Workspace نباشد، ممکن است این مقدار وجود نداشته باشد، یا ممکن است شماره 105250506097979753968 باشد که به عنوان شناسه مکان‌نما عمل می‌کند.

actor. email

string

آدرس ایمیل اصلی بازیگر. در صورتی که هیچ آدرس ایمیل مرتبط با بازیگر وجود نداشته باشد، ممکن است غایب باشد.

actor. caller Type

string

نوع بازیگر.

actor. key

string

فقط زمانی ارائه می شود که callerType KEY باشد. می‌تواند کلید consumer_key درخواست‌کننده برای درخواست‌های OAuth 2LO API یا شناسه‌ای برای حساب‌های ربات باشد.