Method: activities.list

Recupera uma lista de atividades da conta e do aplicativo de um cliente específico, como o aplicativo do Admin Console ou o Google Drive. Para mais informações, consulte os guias de relatórios de atividade do administrador e do Google Drive. Para mais informações sobre os parâmetros do relatório de atividade, consulte os guias de referência de 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

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.

Para solicitações do Gmail, startTime e endTime precisam ser fornecidos, e a diferença não pode ser maior que 30 dias.
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 do 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 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.
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 por 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

string

ID da unidade organizacional para gerar relatórios. Os registros de atividade só serão mostrados para usuários que pertencem à unidade organizacional especificada.

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.

Para solicitações do Gmail, startTime e endTime precisam ser fornecidos, e a diferença não pode ser maior que 30 dias.
groupIdFilter

string

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"

.

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 (Activity)
    }
  ],
  "nextPageToken": string
}
Campos
kind

string

O tipo de recurso da API. Para um relatório de atividade, o valor é reports#activities.
etag

string

ETag do recurso.
items[]

object (Activity)

Cada registro de atividade na resposta.
nextPageToken

string

Token para recuperar a próxima página do relatório. O valor nextPageToken é usado na string de consulta pageToken da solicitação.

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

Tipos enumerados
access_transparency

Os relatórios de atividade da Transparência no acesso do Google Workspace retornam informações sobre diferentes tipos de eventos de atividade 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 do 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 está disponível apenas para 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.
gmail Os relatórios de atividade do aplicativo Gmail retornam informações sobre vários eventos de atividade do Gmail.
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 aplicativo Grupos do Google retornam informações sobre vários eventos de atividade dos grupos.
groups_enterprise

Os relatórios de atividade dos grupos do Enterprise retornam informações sobre vários eventos de atividade dos grupos do Enterprise.
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 Login retornam informações da conta sobre diferentes tipos de eventos de atividade de login.
meet O relatório de atividade de auditoria do Meet retorna informações sobre diferentes tipos de eventos de atividade de auditoria do Meet.
mobile O relatório de atividade de auditoria de dispositivos retorna informações sobre diferentes tipos de eventos de atividade de auditoria de dispositivos.
rules

O relatório de atividade de regras retorna informações sobre diferentes tipos de eventos de atividade de regras.
saml

O relatório de atividade SAML retorna informações sobre diferentes tipos de eventos de atividade SAML.
token

Os relatórios de atividade do aplicativo Token retornam informações da conta sobre diferentes tipos de eventos de atividade do Token.
user_accounts

Os relatórios de atividade do aplicativo Contas de usuário retornam informações sobre diferentes tipos de eventos de atividade das Contas de usuário.
context_aware_access

Os relatórios de atividade do Acesso baseado no contexto retornam informações sobre eventos de acesso negado dos usuários devido a 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 está disponível apenas para 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.
gemini_in_workspace_apps

Os relatórios de atividade do Gemini para Workspace retornam informações sobre vários tipos de eventos de atividade do Gemini realizados pelos usuários em um aplicativo do Workspace.
classroom Os relatórios de atividades do Google Sala de Aula retornam informações sobre diferentes tipos de eventos de atividade do Google Sala de Aula.

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 (NestedParameter)
              }
            ]
          },
          "name": string,
          "value": string,
          "multiValue": [
            string
          ],
          "intValue": string,
          "multiIntValue": [
            string
          ],
          "boolValue": boolean,
          "multiMessageValue": [
            {
              "parameter": [
                {
                  object (NestedParameter)
                }
              ]
            }
          ]
        }
      ],
      "resourceIds": [
        string
      ]
    }
  ],
  "id": {
    "time": string,
    "uniqueQualifier": string,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "profileId": string,
    "email": string,
    "callerType": string,
    "key": string,
    "applicationInfo": {
      "oauthClientId": string,
      "applicationName": string,
      "impersonation": boolean
    }
  },
  "networkInfo": {
    object (NetworkInfo)
  },
  "resourceDetails": [
    {
      object (ResourceDetails)
    }
  ]
}
Campos
kind

string

O tipo de recurso da API. Para um relatório de atividade, o valor é audit#activity.
etag

string

ETag da entrada.
ownerDomain

string

É o domínio afetado pelo evento do relatório. Por exemplo, o domínio do Admin Console ou o proprietário do documento do aplicativo Drive.
ipAddress

string

Endereço IP do usuário que está realizando a ação. É o endereço IP do usuário ao fazer login no Google Workspace, que pode ou não refletir a localização física dele. Por exemplo, o endereço IP pode ser o endereço do servidor proxy do usuário ou de uma rede privada virtual (VPN). A API é compatível com IPv4 e IPv6.
events[]

object

Eventos de atividade no relatório.
events[].type

