Method: activities.watch

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.

enum (ApplicationName)

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

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 denunciada. 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 oferece suporte às versões de endereço IPv4 e IPv6.

string

O ID exclusivo do cliente para recuperar dados.

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 da API. Um relatório de API tem três conceitos básicos de tempo:

• Data da solicitação da API para um relatório: quando a API criou e extraiu 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 ao horário atual quando a solicitação é feita. Caso contrário, a API vai retornar 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. O relatório em si pode ser solicitado em agosto.

string

O nome do evento que está sendo 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 do Admin Console. A estrutura type das configurações da agenda tem todas as atividades eventName da agenda informadas pela API. Quando um administrador muda uma configuração do Agenda, a API informa essa atividade nos parâmetros type e eventName das configurações do 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.

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 do evento estão no formulário {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...

Esses parâmetros de evento são associados a um eventName específico. Um relatório vazio é 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 app e os parâmetros associados, acesse a tabela ApplicationName e clique na página "Eventos de atividade" no apêndice do app 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 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 oferece suporte a estes operadores relacionais:

• ==: "igual a".
• <> — "diferente de". Precisa ser codificado por URL (%3C%3E).
• <: "menor que". Precisa ser codificado para uso em URL (%3C).
• <=: "menor que ou igual a". Precisa ser codificado em URL (%3C=).
• >: "maior que". Precisa ser codificado para uso em URL (%3E).
• >=: "maior 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 da API, ela só vai aceitar o último valor desse parâmetro. Além disso, se um parâmetro inválido for fornecido na solicitação da API, ela vai ignorar esse parâmetro e retornar a resposta correspondente aos parâmetros válidos restantes. Se nenhum parâmetro for solicitado, todos os parâmetros serão retornados.

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.

string

Deprecated. Este campo foi descontinuado e não é mais compatível.

ID da unidade organizacional que vai gerar o relatório. Os registros de atividade vão aparecer apenas para os usuários que pertencem à unidade organizacional especificada.

string

O token a ser especificado na próxima página. Um relatório com várias páginas tem uma propriedade nextPageToken na resposta. Na solicitação de acompanhamento para acessar a próxima página do relatório, insira o valor nextPageToken na string de consulta pageToken.

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 ao horário atual quando a solicitação é feita. Caso contrário, a API vai retornar um erro.

string

IDs de grupo separados por vírgulas (obfuscados) em que as atividades do usuário são filtradas. Ou seja, a resposta vai conter atividades apenas dos usuários que fazem parte de pelo menos um dos IDs de grupo mencionados aqui. Formato: "id:abc123,id:xyz456"