Esta página foi traduzida pela API Cloud Translation.

Method: activities.watch

Solicitação HTTP
Parâmetros de caminho
Parâmetros de consulta
Corpo da solicitação
Corpo da resposta
- Representação JSON
Escopos de autorização
ApplicationName

Começar a receber notificações sobre atividades na 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

Parâmetros
`userKey or all`	`string` Representa o ID do perfil ou o e-mail do usuário para o qual os dados devem ser filtrados. Pode ser `all` para todas as informações ou `userKey` para o ID exclusivo do perfil do Google Workspace de um usuário ou o endereço de e-mail principal dele. Não pode ser um usuário excluído. Para um usuário excluído, chame `users.list` na API Directory com `showDeleted=true` e use o `ID` retornado como `userKey`.
`applicationName`	`enum (ApplicationName)` Nome do aplicativo para o qual os eventos serão recuperados.

userKey or all

string

Representa o ID do perfil ou o e-mail do usuário para o qual os dados devem ser filtrados. Pode ser all para todas as informações ou userKey para o ID exclusivo do perfil do Google Workspace de um usuário ou o endereço de e-mail principal dele. Não pode ser um usuário excluído. Para um usuário excluído, chame users.list na API Directory com showDeleted=true e use o ID retornado como userKey.

applicationName

enum (ApplicationName)

Nome do aplicativo para o qual os eventos serão recuperados.

Parâmetros de consulta

