Method: activities.watch

Начните получать уведомления о действиях в аккаунте. Дополнительную информацию см. в разделе Получение 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 )

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

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

Параметры
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 в отчетах приложения консоли администратора. Структура 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 игнорирует этот параметр и возвращает ответ, соответствующий остальным допустимым параметрам. Если никакие параметры не запрошены, возвращаются все параметры.

maxResults

integer

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

orgUnitID
(deprecated)

string

Deprecated . Это поле устарело и больше не поддерживается.

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

pageToken

string

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

startTime

string

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

groupIdFilter

string

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

Тело запроса

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

Тело ответа

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

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

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

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

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

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

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

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

admin

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

calendar

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

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

Отчеты об активности приложения Google Drive возвращают информацию о различных событиях активности на Google Диске . Отчет о действиях на Диске доступен только клиентам Google Workspace Business и Google Workspace 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.