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