- HTTP-запрос
- Параметры пути
- Параметры запроса
- Текст запроса
- Ответный текст
- Области полномочий
- Название приложения
- Активность
- NetworkInfo
- ResourceDetails
- AppliedLabel
- FieldValue
- TextListValue
- SelectionValue
- SelectionListValue
- UserValue
- UserListValue
- Дата
- Причина
- Попробуйте!
Получает список действий для конкретной учетной записи клиента и приложения, например, приложения «Консоль администратора» или приложения «Google Drive». Дополнительную информацию см. в руководствах по отчетам об активности администратора и Google Drive . Дополнительную информацию о параметрах отчета об активности см. в справочных руководствах по параметрам активности .
HTTP-запрос
GET https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}
В URL-адресе используется синтаксис транскодирования gRPC .
Параметры пути
| Параметры | |
|---|---|
userKey or all | Представляет собой идентификатор профиля или адрес электронной почты пользователя, для которого следует фильтровать данные. Может быть |
applicationName | Название приложения, для которого необходимо получить события. |
Параметры запроса
| Параметры | |
|---|---|
actorIpAddress | IP-адрес хоста, на котором произошло событие. Это дополнительный способ фильтрации сводки отчета с использованием IP-адреса пользователя, чья активность отслеживается. Этот IP-адрес может отражать или не отражать физическое местоположение пользователя. Например, IP-адрес может быть адресом прокси-сервера пользователя или адресом виртуальной частной сети (VPN). Этот параметр поддерживает как IPv4 , так и IPv6 . |
customerId | Уникальный идентификатор клиента, для которого необходимо получить данные. |
endTime | Устанавливает конечную точку временного диапазона, отображаемого в отчете. Дата указывается в формате RFC 3339 , например, 2010-10-28T10:26:35.000Z. Значение по умолчанию — приблизительное время запроса к API. Отчет по API имеет три основных понятия времени:
endTime не указан, отчет возвращает все действия с startTime до текущего времени или за последние 180 дней, если startTime прошло более 180 дней.Для запросов в Gmail необходимо указать startTime и endTime , при этом разница между ними не должна превышать 30 дней. |
eventName | Название события, запрашиваемого API. Каждое |
filters | Строка запроса Эти параметры события связаны с конкретным В приведенных ниже примерах действий в Google Диске возвращаемый список состоит из всех событий Запрос
Примечание: API не принимает несколько значений одного и того же параметра. Если параметр указан в запросе API более одного раза, API принимает только последнее значение этого параметра. Кроме того, если в запросе API указан недопустимый параметр, API игнорирует этот параметр и возвращает ответ, соответствующий оставшимся допустимым параметрам. Если параметры не запрашиваются, возвращаются все параметры. |
maxResults | Определяет, сколько записей об активности отображается на каждой странице ответа. Например, если в запросе установлено значение |
orgUnitID | Идентификатор организационного подразделения, по которому будет формироваться отчет. Записи о действиях будут отображаться только для пользователей, принадлежащих к указанному организационному подразделению. |
pageToken | Токен для указания следующей страницы. Отчет, содержащий несколько страниц, имеет свойство |
startTime | Задает начало временного диапазона, отображаемого в отчете. Дата указывается в формате RFC 3339 , например, 2010-10-28T10:26:35.000Z. Отчет возвращает все действия с |
groupIdFilter | Идентификаторы групп, разделённые запятыми (зашифрованные), по которым фильтруются действия пользователей, то есть ответ будет содержать действия только тех пользователей, которые входят хотя бы в одну из указанных здесь групп. Формат: "id:abc123,id:xyz456" |
resourceDetailsFilter | Необязательный параметр. Строка запроса Фильтры сведений о ресурсе имеют вид Все внутренние поля обрабатываются с помощью оператора Запрос
Для типов Например, в следующем фильтре поле Использование Обратите внимание на следующее :
|
networkInfoFilter | Необязательный параметр. Используется для фильтрации по полю Использование |
statusFilter | Необязательный параметр. Используется для фильтрации по полю Использование |
applicationInfoFilter | Необязательный параметр. Используется для фильтрации по полю Использование |
Текст запроса
Тело запроса должно быть пустым.
Ответный текст
JSON-шаблон для набора действий.
В случае успеха тело ответа содержит данные следующей структуры:
| JSON-представление |
|---|
{
"kind": string,
"etag": string,
"items": [
{
object ( |
| Поля | |
|---|---|
kind | Тип ресурса API. Для отчета о деятельности значение равно |
etag | ETag ресурса. |
items[] | Каждое действие фиксируется в ответе. |
nextPageToken | Токен для получения следующей страницы отчета. Значение |
Области полномочий
Требуется следующая область действия OAuth:
-
https://www.googleapis.com/auth/admin.reports.audit.readonly
Для получения более подробной информации см. руководство по авторизации .
Название приложения
| Перечисления | |
|---|---|
access_transparency | Отчеты об активности в рамках функции прозрачности доступа Google Workspace предоставляют информацию о различных типах событий, связанных с прозрачностью доступа . |
admin | В отчетах об активности приложения «Консоль администратора» отображается информация об учетных записях, содержащая сведения о различных типах событий, связанных с деятельностью администратора . |
calendar | В отчетах об активности приложения Google Календарь отображается информация о различных событиях, происходящих в Календаре . |
chat | Отчеты об активности в чате содержат информацию о различных событиях, связанных с активностью в чате . |
drive | Отчеты об активности в приложении Google Drive предоставляют информацию о различных событиях, связанных с использованием Google Drive . Отчет об активности Drive доступен только для клиентов Google Workspace Business и Enterprise. |
gcp | В отчетах об активности приложения Google Cloud Platform содержится информация о различных событиях, связанных с активностью в GCP . |
gmail | Отчеты об активности приложения Gmail предоставляют информацию о различных событиях, связанных с работой Gmail . |
gplus | В отчетах об активности приложения Google+ содержится информация о различных событиях, связанных с активностью в Google+ . |
groups | В отчетах об активности приложения Google Groups отображается информация о различных событиях, связанных с активностью в группах . |
groups_enterprise | Отчеты об активности корпоративных групп содержат информацию о различных событиях, связанных с активностью корпоративных групп . |
jamboard | Отчеты об активности в Jamboard содержат информацию о различных событиях, связанных с активностью в Jamboard . |
login | Отчеты об активности приложения «Вход в систему» содержат информацию об учетных записях и различных типах событий, связанных с входом в систему . |
meet | Отчет об активности в рамках аудита встреч предоставляет информацию о различных типах событий аудита встреч . |
mobile | Отчет о действиях аудита устройства содержит информацию о различных типах событий аудита устройства . |
rules | Отчет об активности правил предоставляет информацию о различных типах событий, связанных с правилами . |
saml | Отчет об активности SAML предоставляет информацию о различных типах событий активности SAML . |
token | В отчетах об активности приложения Token отображается информация об учетной записи, касающаяся различных типов событий, связанных с использованием Token . |
user_accounts | Отчеты об активности приложения «Учетные записи пользователей» возвращают информацию об учетных записях, содержащую данные о различных типах событий, связанных с учетными записями пользователей . |
context_aware_access | Отчеты об активности доступа с учетом контекста возвращают информацию о случаях отказа пользователям в доступе, вызванных правилами доступа с учетом контекста . |
chrome | Отчеты об активности Chrome возвращают информацию о событиях браузера Chrome и операционной системы Chrome OS . |
data_studio | Отчеты об активности Data Studio предоставляют информацию о различных типах событий активности Data Studio . |
keep | Отчеты об активности в приложении Keep предоставляют информацию о различных событиях, связанных с Google Keep . Отчет об активности Keep доступен только для клиентов Google Workspace Business и Enterprise. |
vault | Отчеты об активности хранилища содержат информацию о различных типах событий активности хранилища . |
gemini_in_workspace_apps | Отчеты об активности Gemini for Workspace предоставляют информацию о различных типах событий активности Gemini, выполняемых пользователями в приложении Workspace. |
classroom | Отчеты об активности в классе содержат информацию о различных типах событий, происходящих в классе . |
Активность
JSON-шаблон для ресурса активности.
| JSON-представление |
|---|
{ "kind": string, "etag": string, "ownerDomain": string, "ipAddress": string, "events": [ { "type": string, "name": string, "parameters": [ { "messageValue": { "parameter": [ { object ( |
| Поля | |
|---|---|
kind | Тип ресурса API. Для отчета об активности значение равно |
etag | ETag записи. |
ownerDomain | Это домен, на который влияет событие отчета. Например, домен административной консоли или владелец документа в приложении Google Диск. |
ipAddress | IP-адрес пользователя, выполняющего действие. Это IP-адрес пользователя при входе в Google Workspace, который может отражать или не отражать физическое местоположение пользователя. Например, IP-адрес может совпадать с адресом прокси-сервера пользователя или адресом виртуальной частной сети (VPN). API поддерживает IPv4 и IPv6 . |
events[] | События, описанные в отчете. |
events[].type | Тип события. Сервис или функция Google Workspace, которую изменяет администратор, указывается в свойстве |
events[].name | Название события. Это конкретное название действия, о котором сообщает API. Каждое
Для получения дополнительной информации о свойствах eventName см. список имен событий для различных приложений выше в applicationName . |
events[].parameters[] | Пары «параметр-значение» для различных приложений. Дополнительную информацию о параметрах |
events[].parameters[].messageValue | Вложенные пары «параметр-значение», связанные с данным параметром. Сложные типы значений для параметра возвращаются в виде списка значений параметров. Например, параметр адреса может иметь значение |
events[].parameters[].messageValue.parameter[] | Значения параметров |
events[].parameters[].name | Название параметра. |
events[].parameters[].value | Строковое значение параметра. |
events[].parameters[].multiValue[] | Строковые значения параметра. |
events[].parameters[].intValue | Целочисленное значение параметра. |
events[].parameters[].multiIntValue[] | Целочисленные значения параметра. |
events[].parameters[].boolValue | Логическое значение параметра. |
events[].parameters[].multiMessageValue[] | activities.list of |
events[].parameters[].multiMessageValue[].parameter[] | Значения параметров |
events[].resourceIds[] | Идентификаторы ресурсов, связанные с событием. |
events[].status | Статус события. Примечание: Не все события имеют статус. |
id | Для каждой записи о деятельности предусмотрен уникальный идентификатор. |
id.time | Время возникновения активности. Указано в секундах в формате UNIX epoch. |
id.uniqueQualifier | Уникальный квалификационный критерий, если несколько событий имеют одинаковое время. |
id.applicationName | Название приложения, к которому относится событие. Возможные значения см. в списке приложений выше в |
id.customerId | Уникальный идентификатор учетной записи Google Workspace. |
actor | Пользователь выполняет действие. |
actor.profileId | Уникальный идентификатор профиля Google Workspace пользователя. Это значение может отсутствовать, если пользователь не является пользователем Google Workspace, или может представлять собой число 105250506097979753968, которое служит в качестве идентификатора-заполнителя. |
actor.email | Основной адрес электронной почты актера. Может отсутствовать, если с актером не связан адрес электронной почты. |
actor.callerType | Тип актёра. |
actor.key | Присутствует только в том случае, если |
actor.applicationInfo | Подробная информация о приложении, которое выступало инициатором данной акции. |
actor.applicationInfo.oauthClientId | Идентификатор клиента OAuth стороннего приложения, использованного для выполнения действия. |
actor.applicationInfo.applicationName | Название приложения, использованного для выполнения действия. |
actor.applicationInfo.impersonation | Выполняло ли приложение действия, имитирующие действия пользователя. |
networkInfo | Сетевая информация о пользователе, выполняющем действие. |
resourceDetails[] | Подробная информация о ресурсе, над которым была проведена операция. |
NetworkInfo
Сетевая информация о пользователе, выполняющем действие.
| JSON-представление |
|---|
{ "ipAsn": [ integer ], "regionCode": string, "subdivisionCode": string } |
| Поля | |
|---|---|
ipAsn[] | IP-адрес пользователя, выполняющего действие. |
regionCode | Код региона ISO 3166-1 alpha-2 пользователя, выполняющего действие. |
subdivisionCode | Код региона ISO 3166-2 (штаты и провинции) для стран, в которых находится пользователь, выполняющий действие. |
ResourceDetails
Подробная информация о ресурсе, над которым была проведена операция.
| JSON-представление |
|---|
{
"id": string,
"title": string,
"type": string,
"appliedLabels": [
{
object ( |
| Поля | |
|---|---|
id | Идентификатор ресурса. |
title | Заголовок ресурса. Например, в случае документа на диске это будет заголовок документа. В случае электронного письма это будет тема. |
type | Тип ресурса — документ, электронное письмо, сообщение в чате. |
appliedLabels[] | activities.list of labels applied to the resource |
relation | Определяет взаимосвязь ресурса с событиями. |
AppliedLabel
Подробная информация о маркировке, нанесенной на ресурс.
| JSON-представление |
|---|
{ "id": string, "title": string, "fieldValues": [ { object ( |
| Поля | |
|---|---|
id | Идентификатор метки — только идентификатор метки, а не полное имя ресурса OnePlatform. |
title | Название этикетки |
fieldValues[] | activities.list — список полей, являющихся частью метки и заданных пользователем. Если метка содержит поле, не заданное пользователем, оно не будет присутствовать в этом списке. |
reason | Причина, по которой ресурсу была присвоена данная метка. |
FieldValue
Подробная информация о значении поля, установленном пользователем для конкретной метки.
| JSON-представление |
|---|
{ "id": string, "displayName": string, "type": string, "reason": { object ( |
| Поля | |
|---|---|
id | Идентификатор поля |
displayName | Отображаемое название поля |
type | Тип поля |
reason | Причина, по которой это поле было добавлено к метке. |
value поля объединения. Хранит значения, содержащиеся в value поля, и может принимать только одно из следующих значений: | |
unsetValue | Если поле не задано, это будет иметь значение true. |
longTextValue | Задание длинного текстового значения. |
textValue | Установка текстового значения. |
textListValue | Установка значения текстового списка. |
selectionValue | Установка значения выбора путем выбора одного значения из выпадающего списка. |
selectionListValue | Установка значения в выпадающем списке путем выбора нескольких значений из раскрывающегося списка. |
integerValue | Установка целочисленного значения. |
userValue | Установка значения для пользователя путем выбора одного пользователя. |
userListValue | Установка значения в списке пользователей путем выбора нескольких пользователей. |
dateValue | Установка значения даты. |
TextListValue
Установка значения текстового списка.
| JSON-представление |
|---|
{ "values": [ string ] } |
| Поля | |
|---|---|
values[] | activities.list of text values. |
SelectionValue
Установка значения выбора путем выбора одного значения из выпадающего списка.
| JSON-представление |
|---|
{ "id": string, "displayName": string, "badged": boolean } |
| Поля | |
|---|---|
id | Идентификатор выделенной области. |
displayName | Отобразить название выбранного элемента. |
badged | Есть ли у данного товара маркировка? |
SelectionListValue
Установка значения в выпадающем списке путем выбора нескольких значений из раскрывающегося списка.
| JSON-представление |
|---|
{
"values": [
{
object ( |
| Поля | |
|---|---|
values[] | activities.list of selections. |
UserValue
Установка значения для пользователя путем выбора одного пользователя.
| JSON-представление |
|---|
{ "email": string } |
| Поля | |
|---|---|
email | Адрес электронной почты пользователя. |
UserListValue
Установка значения в списке пользователей путем выбора нескольких пользователей.
| JSON-представление |
|---|
{
"values": [
{
object ( |
| Поля | |
|---|---|
values[] | activities.list of users. |
Дата
Представляет собой целую или частичную календарную дату, например, день рождения. Время суток и часовой пояс либо указаны отдельно, либо не имеют значения. Дата указывается относительно григорианского календаря. Это может представлять одно из следующих значений:
- Полная дата, включающая ненулевые значения года, месяца и дня.
- Месяц и день, с нулевым годом (например, годовщина).
- Год сам по себе, с нулевым месяцем и нулевым днем.
- Год и месяц, с нулевым днем (например, срок действия кредитной карты).
Связанные типы:
-
google.type.TimeOfDay -
google.type.DateTime -
google.protobuf.Timestamp
| JSON-представление |
|---|
{ "year": integer, "month": integer, "day": integer } |
| Поля | |
|---|---|
year | Год даты. Должен быть от 1 до 9999, или 0, чтобы указать дату без года. |
month | Месяц года. Должен быть от 1 до 12, или 0, чтобы указать год без месяца и дня. |
day | День месяца. Должен быть от 1 до 31 и соответствовать году и месяцу, или 0, чтобы указать только год или год и месяц, где день не имеет значения. |
Причина
Причина, по которой была применена эта метка/поле.
| JSON-представление |
|---|
{ "reasonType": string } |
| Поля | |
|---|---|
reasonType | Тип причины. |