Method: activities.list

Получает список действий для учётной записи и приложения определённого клиента, например, консоли администратора или приложения Google Диска. Подробнее см. в руководствах по отчётам администратора и отчётам об активности Google Диска . Подробнее о параметрах отчёта об активности см. в справочниках по параметрам активности .

HTTP-запрос

GET https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}

URL использует синтаксис перекодировки gRPC .

Параметры пути

Параметры
userKey or all

string

Представляет идентификатор профиля или адрес электронной почты пользователя, по которому следует фильтровать данные. Может быть all для всей информации или userKey для уникального идентификатора профиля пользователя Google Workspace или его основного адреса электронной почты. Не должен быть удалённым пользователем. Для удалённого пользователя вызовите users.list в Directory API с showDeleted=true , а затем используйте возвращённый ID в качестве userKey .

applicationName

enum ( ApplicationName )

Имя приложения, для которого необходимо получить события.

Параметры запроса

Параметры
actorIpAddress

string

IP-адрес хоста, на котором произошло событие. Это дополнительный способ фильтрации сводки отчёта по IP-адресу пользователя, активность которого отслеживается. Этот IP-адрес может отражать или не отражать физическое местоположение пользователя. Например, IP-адрес может быть адресом прокси-сервера пользователя или адресом виртуальной частной сети (VPN). Этот параметр поддерживает версии адресов IPv4 и IPv6 .

customerId

string

Уникальный идентификатор клиента, для которого требуется получить данные.

endTime

string

Задаёт конец временного диапазона, отображаемого в отчёте. Дата указывается в формате RFC 3339 , например, 2010-10-28T10:26:35.000Z. Значение по умолчанию — приблизительное время запроса API. В отчёте API используются три основных временных понятия:

  • Дата запроса API на отчет : когда API создал и извлек отчет.
  • Время начала отчёта : начало временного интервала, отображаемого в отчёте. startTime должен быть раньше endTime (если указано) и текущего времени на момент выполнения запроса, иначе API вернёт ошибку.
  • Время окончания отчёта : конец временного периода, указанного в отчёте. Например, период событий, представленных в отчёте, может начинаться в апреле и заканчиваться в мае. Сам отчёт можно запросить в августе.
Если endTime не указано, отчет возвращает все действия с startTime до текущего времени или за последние 180 дней, если startTime относится более чем к прошлому.

Для запросов Gmail необходимо указать startTime и endTime , а разница не должна превышать 30 дней.

eventName

string

Имя события, запрашиваемого API. Каждое eventName связано с определённой службой или функцией Google Workspace, которые API организует по типам событий. Примером служат события Google Календаря в отчётах приложения консоли администратора. Структура type Calendar Settings содержит все действия Calendar eventName , сообщаемые API. Когда администратор изменяет настройки Calendar, API сообщает об этом действии в параметрах type Calendar Settings и eventName . Подробнее о строках запроса и параметрах eventName см. в списке имён событий для различных приложений выше в applicationName .

filters

string

