گزارش اجمالی API
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
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 مراجعه کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-08-29 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-08-29 بهوقت ساعت هماهنگ جهانی."],[],[],null,["# Reports API Overview\n\nThe Reports API is a RESTful API you can use to access information about the\nGoogle Workspace activities of your users. The Reports API is part of the Admin SDK API.\n\nThe Reports API provides two types of reports:\n\n- **Activity** reports, which report events for a specific application or service, such as Google Drive or the Admin console.\n- **Usage** reports, which list workspace events caused by users.\n - **Customer** usage reports list events for all users in your domain.\n - **User** usage reports list events organized by user.\n\nFollowing is a list of common terms used in the Reports API:\n\n*Activity reports*\n\n: Activity reports list information for activities in a specific Google Workspace\n application or service. Activity reports include the date, time, user, and type\n of activity. The\n [API reference](/workspace/admin/reports/v1/reference)\n contains a complete list of activity reports and the information they include.\n Here are some example activity reports, listed by application or service:\n\n- [Admin activity reports](/workspace/admin/reports/v1/guides/manage-audit-admin) show activities done by administrators using the Admin console. For example, you could get a list of all the times administrators changed a user's name using the Admin console.\n- [Google Drive activity reports](/workspace/admin/reports/v1/guides/manage-audit-drive) list how your domain's users edit and view their Drive documents. For example, you can get a list of a particular user's activity on Drive.\n- [Login activity reports](/workspace/admin/reports/v1/guides/manage-audit-login) provide information on when your account's users log in and out of their accounts. You can, for example, get a report of all the logins for your domain over a particular time period.\n- [Mobile activity reports](/workspace/admin/reports/v1/guides/manage-audit-mobile) show activities using mobile devices managed by [Google Mobile Management](https://workspace.google.com/products/admin/endpoint/). For example, you can get a notification when users register a new device.\n- [OAuth Token activity reports](/workspace/admin/reports/v1/guides/manage-audit-tokens) list events when your users have given or revoked authorization tokens used by third-party websites and applications. You can use the Reports API to get a list of all third-party access to a user's Google Workspace data.\n\n*Usage reports*\n\n: Usage reports provide information about Google Workspace events in your domain.\n You can use the API to request specific information about users.\n\n- [Customers usage reports](/workspace/admin/reports/v1/guides/manage-usage-customers) list detailed application and service activities in your account. This usage information is organized by application type and contains information specific to that application.\n- [Users usage reports](/workspace/admin/reports/v1/guides/manage-usage-users) show activities by your account's users. These reports can be customized and filtered for specific usage information. This usage information is organized by application type and contains information specific to that application.\n- [Entities usage reports](/workspace/admin/reports/v1/guides/manage-usage-entities) list activities related to entities used by your account's users in the Currents application.\n\n*Notifications*\n: The Reports API provides notifications that let you watch for events, such as\n changes to resources. When you're watching a resource and that resource changes,\n the Reports API sends you a notification. For more information on setting up and\n receiving notifications from the Reports API, see the guide to\n [Receiving Push Notifications](/workspace/admin/reports/v1/guides/push).\n\nNext steps\n----------\n\n- To learn about the Reports API and see it work, use a Quickstart,\n which are listed by programming language on the left navigation bar. You can\n also continue through this section to read general information about setting up\n your account.\n\n- The\n [authorization](/workspace/admin/reports/v1/guides/authorizing)\n section shows you how to use OAuth 2.0 access tokens to obtain user data from\n Google Workspace applications and services.\n\n- To find the details of a specific resource type or method, see the\n [API reference](/workspace/admin/reports/v1/reference).\n\n- For more information, see the\n [Admin SDK API issue tracker](https://issuetracker.google.com/savedsearches/566232),\n the\n [Google Workspace Developers blog](https://cloud.google.com/blog/topics/workspace-developers),\n and the\n [Google Workspace Admin help center](https://support.google.com/a)."]]
