این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

Method: activities.watch

درخواست HTTP
پارامترهای مسیر
پارامترهای پرس و جو
درخواست بدن
بدن پاسخگو
- نمایندگی JSON
محدوده مجوز
نام برنامه

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

درخواست HTTP

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

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

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

پارامترها

پارامترها
`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. مقدار پیش فرض زمان تقریبی درخواست API است. یک گزارش API دارای سه مفهوم زمانی اساسی است: تاریخ درخواست API برای گزارش : زمانی که API گزارش را ایجاد و بازیابی کرد. زمان شروع گزارش : ابتدای بازه زمانی نشان داده شده در گزارش. `startTime` باید قبل از `endTime` (در صورت مشخص شدن) و زمان فعلی هنگام درخواست باشد، در غیر این صورت API خطایی را برمی‌گرداند. زمان پایان گزارش : پایان بازه زمانی نشان داده شده در گزارش. به عنوان مثال، بازه زمانی رویدادهای خلاصه شده در یک گزارش می تواند از آوریل شروع شود و در ماه می به پایان برسد. گزارش خود را می توان در ماه اوت درخواست کرد. اگر `endTime` مشخص نشده باشد، گزارش تمام فعالیت‌ها را از `startTime` تا زمان فعلی یا 180 روز اخیر را برمی‌گرداند اگر `startTime` در گذشته بیش از 180 روز باشد.
`eventName`	`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 آن پارامتر را نادیده می گیرد و پاسخ مربوط به پارامترهای معتبر باقی مانده را برمی گرداند. اگر هیچ پارامتری درخواست نشود، تمام پارامترها برگردانده می شوند.
`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` (در صورت مشخص شدن) و زمان فعلی هنگام درخواست باشد، در غیر این صورت API خطایی را برمی‌گرداند.
`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 }

نمایندگی 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)` تاریخ و زمان انقضای کانال اعلان، به صورت مهر زمانی یونیکس، در میلی ثانیه بیان می شود. اختیاری.
`type`	`string` نوع مکانیزم تحویل مورد استفاده برای این کانال. مقدار باید روی `"web_hook"` تنظیم شود.
`address`	`string` آدرسی که اعلان‌های این کانال در آن ارسال می‌شود.
`payload`	`boolean` یک مقدار Boolean برای نشان دادن اینکه آیا محموله مورد نظر است یا خیر. payload داده‌ای است که در متن پیام HTTP POST، PUT یا PATCH ارسال می‌شود و حاوی اطلاعات مهمی در مورد درخواست است. اختیاری.
`params`	`map (key: string, value: string)` پارامترهای اضافی کنترل کننده رفتار کانال تحویل اختیاری. یک شی حاوی لیستی از `"key": value` . مثال: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }` .
`resourceId`	`string` یک شناسه غیر شفاف که منبع در حال تماشا را در این کانال مشخص می کند. در نسخه های مختلف API پایدار است.
`resourceUri`	`string` یک شناسه مخصوص نسخه برای منبع تماشا شده.
`kind`	`string` این را به عنوان یک کانال اعلان شناسایی می کند که برای تماشای تغییرات در یک منبع، که " `api#channel` " است، استفاده می شود.

محدوده مجوز

به محدوده 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 و Google Workspace 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 در دسترس است.