- Solicitação HTTP
- Parâmetros de caminho
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- ApplicationName
Começar a receber notificações de atividades da conta. Para mais informações, consulte Como receber notificações push.
Solicitação HTTP
POST https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}/watch
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
userKey or all |
Representa o ID do perfil ou o e-mail do usuário para o qual os dados devem ser filtrados. Pode ser |
applicationName |
Nome do aplicativo em que os eventos serão recuperados. |
Parâmetros de consulta
Parâmetros | |
---|---|
actorIpAddress |
O endereço IP do host em que o evento foi realizado. Essa é uma outra forma de filtrar o resumo de um relatório usando o endereço IP do usuário com a atividade que está sendo informada. Esse endereço IP pode ou não refletir a localização física do usuário. Por exemplo, o endereço IP pode ser o endereço do servidor proxy do usuário ou um endereço de rede privada virtual (VPN). Esse parâmetro é compatível com as versões de endereço IPv4 e IPv6. |
customerId |
O ID exclusivo do cliente para o qual os dados serão recuperados. |
endTime |
Define o fim do intervalo de tempo mostrado no relatório. A data está no formato RFC 3339, por exemplo, 2010-10-28T10:26:35.000Z. O valor padrão é o tempo aproximado da solicitação de API. Um relatório da API tem três conceitos básicos de tempo:
endTime não for especificado, o relatório retornará todas as atividades do startTime até o horário atual ou os 180 dias mais recentes se a startTime for maior que 180 dias no passado.
|
eventName |
O nome do evento que está sendo consultado pela API. Cada |
filters |
A string de consulta Esses parâmetros são associados a um Nos exemplos de atividade do Drive a seguir, a lista retornada consiste em todos os eventos
Uma consulta
Observação:a API não aceita vários valores do mesmo parâmetro. Se um parâmetro é fornecido mais de uma vez na solicitação de API, a API aceita apenas o último valor desse parâmetro. Além disso, se um parâmetro inválido for fornecido na solicitação de API, a API ignorará esse parâmetro e retornará a resposta correspondente aos demais parâmetros válidos. Se nenhum parâmetro for solicitado, todos eles serão retornados. |
maxResults |
Determina quantos registros de atividade são mostrados em cada página de resposta. Por exemplo, se a solicitação definir |
orgUnitID |
ID da unidade organizacional que será usada no relatório. Os registros de atividades só serão exibidos para os usuários que pertencem à unidade organizacional especificada. |
pageToken |
O token a especificar a próxima página. Um relatório com várias páginas tem uma propriedade |
startTime |
Define o início do período mostrado no relatório. A data está no formato RFC 3339, por exemplo, 2010-10-28T10:26:35.000Z. O relatório retorna todas as atividades de |
groupIdFilter |
IDs de grupos separados por vírgulas (ofuscados) em que as atividades do usuário são filtradas, ou seja, a resposta só vai conter atividades de usuários que fazem parte de pelo menos um dos IDs de grupo mencionados aqui. Formato: "id:abc123,id:xyz456" |
Corpo da solicitação
O corpo da solicitação contém uma instância de SubscriptionChannel
.
Corpo da resposta
Um canal de notificação usado para observar alterações de recursos.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{ "id": string, "token": string, "expiration": string, "type": string, "address": string, "payload": boolean, "params": { string: string, ... }, "resourceId": string, "resourceUri": string, "kind": string } |
Campos | |
---|---|
id |
Um UUID ou uma string única semelhante que identifica esse canal. |
token |
Uma string arbitrária entregue ao endereço de destino com cada notificação entregue por esse canal. Opcional. |
expiration |
Data e hora da expiração do canal de notificação, expressa como um carimbo de data/hora Unix, em milissegundos. Opcional. |
type |
O tipo de mecanismo de entrega usado para este canal. O valor precisa ser definido como |
address |
O endereço em que as notificações são entregues para o canal. |
payload |
Um valor Booleano para indicar se a carga útil é desejada. Payload são dados enviados no corpo de uma mensagem HTTP POST, PUT ou PATCH e que contêm informações importantes sobre a solicitação. Opcional. |
params |
Parâmetros adicionais que controlam o comportamento do canal de entrega. Opcional. Um objeto com uma lista de pares |
resourceId |
Um ID opaco que identifica o recurso que está sendo monitorado nesse canal. Estável em diferentes versões da API. |
resourceUri |
Um identificador específico da versão para o recurso monitorado. |
kind |
Identifica isso como um canal de notificação usado para observar mudanças em um recurso, que é " |
Escopos de autorização
Requer o seguinte escopo OAuth:
https://www.googleapis.com/auth/admin.reports.audit.readonly
Para mais informações, consulte o Guia de autorização.
ApplicationName
Nome do aplicativo em que os eventos serão recuperados.
Enums | |
---|---|
access_transparency |
Os relatórios de atividade da Transparência no acesso do Google Workspace retornam informações sobre diferentes tipos de eventos da Transparência no acesso. |
admin |
Os relatórios de atividade do aplicativo Admin Console retornam informações da conta sobre diferentes tipos de eventos de atividade do administrador. |
calendar |
Os relatórios de atividade do aplicativo Google Agenda retornam informações sobre vários eventos de atividade da agenda. |
chat |
Os relatórios de atividade do Chat retornam informações sobre vários eventos de atividade do Chat. |
drive |
Os relatórios de atividade do aplicativo Google Drive retornam informações sobre vários eventos de atividade do Google Drive. O relatório de atividades do Drive só está disponível para os clientes do Google Workspace Business e do Google Workspace Enterprise. |
gcp |
Os relatórios de atividade do aplicativo Google Cloud Platform retornam informações sobre vários eventos de atividade do GCP. |
gplus |
Os relatórios de atividade do aplicativo Google+ retornam informações sobre vários eventos de atividade do Google+. |
groups |
Os relatórios de atividade do app Grupos do Google retornam informações sobre vários eventos de atividade dos Grupos do Google. |
groups_enterprise |
Os relatórios de atividade dos grupos empresariais retornam informações sobre vários eventos de atividade dos grupos empresariais. |
jamboard |
Os relatórios de atividade do Jamboard retornam informações sobre vários eventos de atividade do Jamboard. |
login |
Os relatórios de atividade do aplicativo de login retornam informações da conta sobre diferentes tipos de eventos de atividade de login. |
meet |
O relatório "Atividade de auditoria do Meet" retorna informações sobre diferentes tipos de eventos de atividade de auditoria do Meet. |
mobile |
Esse relatório retorna informações sobre diferentes tipos de eventos de atividade de auditoria do dispositivo. |
rules |
O Relatório de atividades de regras retorna informações sobre diferentes tipos de eventos de atividade de regras. |
saml |
O relatório de atividade de SAML retorna informações sobre diferentes tipos de eventos de atividade SAML. |
token |
Os relatórios de atividade do aplicativo de token retornam informações da conta sobre diferentes tipos de eventos de atividade de token. |
user_accounts |
Os relatórios de atividade do app de contas de usuário retornam informações da conta sobre diferentes tipos de eventos de atividade das contas de usuário. |
context_aware_access |
Os relatórios de atividade de acesso baseado no contexto retornam informações sobre eventos de acesso negado dos usuários devido às regras de acesso baseado no contexto. |
chrome |
Os relatórios de atividade do Chrome retornam informações sobre eventos do navegador Chrome e do Chrome OS. |
data_studio |
Os relatórios de atividade do Data Studio retornam informações sobre vários tipos de eventos de atividade do Data Studio. |
keep |
Os relatórios de atividade do aplicativo Keep retornam informações sobre vários eventos de atividade do Google Keep. O relatório de atividades do Keep só está disponível para os clientes do Google Workspace Business e Enterprise. |