API отчётов — это RESTful API, который можно использовать для доступа к информации об активности пользователей в Google Workspace. API отчётов входит в состав Admin SDK API.
API отчетов предоставляет два типа отчетов:
- Отчеты об активности , в которых описываются события для определенного приложения или службы, например Google Диска или консоли администратора.
- Отчеты об использовании , в которых перечислены события рабочего пространства, вызванные пользователями.
- Отчеты об использовании клиентами содержат список событий для всех пользователей в вашем домене.
- Отчеты об использовании пользователем содержат список событий, организованных по пользователю.
Ниже приведен список общих терминов, используемых в API отчетов:
- Отчеты о деятельности
Отчёты об активности содержат информацию о действиях в определённом приложении или сервисе Google Workspace. В отчётах об активности указаны дата, время, пользователь и тип действия. Справочник по API содержит полный список отчётов об активности и содержащуюся в них информацию. Вот несколько примеров отчётов об активности, отсортированных по приложению или сервису:
- Отчёты об активности администратора отображают действия, выполненные администраторами с помощью консоли администратора. Например, вы можете получить список всех случаев, когда администраторы изменяли имя пользователя с помощью консоли администратора.
- Отчёты об активности на Google Диске содержат информацию о том, как пользователи вашего домена редактируют и просматривают документы на Диске. Например, вы можете получить список действий конкретного пользователя на Диске.
- Отчёты об активности входов содержат информацию о том, когда пользователи вашей учётной записи входят в неё и выходят из неё. Например, вы можете получить отчёт обо всех входах в ваш домен за определённый период времени.
- Отчёты об активности мобильных устройств отображают действия, совершаемые с помощью мобильных устройств, управляемых Google Mobile Management . Например, вы можете получать уведомления, когда пользователи регистрируют новое устройство.
- Отчёты об активности токенов OAuth содержат список событий, когда ваши пользователи выдавали или отзывали токены авторизации, используемые сторонними веб-сайтами и приложениями. Вы можете использовать API отчётов, чтобы получить список всех случаев доступа третьих лиц к данным Google Workspace пользователя.
- Отчеты об использовании
Отчёты об использовании предоставляют информацию о событиях Google Workspace в вашем домене. Вы можете использовать API для запроса конкретной информации о пользователях.
- Отчёты об использовании клиентами содержат подробную информацию об использовании приложений и услуг в вашей учётной записи. Эта информация об использовании упорядочена по типу приложения и содержит информацию, относящуюся к каждому приложению.
- Отчёты об использовании приложения содержат информацию об активности пользователей вашей учётной записи. Эти отчёты можно настраивать и фильтровать по определённой информации об использовании. Эта информация упорядочена по типу приложения и содержит информацию, относящуюся к каждому приложению.
- Отчеты об использовании сущностей содержат список действий, связанных с сущностями, используемыми пользователями вашей учетной записи в приложении Currents.
- Уведомления
- API отчётов предоставляет уведомления, позволяющие отслеживать события, такие как изменения ресурсов. Когда вы отслеживаете ресурс и он изменяется, API отчётов отправляет вам уведомление. Подробнее о настройке и получении уведомлений через API отчётов см. в руководстве по получению push-уведомлений .
Следующие шаги
Чтобы узнать больше об API отчётов и увидеть, как он работает, воспользуйтесь кратким руководством, которое отсортировано по языкам программирования на левой панели навигации. Вы также можете продолжить изучение этого раздела, чтобы ознакомиться с общей информацией о настройке учётной записи.
В разделе авторизации показано, как использовать токены доступа OAuth 2.0 для получения данных пользователей из приложений и служб Google Workspace.
Подробную информацию о конкретном типе ресурса или методе см. в справочнике API .
Дополнительную информацию можно найти в системе отслеживания ошибок API Admin SDK , в блоге разработчиков Google Workspace и в справочном центре Google Workspace Admin .