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 параметров календаря содержит все действия календаря eventName , о которых сообщает API. Когда администратор изменяет настройку календаря, API сообщает об этом действии в параметрах 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"

Тело запроса

Тело запроса содержит экземпляр 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

Логическое значение, указывающее, нужны ли полезные данные. По желанию.

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

Дополнительные сведения см. в обзоре OAuth 2.0 .

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

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

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

Отчеты об активности Google Workspace Access Transparency содержат информацию о различных типах событий активности Access Transparency .

admin

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

calendar

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

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

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

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