string

Tipo de evento. O serviço ou recurso do Google Workspace que um administrador muda é identificado na propriedade type, que identifica um evento usando a propriedade eventName. Para conferir uma lista completa das categorias type da API, consulte a lista de nomes de eventos para vários aplicativos acima em applicationName.
events[].name

string

Nome do evento. É o nome específico da atividade informada 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.
Para parâmetros de solicitação eventName em geral:

  • Se nenhum eventName for informado, o relatório vai retornar todas as instâncias possíveis de um eventName.
  • Quando você solicita um eventName, a resposta da API retorna todas as atividades que contêm esse eventName.

Para mais informações sobre propriedades eventName, consulte a lista de nomes de eventos para vários aplicativos acima em applicationName.
events[].parameters[]

object

Pares de valores de parâmetros para várias aplicações. Para mais informações sobre os parâmetros eventName, consulte a lista de nomes de eventos para vários aplicativos acima em applicationName.
events[].parameters[].messageValue

object

Pares de valores de parâmetros aninhados associados a este parâmetro. Tipos de valores complexos para um parâmetro são retornados como uma lista de valores de parâmetro. Por exemplo, o parâmetro de endereço pode ter um valor como [{parameter: [{name: city, value: abc}]}]
events[].parameters[].messageValue.parameter[]

object (NestedParameter)

Valores de parâmetros
events[].parameters[].name

string

O nome do parâmetro.
events[].parameters[].value

string

Valor da string do parâmetro.
events[].parameters[].multiValue[]

string

Valores de string do parâmetro.
events[].parameters[].intValue

string (int64 format)

Valor inteiro do parâmetro.
events[].parameters[].multiIntValue[]

string (int64 format)

Valores inteiros do parâmetro.
events[].parameters[].boolValue

boolean

Valor booleano do parâmetro.
events[].parameters[].multiMessageValue[]

object

activities.list de objetos messageValue.
events[].parameters[].multiMessageValue[].parameter[]

object (NestedParameter)

Valores de parâmetros
events[].resourceIds[]

string

IDs de recursos associados ao evento.
id

object

Identificador exclusivo de cada registro de atividade.
id.time

string

Horário da ocorrência da atividade. Isso está no tempo da época do UNIX em segundos.
id.uniqueQualifier

string (int64 format)

Qualificador exclusivo se vários eventos ocorrerem ao mesmo tempo.
id.applicationName

string

Nome do aplicativo a que o evento pertence. Para conferir os valores possíveis, consulte a lista de aplicativos acima em applicationName.
id.customerId

string

O identificador exclusivo de uma conta do Google Workspace.
actor

object

Usuário que está realizando a ação.
actor.profileId

string

O ID exclusivo do perfil 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 funciona como um ID de marcador de posição.
actor.email

string

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

string

O tipo de ator.
actor.key

string

Presente somente quando callerType é KEY. Pode ser o consumer_key do solicitante para solicitações de API OAuth 2LO ou um identificador para contas de robôs.
actor.applicationInfo

object

Detalhes do aplicativo que foi o ator da atividade.
actor.applicationInfo.oauthClientId

string

ID do cliente OAuth do aplicativo de terceiros usado para realizar a ação.
actor.applicationInfo.applicationName

string

Nome do aplicativo usado para realizar a ação.
actor.applicationInfo.impersonation

boolean

Se o aplicativo estava representando um usuário.
networkInfo

object (NetworkInfo)

Informações de rede do usuário que está realizando a ação.
resourceDetails[]

object (ResourceDetails)

Detalhes do recurso em que a ação foi realizada.

NetworkInfo

Informações de rede do usuário que está realizando a ação.

Representação JSON 
{
  "ipAsn": [
    integer
  ],
  "regionCode": string,
  "subdivisionCode": string
}
Campos
ipAsn[]

integer

Endereço IP do usuário que está realizando a ação.
regionCode

string

Código regional ISO 3166-1 alfa-2 do usuário que está realizando a ação.
subdivisionCode

string

Código da região ISO 3166-2 (estados e províncias) para os países do usuário que está realizando a ação.

ResourceDetails

Detalhes do recurso em que a ação foi realizada.

Representação JSON 
{
  "id": string,
  "title": string,
  "type": string,
  "appliedLabels": [
    {
      object (AppliedLabel)
    }
  ],
  "relation": string
}
Campos
id

string

Identificador do recurso.
title

string

Título do recurso. Por exemplo, no caso de um documento do Drive, seria o título dele. No caso de um e-mail, seria o assunto.
type

string

Tipo do recurso: documento, e-mail, mensagem de chat
appliedLabels[]

object (AppliedLabel)

activities.list de rótulos aplicados ao recurso
relation

string

Define a relação do recurso com os eventos.

AppliedLabel