Строка запроса filters представляет собой список параметров событий, разделенных запятыми, которые обрабатываются реляционными операторами. Параметры событий имеют вид {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...

Эти параметры события связаны с определенным eventName . Если параметр запроса не принадлежит eventName , возвращается пустой отчёт. Для получения дополнительной информации о доступных полях eventName для каждого приложения и связанных с ними параметрах перейдите в таблицу ApplicationName , а затем перейдите на страницу «События активности» в приложении для нужного приложения.

В следующих примерах действий Диска возвращаемый список состоит из всех событий edit , где значение параметра doc_id соответствует условиям, заданным оператором сравнения. В первом примере запрос возвращает все отредактированные документы со значением doc_id , равным 12345 Во втором примере отчёт возвращает все отредактированные документы, где значение doc_id не равно 98765 Оператор <> закодирован в URL-адресе в строке запроса ( %3C%3E ):

GET...&eventName=edit&filters=doc_id==12345
GET...&eventName=edit&filters=doc_id%3C%3E98765

Запрос filters поддерживает следующие реляционные операторы:

  • == —'равно'.
  • <> — «не равно». Должен быть закодирован в URL (%3C%3E).
  • < — «меньше чем». Должен быть закодирован в URL (%3C).
  • <= — «меньше или равно». Должна быть закодирована в URL (%3C=).
  • > — «больше чем». Должен быть закодирован в URL (%3E).
  • >= — «больше или равно». Должна быть закодирована в URL (%3E=).

Примечание: API не принимает несколько значений одного и того же параметра. Если параметр указан в запросе API несколько раз, API принимает только последнее значение этого параметра. Кроме того, если в запросе API указан недопустимый параметр, API игнорирует его и возвращает ответ, соответствующий оставшимся допустимым параметрам. Если параметры не запрошены, возвращаются все параметры.

maxResults

integer

Определяет количество записей об активности, отображаемых на каждой странице ответа. Например, если в запросе установлено maxResults=1 , а в отчёте два действия, отчёт будет состоять из двух страниц. Свойство nextPageToken ответа содержит токен второй страницы. Строка запроса maxResults необязательна в запросе. Значение по умолчанию — 1000.

orgUnitID

string

Идентификатор организационного подразделения , по которому нужно создать отчёт. Записи об активности будут отображаться только для пользователей, принадлежащих указанному организационному подразделению.

pageToken

string

Токен для указания следующей страницы. В ответе отчёта с несколькими страницами есть свойство nextPageToken . В следующем запросе на получение следующей страницы отчёта введите значение nextPageToken в строку запроса pageToken .

startTime

string

Задаёт начало диапазона времени, отображаемого в отчёте. Дата указывается в формате RFC 3339 , например, 2010-10-28T10:26:35.000Z. Отчёт возвращает все действия с startTime до endTime . Время startTime должно быть раньше времени endTime (если указано) и текущего времени на момент выполнения запроса, иначе API вернёт ошибку.

Для запросов Gmail необходимо указать startTime и endTime , а разница не должна превышать 30 дней.

groupIdFilter

string

Разделённые запятыми идентификаторы групп (обфусцированные), по которым фильтруются действия пользователей. Т.е. ответ будет содержать действия только тех пользователей, которые входят хотя бы в одну из упомянутых здесь групп. Формат: "id:abc123,id:xyz456".

Текст запроса

Тело запроса должно быть пустым.

Тело ответа

Шаблон JSON для коллекции мероприятий.

В случае успеха тело ответа содержит данные со следующей структурой:

JSON-представление 
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (Activity)
    }
  ],
  "nextPageToken": string
}
Поля
kind

string

Тип ресурса API. Для отчёта об активности значение — reports#activities .

etag

string

ETag ресурса.

items[]

object ( Activity )

Каждая запись о деятельности в ответе.

nextPageToken

string

Токен для получения следующей страницы отчёта. Значение nextPageToken используется в строке запроса pageToken .

Области авторизации

Требуется следующая область 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 .

groups_enterprise

Отчеты об активности Enterprise Groups возвращают информацию о различных событиях активности Enterprise Group .

jamboard Отчеты об активности Jamboard возвращают информацию о различных событиях активности Jamboard .
login

Отчеты об активности приложения «Вход» возвращают информацию об учетной записи о различных типах событий активности входа .

meet Отчет о действиях аудита Meet возвращает информацию о различных типах событий аудита 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 Отчеты об активности Vault возвращают информацию о различных типах событий активности 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 (NestedParameter)
              }
            ]
          },
          "name": string,
          "value": string,
          "multiValue": [
            string
          ],
          "intValue": string,
          "multiIntValue": [
            string
          ],
          "boolValue": boolean,
          "multiMessageValue": [
            {
              "parameter": [
                {
                  object (NestedParameter)
                }
              ]
            }
          ]
        }
      ],
      "resourceIds": [
        string
      ]
    }
  ],
  "id": {
    "time": string,
    "uniqueQualifier": string,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "profileId": string,
    "email": string,
    "callerType": string,
    "key": string,
    "applicationInfo": {
      "oauthClientId": string,
      "applicationName": string,
      "impersonation": boolean
    }
  },
  "networkInfo": {
    object (NetworkInfo)
  },
  "resourceDetails": [
    {
      object (ResourceDetails)
    }
  ]
}
Поля
kind

string

Тип ресурса API. Для отчёта об активности значение — audit#activity .

etag

string

ETag записи.

ownerDomain

string

Это домен, на который распространяется событие отчёта. Например, домен консоли администратора или владельца документа приложения «Диск».

ipAddress

string

IP-адрес пользователя, выполняющего действие. Это IP-адрес пользователя при входе в Google Workspace, который может отражать или не отражать физическое местоположение пользователя. Например, IP-адрес может быть адресом прокси-сервера пользователя или адресом виртуальной частной сети (VPN). API поддерживает IPv4 и IPv6 .

events[]

object

События активности в отчете.

events[].type

string

Тип события. Служба или функция Google Workspace, которую изменяет администратор, определяется свойством type , которое идентифицирует событие с помощью свойства eventName . Полный список категорий type API см. в списке имён событий для различных приложений выше в applicationName .

events[].name

string