Parâmetros
`actorIpAddress`	`string` O endereço IP do host em que o evento foi realizado. Essa é outra maneira de filtrar o resumo de um relatório usando o endereço IP do usuário cuja atividade 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 de uma rede privada virtual (VPN). Esse parâmetro é compatível com as versões de endereço IPv4 e IPv6.
`customerId`	`string` O ID exclusivo do cliente para recuperar dados.
`endTime`	`string` Define o fim do período 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: Data da solicitação de um relatório pela API: quando a API criou e recuperou o relatório. Horário de início do relatório: o início do período mostrado no relatório. O `startTime` precisa ser anterior ao `endTime` (se especificado) e à hora atual em que a solicitação é feita. Caso contrário, a API retorna um erro. Horário de término do relatório: o fim do período mostrado no relatório. Por exemplo, o período dos eventos resumidos em um relatório pode começar em abril e terminar em maio, mas o relatório em si pode ser solicitado em agosto. Se o `endTime` não for especificado, o relatório vai retornar todas as atividades do `startTime` até o horário atual ou os 180 dias mais recentes se o `startTime` for de mais de 180 dias atrás.
`eventName`	`string` O nome do evento consultado pela API. Cada `eventName` está relacionado a um serviço ou recurso específico do Google Workspace que a API organiza em tipos de eventos. Um exemplo são os eventos do Google Agenda nos relatórios do aplicativo Admin Console. A estrutura de configurações da Agenda `type` tem todas as atividades da Agenda `eventName` informadas pela API. Quando um administrador muda uma configuração do Google Agenda, a API informa essa atividade nos parâmetros `type` e `eventName` das configurações do Google Agenda. Para mais informações sobre parâmetros e strings de consulta `eventName`, consulte a lista de nomes de eventos para vários aplicativos acima em `applicationName`.
`filters`	`string` A string de consulta `filters` é uma lista separada por vírgulas composta de parâmetros de evento manipulados por operadores relacionais. Os parâmetros de evento estão no formato `{parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...` Esses parâmetros de evento estão associados a um `eventName` específico. Um relatório vazio será retornado se o parâmetro da solicitação não pertencer ao `eventName`. Para mais informações sobre os campos `eventName` disponíveis para cada aplicativo e os parâmetros associados, acesse a tabela ApplicationName e clique na página "Eventos de atividade" no Apêndice do aplicativo desejado. Nos exemplos de atividade do Drive a seguir, a lista retornada consiste em todos os eventos `edit` em que o valor do parâmetro `doc_id` corresponde às condições definidas pelo operador relacional. No primeiro exemplo, a solicitação retorna todos os documentos editados com um valor `doc_id` igual a `12345`. No segundo exemplo, o relatório retorna todos os documentos editados em que o valor de `doc_id` não é igual a `98765`. O operador `<>` é codificado por URL na string de consulta da solicitação (`%3C%3E`): `GET...&eventName=edit&filters=doc_id==12345 GET...&eventName=edit&filters=doc_id%3C%3E98765` Uma consulta `filters` é compatível com estes operadores relacionais: `==`: "igual a". `<>`: "diferente de". Precisa ser codificado em URL (%3C%3E). `<`: "menor que". Precisa ser codificado por URL (%3C). `<=`: "menor que ou igual a". Precisa ser codificado por URL (%3C=). `>`: "maior que". Precisa ser codificado em URL (%3E). `>=`: "maior que ou igual a". Precisa ser codificado em URL (%3E=). Observação:a API não aceita vários valores do mesmo parâmetro. Se um parâmetro for fornecido mais de uma vez na solicitação de API, ela vai aceitar 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 vai ignorar esse parâmetro e retornar a resposta correspondente aos parâmetros válidos restantes. Se nenhum parâmetro for solicitado, todos serão retornados.
`maxResults`	`integer` Determina quantos registros de atividade são mostrados em cada página de resposta. Por exemplo, se a solicitação definir `maxResults=1` e o relatório tiver duas atividades, ele terá duas páginas. A propriedade `nextPageToken` da resposta tem o token para a segunda página. A string de consulta `maxResults` é opcional na solicitação. O valor padrão é 1000.
`orgUnitID (deprecated)`	`string` `Deprecated`. Esse campo foi descontinuado e não recebe mais suporte. ID da unidade organizacional para gerar relatórios. Os registros de atividade serão mostrados apenas para usuários que pertencem à unidade organizacional especificada. Os dados anteriores a 17 de dezembro de 2018 não aparecem nos resultados filtrados.
`pageToken`	`string` O token para especificar a próxima página. Um relatório com várias páginas tem uma propriedade `nextPageToken` na resposta. Na solicitação subsequente para receber a próxima página do relatório, insira o valor `nextPageToken` na string de consulta `pageToken`.
`startTime`	`string` 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 `startTime` até `endTime`. O `startTime` precisa ser anterior ao `endTime` (se especificado) e à hora atual em que a solicitação é feita. Caso contrário, a API retorna um erro.
`groupIdFilter (deprecated)`	`string` `Deprecated`. Esse campo foi descontinuado e não recebe mais suporte. IDs de grupo separados por vírgula (ofuscados) em que as atividades do usuário são filtradas. Ou seja, a resposta vai conter atividades apenas para os usuários que fazem parte de pelo menos um dos IDs de grupo mencionados aqui. Formato: "id:abc123,id:xyz456" Importante:para filtrar por grupos, você precisa adicioná-los explicitamente à lista de permissões de grupos de filtragem. Para mais informações sobre como adicionar grupos à lista de permissões de grupos de filtragem, consulte Filtrar resultados por Grupo do Google .

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 monitorar mudanças 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 }

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`	`string` Um UUID ou uma string exclusiva semelhante que identifica o canal.
`token`	`string` Uma string arbitrária entregue ao endereço de destino com cada notificação enviada por esse canal. Opcional.
`expiration`	`string (int64 format)` Data e hora de expiração do canal de notificação, expressas como um carimbo de data/hora Unix, em milissegundos. Opcional.
`type`	`string` O tipo de mecanismo de entrega usado para este canal. O valor deve ser definido como `"web_hook"`.
`address`	`string` O endereço em que as notificações são entregues para esse canal.
`payload`	`boolean` Um valor booleano para indicar se o payload é desejado. Um payload são dados enviados no corpo de uma mensagem HTTP POST, PUT ou PATCH e contém informações importantes sobre a solicitação. Opcional.
`params`	`map (key: string, value: string)` Parâmetros adicionais que controlam o comportamento do canal de exibição. Opcional. Um objeto com uma lista de pares `"key": value`. Exemplo: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
`resourceId`	`string` Um ID opaco que identifica o recurso monitorado neste canal. Estável em diferentes versões da API.
`resourceUri`	`string` Um identificador específico da versão para o recurso monitorado.
`kind`	`string` Identifica isso como um canal de notificação usado para monitorar mudanças em um recurso, que é "`api#channel`".

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