Reports API یک API RESTful است که می توانید از آن برای دسترسی به اطلاعات مربوط به فعالیت های Google Workspace کاربران خود استفاده کنید. API Reports بخشی از Admin SDK API است.
Reports API دو نوع گزارش ارائه می دهد:
- گزارش‌های فعالیت ، که رویدادها را برای یک برنامه یا سرویس خاص، مانند Google Drive یا کنسول مدیریت گزارش می‌دهند.
- گزارش‌های استفاده ، که رویدادهای فضای کاری ایجاد شده توسط کاربران را فهرست می‌کند.
- گزارش های استفاده از مشتری رویدادها را برای همه کاربران در دامنه شما فهرست می کند.
- گزارش‌های استفاده کاربر رویدادهای سازماندهی شده توسط کاربر را فهرست می‌کند.
در زیر لیستی از اصطلاحات رایج مورد استفاده در Reports API آمده است:
- گزارش فعالیت
گزارش‌های فعالیت، اطلاعات مربوط به فعالیت‌های یک برنامه یا سرویس Google Workspace را فهرست می‌کنند. گزارش فعالیت شامل تاریخ، زمان، کاربر و نوع فعالیت است. مرجع API شامل فهرست کاملی از گزارش‌های فعالیت و اطلاعاتی است که شامل می‌شود. در اینجا چند نمونه گزارش فعالیت ذکر شده بر اساس برنامه یا سرویس آمده است:
- گزارش‌های فعالیت مدیریت ، فعالیت‌هایی را نشان می‌دهد که توسط مدیران با استفاده از کنسول مدیریت انجام شده است. برای مثال، می‌توانید فهرستی از تمام دفعاتی که مدیران نام کاربر را با استفاده از کنسول Admin تغییر داده‌اند، دریافت کنید.
- گزارش‌های فعالیت Google Drive نحوه ویرایش و مشاهده اسناد Drive توسط کاربران دامنه شما را نشان می‌دهد. به عنوان مثال، می توانید لیستی از فعالیت یک کاربر خاص در Drive دریافت کنید.
- گزارش‌های فعالیت ورود اطلاعاتی را در مورد زمان ورود و خروج کاربران حساب شما به حساب‌هایشان ارائه می‌دهد. به عنوان مثال، می توانید گزارشی از تمام ورودهای دامنه خود در یک دوره زمانی خاص دریافت کنید.
- گزارش‌های فعالیت تلفن همراه، فعالیت‌هایی را با استفاده از دستگاه‌های تلفن همراه مدیریت شده توسط Google Mobile Management نشان می‌دهد. به عنوان مثال، هنگامی که کاربران یک دستگاه جدید را ثبت می کنند، می توانید یک اعلان دریافت کنید.
- گزارش‌های فعالیت OAuth Token رویدادهایی را فهرست می‌کند که کاربران شما توکن‌های مجوز استفاده شده توسط وب‌سایت‌ها و برنامه‌های شخص ثالث را داده یا لغو کرده‌اند. می‌توانید از Reports API برای دریافت فهرستی از تمام دسترسی‌های شخص ثالث به داده‌های Google Workspace کاربر استفاده کنید.
- گزارش های استفاده
گزارش‌های استفاده اطلاعاتی درباره رویدادهای Google Workspace در دامنه شما ارائه می‌کند. می توانید از API برای درخواست اطلاعات خاص در مورد کاربران استفاده کنید.
- گزارش‌های استفاده مشتریان، جزئیات برنامه و فعالیت‌های خدماتی را در حساب شما فهرست می‌کنند. این اطلاعات استفاده بر اساس نوع برنامه سازماندهی شده است و حاوی اطلاعات خاص آن برنامه است.
- گزارش‌های استفاده کاربران، فعالیت‌های کاربران حساب شما را نشان می‌دهد. این گزارش ها را می توان برای اطلاعات استفاده خاص سفارشی و فیلتر کرد. این اطلاعات استفاده بر اساس نوع برنامه سازماندهی شده است و حاوی اطلاعات خاص آن برنامه است.
- گزارش‌های استفاده موجودیت‌ها، فعالیت‌های مرتبط با موجودیت‌های مورد استفاده کاربران حساب شما را در برنامه Currents فهرست می‌کند.
- اطلاعیه ها
- گزارش‌های API اعلان‌هایی را ارائه می‌کند که به شما امکان می‌دهد رویدادها را تماشا کنید، مانند تغییرات در منابع. هنگامی که در حال تماشای یک منبع هستید و آن منبع تغییر می کند، API گزارش ها برای شما اعلان ارسال می کند. برای اطلاعات بیشتر در مورد راه‌اندازی و دریافت اعلان‌ها از گزارش‌های API، به راهنمای دریافت اعلان‌های فشاری مراجعه کنید.
مراحل بعدی
برای آشنایی با Reports API و مشاهده کارکرد آن، از Quickstart استفاده کنید که با زبان برنامه نویسی در نوار ناوبری سمت چپ فهرست شده است. همچنین می‌توانید از طریق این بخش اطلاعات کلی در مورد راه‌اندازی حساب خود را مطالعه کنید.
بخش مجوز به شما نشان می دهد که چگونه از نشانه های دسترسی OAuth 2.0 برای به دست آوردن اطلاعات کاربر از برنامه ها و سرویس های Google Workspace استفاده کنید.
برای یافتن جزئیات یک نوع یا روش منبع خاص، به مرجع API مراجعه کنید.
برای اطلاعات بیشتر، به ردیاب مشکل Admin SDK API ، وبلاگ Google Workspace Developers و مرکز راهنمای Google Workspace Admin مراجعه کنید.