Имя события. Это конкретное имя действия, сообщаемое API. Каждое eventName связано с определённым сервисом или функцией Google Workspace, которые API организует по типам событий.
Для параметров запроса eventName в целом:

  • Если eventName не указан, отчет возвращает все возможные экземпляры eventName .
  • При запросе eventName ответ API возвращает все действия, содержащие это eventName .

Дополнительную информацию о свойствах eventName см. в списке имен событий для различных приложений выше в applicationName .

events[].parameters[]

object

Пары параметров и значений для различных приложений. Подробнее о параметрах eventName см. в списке имён событий для различных приложений выше в applicationName .

events[].parameters[].messageValue

object

Вложенные пары значений параметров, связанные с этим параметром. Сложный тип значения параметра возвращается в виде списка значений параметров. Например, параметр адреса может иметь значение [{parameter: [{name: city, value: abc}]}]

events[].parameters[].messageValue.parameter[]

object ( NestedParameter )

Значения параметров

events[].parameters[].name

string

Имя параметра.

events[].parameters[].value

string

Строковое значение параметра.

events[].parameters[].multiValue[]

string

Строковые значения параметра.

events[].parameters[].intValue

string ( int64 format)

Целочисленное значение параметра.

events[].parameters[].multiIntValue[]

string ( int64 format)

Целочисленные значения параметра.

events[].parameters[].boolValue

boolean

Булевое значение параметра.

events[].parameters[].multiMessageValue[]

object

Activities.List of messageValue Objects.

events[].parameters[].multiMessageValue[].parameter[]

object ( NestedParameter )

Значения параметров

events[].resourceIds[]

string

Идентификаторы ресурсов, связанных с событием.

id

object

Уникальный идентификатор для каждой записи активности.

id.time

string

Время возникновения активности. Указывается в секундах в эпоху UNIX.

id.uniqueQualifier

string ( int64 format)

Уникальный квалификатор, если несколько событий имеют одинаковое время.

id.applicationName

string

Имя приложения, к которому принадлежит событие. Возможные значения см. в списке приложений выше в applicationName .

id.customerId

string

Уникальный идентификатор учетной записи Google Workspace.

actor

object

Пользователь выполняет действие.

actor.profileId

string

Уникальный идентификатор профиля Google Workspace исполнителя. Это значение может отсутствовать, если исполнитель не является пользователем Google Workspace, или может быть числом 105250506097979753968, которое используется в качестве идентификатора-заполнителя.

actor.email

string

Основной адрес электронной почты исполнителя. Может отсутствовать, если у исполнителя нет связанного с ним адреса электронной почты.

actor.callerType

string

Тип актера.

actor.key

string

Присутствует только при значении callerType = KEY . Может быть consumer_key запрашивающей стороны для запросов API OAuth 2LO или идентификатором для учётных записей роботов.

actor.applicationInfo

object

Подробная информация о приложении, которое являлось исполнителем действия.

actor.applicationInfo.oauthClientId

string

Идентификатор клиента OAuth стороннего приложения, используемого для выполнения действия.

actor.applicationInfo.applicationName

string

Название приложения, используемого для выполнения действия.

actor.applicationInfo.impersonation

boolean

Выдавало ли приложение себя за пользователя.

networkInfo

object ( NetworkInfo )

Сетевая информация о пользователе, выполняющем действие.

resourceDetails[]

object ( ResourceDetails )

Подробная информация о ресурсе, на котором было выполнено действие.

NetworkInfo

Сетевая информация о пользователе, выполняющем действие.

JSON-представление 
{
  "ipAsn": [
    integer
  ],
  "regionCode": string,
  "subdivisionCode": string
}
Поля
ipAsn[]

integer

IP-адрес пользователя, выполняющего действие.

regionCode

string

Региональный код пользователя, выполняющего действие, по стандарту ISO 3166-1 alpha-2.

subdivisionCode

string

Код региона ISO 3166-2 (штаты и провинции) для стран пользователя, выполняющего действие.

РесурсПодробности

Подробная информация о ресурсе, на котором было выполнено действие.

JSON-представление 
{
  "id": string,
  "title": string,
  "type": string,
  "appliedLabels": [
    {
      object (AppliedLabel)
    }
  ],
  "relation": string
}
Поля
id

string

Идентификатор ресурса.

title

string

Название ресурса. Например, в случае документа на диске это будет название документа. В случае электронного письма это будет тема.

type

string

Тип ресурса - документ, электронная почта, чат-сообщение

appliedLabels[]

object ( AppliedLabel )

Activities.Список меток, примененных к ресурсу

relation

string

Определяет связь ресурса с событиями

AppliedLabel

Подробная информация о маркировке, нанесенной на ресурс.

