Эта страница переведена с помощью 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 Transcoding .

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

Параметры

Параметры
`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` находится более чем на 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 (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

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

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