- Solicitação HTTP
- Parâmetros de caminho
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- ApplicationName
- Atividade
- Faça um teste
Recupera uma lista de atividades para a conta e um aplicativo de um cliente específico, como o aplicativo Admin Console ou o Google Drive. Para mais informações, consulte os guias dos relatórios de atividade do administrador e do Google Drive. Para mais informações sobre os parâmetros do relatório de atividades, consulte os guias de referência dos parâmetros de atividade.
Solicitação HTTP
GET https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}
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 precisa estar vazio.
Corpo da resposta
Modelo JSON para uma coleção de atividades.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{
"kind": string,
"etag": string,
"items": [
{
object ( |
Campos | |
---|---|
kind |
O tipo de recurso da API. Para um relatório de atividades, o valor é |
etag |
ETag do recurso. |
items[] |
Cada registro de atividade na resposta. |
nextPageToken |
Token para recuperar a próxima página do relatório. O valor |
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
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 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. |
vault |
Os relatórios de atividade do Vault retornam informações sobre vários tipos de eventos de atividade do Vault. |
Atividade
Modelo JSON para o recurso de atividade.
Representação JSON |
---|
{ "kind": string, "etag": string, "ownerDomain": string, "ipAddress": string, "events": [ { "type": string, "name": string, "parameters": [ { "messageValue": { "parameter": [ { object ( |
Campos | |
---|---|
kind |
O tipo de recurso da API. Para um relatório de atividades, o valor é |
etag |
ETag da entrada. |
ownerDomain |
Esse é o domínio afetado pelo evento do relatório. Por exemplo, domínio do Admin Console ou proprietário do documento do app Drive. |
ipAddress |
Endereço IP do usuário que realiza a ação Esse é o endereço IP do usuário ao fazer login no Google Workspace, que 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). A API oferece suporte a IPv4 e IPv6. |
events[] |
Eventos de atividade no relatório. |
events[].type |
Tipo de evento. O serviço ou recurso do Google Workspace que um administrador muda é identificado na propriedade |
events[].name |
Nome do evento. Esse é o nome específico da atividade relatada pela API. E cada
Para mais informações sobre as propriedades eventName , consulte a lista de nomes de eventos para vários aplicativos acima em applicationName .
|
events[].parameters[] |
Pares de valores de parâmetros para diversos aplicativos. Para mais informações sobre os parâmetros |
events[].parameters[].messageValue |
Pares de valores de parâmetros aninhados associados a esse parâmetro. O tipo de valor complexo de um parâmetro é retornado como uma lista de valores de parâmetro. Por exemplo, o parâmetro de endereço pode ter um valor como |
events[].parameters[].messageValue.parameter[] |
Valores de parâmetros |
events[].parameters[].name |
O nome do parâmetro. |
events[].parameters[].value |
Valor de string do parâmetro. |
events[].parameters[].multiValue[] |
Valores de string do parâmetro. |
events[].parameters[].intValue |
Valor inteiro do parâmetro. |
events[].parameters[].multiIntValue[] |
Valores inteiros do parâmetro. |
events[].parameters[].boolValue |
Valor booleano do parâmetro. |
events[].parameters[].multiMessageValue[] |
activity.list de objetos |
events[].parameters[].multiMessageValue[].parameter[] |
Valores de parâmetros |
id |
Identificador exclusivo de cada registro de atividade. |
id.time |
Hora em que a atividade ocorreu. É a época do UNIX em segundos. |
id.uniqueQualifier |
Qualificador exclusivo se vários eventos tiverem o mesmo tempo. |
id.applicationName |
Nome do aplicativo a que o evento pertence. Para valores possíveis, consulte a lista de aplicativos acima em |
id.customerId |
O identificador exclusivo de uma conta do Google Workspace. |
actor |
Usuário realizando a ação. |
actor.profileId |
O ID do perfil exclusivo do Google Workspace do ator. Esse valor pode estar ausente se o ator não for um usuário do Google Workspace ou pode ser o número 105250506097979753968, que atua como um ID de marcador. |
actor.email |
O endereço de e-mail principal do ator. Pode estar ausente se não houver um endereço de e-mail associado ao ator. |
actor.callerType |
O tipo de ator. |
actor.key |
Presente apenas quando |