JSON-представление 
{
  "id": string,
  "title": string,
  "fieldValues": [
    {
      object (FieldValue)
    }
  ],
  "reason": {
    object (Reason)
  }
}
Поля
id

string

Идентификатор метки — только идентификатор метки, а не полное имя ресурса OnePlatform.

title

string

Название этикетки

fieldValues[]

object ( FieldValue )

Activities.list — список полей, входящих в метку и заданных пользователем. Если метка содержит поле, которое не было задано пользователем, оно не будет представлено в этом списке.

reason

object ( Reason )

Причина, по которой к ресурсу была применена метка.

ЗначениеПоля

Подробная информация о значении поля, заданном пользователем для конкретной метки.

JSON-представление 
{
  "id": string,
  "displayName": string,
  "type": string,
  "reason": {
    object (Reason)
  },

  // Union field value can be only one of the following:
  "unsetValue": boolean,
  "longTextValue": string,
  "textValue": string,
  "textListValue": {
    object (TextListValue)
  },
  "selectionValue": {
    object (SelectionValue)
  },
  "selectionListValue": {
    object (SelectionListValue)
  },
  "integerValue": string,
  "userValue": {
    object (UserValue)
  },
  "userListValue": {
    object (UserListValue)
  },
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
Поля
id

string

Идентификатор поля

displayName

string

Отображаемое имя поля

type

string

Тип поля

reason

object ( Reason )

Причина, по которой поле было применено к этикетке.

value поля объединения. Сохраняет значения, хранящиеся в поле. value может быть только одним из следующих:
unsetValue

boolean

Если поле не задано, это будет true.

longTextValue

string

Установка длинного текстового значения.

textValue

string

Установка текстового значения.

textListValue

object ( TextListValue )

Установка значения текстового списка.

selectionValue

object ( SelectionValue )

Установка значения выбора путем выбора одного значения из раскрывающегося списка.

selectionListValue

object ( SelectionListValue )

Установка значения списка выбора путем выбора нескольких значений из раскрывающегося списка.

integerValue

string ( int64 format)

Установка целочисленного значения.

userValue

object ( UserValue )

Установка значения пользователя путем выбора одного пользователя.

userListValue

object ( UserListValue )

Установка значения списка пользователей путем выбора нескольких пользователей.

dateValue

object ( Date )

Установка значения даты.

TextListValue

Установка значения текстового списка.

JSON-представление 
{
  "values": [
    string
  ]
}
Поля
values[]

string

Activities.Список текстовых значений.

SelectionValue

Установка значения выбора путем выбора одного значения из раскрывающегося списка.

JSON-представление 
{
  "id": string,
  "displayName": string,
  "badged": boolean
}
Поля
id

string

Идентификатор выбора.

displayName

string

Отображаемое имя выбора.

badged

boolean

Помечен ли выбранный вариант значком.

SelectionListValue

Установка значения списка выбора путем выбора нескольких значений из раскрывающегося списка.

JSON-представление 
{
  "values": [
    {
      object (SelectionValue)
    }
  ]
}
Поля
values[]

object ( SelectionValue )

виды деятельности.список выборов.

UserValue

Установка значения пользователя путем выбора одного пользователя.

JSON-представление 
{
  "email": string
}
Поля
email

string

Электронная почта пользователя.

UserListValue

Установка значения списка пользователей путем выбора нескольких пользователей.

JSON-представление 
{
  "values": [
    {
      object (UserValue)
    }
  ]
}
Поля
values[]

object ( UserValue )

деятельность.список пользователей.

Дата

Представляет собой полную или частичную календарную дату, например, день рождения. Время суток и часовой пояс либо указаны в другом месте, либо не имеют значения. Дата указана относительно григорианского календаря. Может представлять собой одно из следующих событий:

  • Полная дата с ненулевыми значениями года, месяца и дня.
  • Месяц и день с нулевым годом (например, годовщина).
  • Год сам по себе, с нулевым месяцем и нулевым днем.
  • Год и месяц с нулевым днем (например, дата истечения срока действия кредитной карты).

Похожие типы:

JSON-представление 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Поля
year

integer

Год даты. Должен быть от 1 до 9999 или 0, чтобы указать дату без года.

month

integer

Месяц года. Должен быть от 1 до 12 или 0, чтобы указать год без месяца и дня.

day

integer

День месяца. Должен быть от 1 до 31 и действителен для года и месяца, или 0, чтобы указать только год или год и месяц, если день не имеет значения.

Причина

Причина применения метки/поля.

JSON-представление 
{
  "reasonType": string
}
Поля
reasonType

string

Тип причины.