Detalhes do rótulo aplicado ao recurso.

Representação JSON 
{
  "id": string,
  "title": string,
  "fieldValues": [
    {
      object (FieldValue)
    }
  ],
  "reason": {
    object (Reason)
  }
}
Campos
id

string

Identificador do rótulo. Apenas o ID, não o nome completo do recurso da OnePlatform.
title

string

Título do marcador
fieldValues[]

object (FieldValue)

activities.list de campos que fazem parte do rótulo e foram definidos pelo usuário. Se o rótulo tiver um campo que não foi definido pelo usuário, ele não vai aparecer nessa lista.
reason

object (Reason)

O motivo da aplicação do rótulo ao recurso.

FieldValue

Detalhes do valor do campo definido pelo usuário para o rótulo específico.

Representação JSON 
{
  "id": string,
  "displayName": string,
  "type": string,
  "reason": {
    object (Reason)
  },

  // Union field value can be only one of the following:
  "unsetValue": boolean,
  "longTextValue": string,
  "textValue": string,
  "textListValue": {
    object (TextListValue)
  },
  "selectionValue": {
    object (SelectionValue)
  },
  "selectionListValue": {
    object (SelectionListValue)
  },
  "integerValue": string,
  "userValue": {
    object (UserValue)
  },
  "userListValue": {
    object (UserListValue)
  },
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
Campos
id

string

Identificador do campo
displayName

string

Nome de exibição do campo
type

string

Tipo do campo
reason

object (Reason)

O motivo pelo qual o campo foi aplicado ao rótulo.
Campo de união value. Armazena os valores armazenados no campo value. Pode ser apenas um dos seguintes:
unsetValue

boolean

Se o campo não estiver definido, o valor será "true".
longTextValue

string

Definir um valor de texto longo.
textValue

string

Definir um valor de texto.
textListValue

object (TextListValue)

Definir um valor de lista de texto.
selectionValue

object (SelectionValue)

Definir um valor de seleção escolhendo uma única opção em um menu suspenso.
selectionListValue

object (SelectionListValue)

Definir um valor de lista de seleção escolhendo vários valores em um menu suspenso.
integerValue

string (int64 format)

Definir um valor inteiro.
userValue

object (UserValue)

Definir um valor de usuário selecionando um único usuário.
userListValue

object (UserListValue)

Definir um valor de lista de usuários selecionando vários usuários.
dateValue

object (Date)

Definir um valor de data.

TextListValue

Definir um valor de lista de texto.

Representação JSON 
{
  "values": [
    string
  ]
}
Campos
values[]

string

activities.list de valores de texto.

SelectionValue

Definir um valor de seleção escolhendo uma única opção em um menu suspenso.

Representação JSON 
{
  "id": string,
  "displayName": string,
  "badged": boolean
}
Campos
id

string

Identificador da seleção.
displayName

string

Nome de exibição da seleção.
badged

boolean

Se a seleção tem um selo.

SelectionListValue

Definir um valor de lista de seleção escolhendo vários valores em um menu suspenso.

Representação JSON 
{
  "values": [
    {
      object (SelectionValue)
    }
  ]
}
Campos
values[]

object (SelectionValue)

activities.list de seleções.

UserValue

Definir um valor de usuário selecionando um único usuário.

Representação JSON 
{
  "email": string
}
Campos
email

string

E-mail do usuário.

UserListValue

Definir um valor de lista de usuários selecionando vários usuários.

Representação JSON 
{
  "values": [
    {
      object (UserValue)
    }
  ]
}
Campos
values[]

object (UserValue)

activities.list de usuários.

Data

Representa uma data inteira ou parcial do calendário, como um aniversário. A hora do dia e o fuso horário são especificados em outro lugar ou são insignificantes. A data é referente ao calendário gregoriano. Isso pode representar uma das seguintes opções:

  • uma data completa, com valores de ano, mês e dia diferentes de zero;
  • um mês e dia, com um ano zero (por exemplo, uma data comemorativa);
  • um ano sozinho, com um mês zero e um dia zero;
  • um ano e mês, com um dia zero (por exemplo, uma data de validade de cartão de crédito).

Tipos relacionados:

Representação JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Campos
year

integer

Ano da data. Precisa ser de 1 a 9.999 ou 0 para especificar uma data sem ano.
month

integer

Mês do ano. Precisa ser de 1 a 12, ou 0 para especificar um ano sem um mês e dia.
day

integer

Dia do mês. Precisa ser de 1 a 31 e válido para o ano e o mês, ou 0 para especificar um ano sozinho ou um ano e mês em que o dia não é significativo.

Motivo

O motivo da aplicação do rótulo/campo.

Representação JSON 
{
  "reasonType": string
}
Campos
reasonType

string

O tipo do motivo.