Method: activities.list

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

HTTP-запрос

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

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

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

Параметры
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 находится более чем на 180 дней в прошлом.

eventName

string

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

filters

string

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

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

В следующих примерах действий Диска возвращаемый список состоит из всех событий 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 вернет ошибку.

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 Calendar возвращают информацию о различных событиях активности Календаря .

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

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

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

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

groups_enterprise

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

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.

Активность

Шаблон 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
    }
  },
  "resourceDetails": [
    {
      object (ResourceDetails)
    }
  ]
}
Поля
kind

string

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

etag

string

ETag записи.

ownerDomain

string

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

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 объектов messageValue .

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

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

resourceDetails[]

object ( ResourceDetails )

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

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

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

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

string

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

title

string

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

type

string

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

appliedLabels[]

object ( AppliedLabel )

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

relation

string

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

ПрикладнаяЭтикетка

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

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 )

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

ТекстСписокЗначение

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

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

string

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

ВыборЗначение

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

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

string

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

displayName

string

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

badged

boolean

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

ВыборСпискаЗначение

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

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

object ( SelectionValue )

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

Значение пользователя

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

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

string

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

Значение списка пользователей

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

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

Тип причины.