Эта страница переведена с помощью Cloud Translation API.

Method: activities.watch

HTTP-запрос
Параметры пути
Параметры запроса
Текст запроса
Тело ответа
- JSON-представление
Области авторизации
ИмяПриложения

Начните получать уведомления об активности в аккаунте. Подробнее см. в разделе «Получение push-уведомлений» .

HTTP-запрос

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

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

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

Параметры

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

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` относится более чем к прошлому.
`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 (deprecated)`	`string` `Deprecated` . Это поле устарело и больше не поддерживается. Идентификатор организационного подразделения , по которому нужно создать отчёт. Записи об активности будут отображаться только для пользователей, принадлежащих указанному организационному подразделению. Данные до 17 декабря 2018 года не отображаются в отфильтрованных результатах.
`pageToken`	`string` Токен для указания следующей страницы. В ответе отчёта с несколькими страницами есть свойство `nextPageToken` . В следующем запросе на получение следующей страницы отчёта введите значение `nextPageToken` в строку запроса `pageToken` .
`startTime`	`string` Задаёт начало диапазона времени, отображаемого в отчёте. Дата указывается в формате RFC 3339 , например, 2010-10-28T10:26:35.000Z. Отчёт возвращает все действия с `startTime` до `endTime` . Время `startTime` должно быть раньше времени `endTime` (если указано) и текущего времени на момент выполнения запроса, иначе API вернёт ошибку.
`groupIdFilter (deprecated)`	`string` `Deprecated` . Это поле устарело и больше не поддерживается. Разделённые запятыми идентификаторы групп (обфусцированные), по которым фильтруются действия пользователей. Т.е. ответ будет содержать действия только тех пользователей, которые входят хотя бы в одну из упомянутых здесь групп. Формат: "id:abc123,id:xyz456". Важно: для фильтрации по группам необходимо явно добавить группы в список разрешённых групп фильтрации. Подробнее о добавлении групп в список разрешённых групп фильтрации см. в разделе Фильтрация результатов по группам Google.

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

Тело запроса содержит экземпляр SubscriptionChannel .

Тело ответа

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

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

JSON-представление
{ "id": string, "token": string, "expiration": string, "type": string, "address": string, "payload": boolean, "params": { string: string, ... }, "resourceId": string, "resourceUri": string, "kind": string }

JSON-представление

{
  "id": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "payload": boolean,
  "params": {
    string: string,
    ...
  },
  "resourceId": string,
  "resourceUri": string,
  "kind": string
}

Поля
`id`	`string` UUID или аналогичная уникальная строка, идентифицирующая этот канал.
`token`	`string` Произвольная строка, отправляемая на целевой адрес с каждым уведомлением, доставленным по этому каналу. Необязательно.
`expiration`	`string ( int64 format)` Дата и время истечения срока действия канала уведомлений, выраженные в виде временной метки Unix в миллисекундах. Необязательно.
`type`	`string` Тип механизма доставки, используемый для этого канала. Значение должно быть `"web_hook"` .
`address`	`string` Адрес, на который доставляются уведомления для этого канала.
`payload`	`boolean` Логическое значение, указывающее, требуется ли полезная нагрузка. Полезная нагрузка — это данные, отправляемые в теле HTTP-сообщения POST, PUT или PATCH и содержащие важную информацию о запросе. Необязательно.
`params`	`map (key: string, value: string)` Дополнительные параметры, управляющие поведением канала доставки. Необязательно. Объект, содержащий список пар `"key": value` . Пример: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }` .
`resourceId`	`string` Непрозрачный идентификатор, идентифицирующий ресурс, просматриваемый на этом канале. Стабилен в разных версиях API.
`resourceUri`	`string` Идентификатор версии отслеживаемого ресурса.
`kind`	`string` Указывает на канал уведомлений, используемый для отслеживания изменений ресурса, то есть « `api#channel` ».

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

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

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

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

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