Method: activities.list

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

HTTP-запрос

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

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

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

Параметры
user Key

string

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

application Name

enum ( ApplicationName )

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

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

Параметры
actor Ip Address

string

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

customer Id

string

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

end Time

string

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

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

event Name

string

Имя события, запрашиваемого API. Каждое eventName связано с определенной службой или функцией Google Workspace, которую API группирует по типам событий. Примером могут служить события Календаря Google в отчетах приложения консоли администратора. Структура type «Настройки календаря» содержит все действия Calendar eventName о которых сообщает API. Когда администратор изменяет настройку календаря, API сообщает об этом в параметрах type Settings Calendar и 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 игнорирует этот параметр и возвращает ответ, соответствующий остальным допустимым параметрам. Если никакие параметры не запрошены, возвращаются все параметры.

max Results

integer

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

org Unit I D

string

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

page Token

string

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

start Time

string

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

group Id Filter

string

Идентификаторы групп, разделенные запятыми (замаскированные), по которым фильтруются действия пользователей, т. е. ответ будет содержать действия только тех пользователей, которые являются частью хотя бы одного из упомянутых здесь идентификаторов групп. Формат: «идентификатор: abc123, идентификатор: xyz456»

Тело запроса

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

Тело ответа

Шаблон JSON для набора действий.

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

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

string

Тип ресурса API. Для отчета о деятельности значением является reports#activities .

etag

string

ETag ресурса.

items[]

object ( Activity )

Каждое действие записывается в ответе.

next Page Token

string

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

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

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/admin.reports.audit.readonly

Дополнительную информацию см. в руководстве по авторизации .

Имя приложения

Перечисления
access_transparency

Отчеты о действиях прозрачности доступа к Google Workspace возвращают информацию о различных типах событий, связанных с прозрачностью доступа .

admin

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

calendar

Отчеты об активности приложения Календарь Google возвращают информацию о различных событиях активности Календаря .

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

Отчеты об активности приложения Google Диск возвращают информацию о различных событиях активности на Google Диске . Отчет о действиях на Диске доступен только для клиентов Google Workspace Business и Enterprise.

gcp Отчеты об активности приложения Google Cloud Platform возвращают информацию о различных событиях активности GCP .
gplus Отчеты об активности приложения Google+ возвращают информацию о различных событиях активности Google+ .
groups

Отчеты об активности приложения Google Groups возвращают информацию о различных событиях активности в группах .

groups_enterprise

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

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

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

meet Отчет о деятельности Meet Audit возвращает информацию о различных типах событий активности Meet Audit .
mobile Отчет о деятельности аудита устройств возвращает информацию о различных типах событий активности аудита устройств .
rules

Отчет об активности правил возвращает информацию о различных типах событий активности правил .

saml

Отчет о деятельности SAML возвращает информацию о различных типах событий активности SAML .

token

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

user_accounts

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

context_aware_access

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

chrome

Отчеты об активности Chrome возвращают информацию о событиях браузера Chrome и Chrome OS .

data_studio Отчеты о деятельности Студии данных возвращают информацию о различных типах событий активности Студии данных .
keep Отчеты об активности приложения Keep возвращают информацию о различных событиях активности Google Keep . Отчет о действиях Keep доступен только для клиентов Google Workspace Business и Enterprise.
vault Отчеты о действиях Vault возвращают информацию о различных типах событий активности Vault.

Активность

Шаблон 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)
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "id": {
    "time": string,
    "uniqueQualifier": string,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "profileId": string,
    "email": string,
    "callerType": string,
    "key": string
  }
}
Поля
kind

string

Тип ресурса API. Для отчета о деятельности значением является audit#activity .

etag

string

ETag записи.

owner Domain

string

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

ip Address

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[]. message Value

object

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

events[]. parameters[]. message Value. parameter[]

object ( NestedParameter )

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

events[]. parameters[]. name

string

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

events[]. parameters[]. value

string

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

events[]. parameters[]. multi Value[]

string

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

events[]. parameters[]. int Value

string ( int64 format)

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

events[]. parameters[]. multi Int Value[]

string ( int64 format)

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

events[]. parameters[]. bool Value

boolean

Логическое значение параметра.

events[]. parameters[]. multi Message Value[]

object

активностей.список объектов messageValue .

events[]. parameters[]. multi Message Value[]. parameter[]

object ( NestedParameter )

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

id

object

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

id. time

string

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

id. unique Qualifier

string ( int64 format)

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

id. application Name

string

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

id. customer Id

string

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

actor

object

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

actor. profile Id

string

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

actor. email

string

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

actor. caller Type

string

Тип актера.

actor. key

string

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