- Solicitação HTTP
- Parâmetros de caminho
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- ApplicationName
- Atividade
- ResourceDetails
- AppliedLabel
- FieldValue
- TextListValue
- SelectionValue
- SelectionListValue
- UserValue
- UserListValue
- Date
- Motivo
- Faça um teste
Recupera uma lista de atividades da conta e do aplicativo de um cliente específico, como o aplicativo do Admin Console ou do Google Drive. Para mais informações, consulte os guias para 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 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 que os dados serão filtrados. Pode ser |
applicationName |
Nome do aplicativo para o qual 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 é 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. |
customerId |
O ID exclusivo do cliente para recuperar dados. |
endTime |
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:
endTime não for especificado, o relatório vai retornar todas as atividades da startTime até o momento atual ou os 180 dias mais recentes, se a startTime for mais antiga.
|
eventName |
O nome do evento que está sendo consultado pela API. Cada |
filters |
A string de consulta Esses parâmetros de evento 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 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. |
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 a ser incluída no relatório. Os registros de atividade vão aparecer apenas para os usuários que pertencem à unidade organizacional especificada. |
pageToken |
O token para 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 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" . |
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 atividade, 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 mostram informações sobre diferentes tipos de eventos de atividade da Transparência no acesso. |
admin |
Os relatórios de atividade do aplicativo do Admin Console retornam informações da conta sobre diferentes tipos de eventos de atividade do administrador. |
calendar |
Os relatórios de atividade do app Google Agenda mostram 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 mostram 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 do 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 Google Groups 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 de login retornam informações da conta sobre diferentes tipos de eventos de atividade de login. |
meet |
O relatório de atividade da auditoria do Meet mostra informações sobre diferentes tipos de eventos de atividade da auditoria do Meet. |
mobile |
O relatório de atividade da auditoria do dispositivo retorna informações sobre diferentes tipos de eventos de atividade da auditoria do dispositivo. |
rules |
O relatório de atividade das regras retorna informações sobre diferentes tipos de eventos de atividade das 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 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 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 aos usuários devido a regras de acesso baseado no contexto. |
chrome |
Os relatórios de atividade do Chrome mostram 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 app 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. |
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 atividade, o valor é |
etag |
ETag da entrada. |
ownerDomain |
É o domínio afetado pelo evento do relatório. Por exemplo, o domínio do Admin Console ou o proprietário do documento do app Drive. |
ipAddress |
Endereço IP do usuário que realizou 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 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). 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 altera é identificado na propriedade |
events[].name |
Nome do evento. É o nome específico da atividade informada pela API. 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âmetro para várias aplicações. Para mais informações sobre os parâmetros |
events[].parameters[].messageValue |
Pares de valor de parâmetro 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[] |
activities.list de objetos |
events[].parameters[].multiMessageValue[].parameter[] |
Valores de parâmetros |
events[].resourceIds[] |
IDs de recursos associados ao evento. |
id |
Identificador exclusivo de cada registro de atividade. |
id.time |
Hora da ocorrência da atividade. Esse é o tempo da época do UNIX em segundos. |
id.uniqueQualifier |
Qualificador exclusivo se vários eventos tiverem o mesmo horário. |
id.applicationName |
Nome do aplicativo ao qual o evento pertence. Para conferir os valores possíveis, consulte a lista de aplicativos acima em |
id.customerId |
O identificador exclusivo de uma conta do Google Workspace. |
actor |
Usuário que realiza a ação. |
actor.profileId |
O ID exclusivo do perfil do Google Workspace do usuário. 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 |
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 somente quando |
actor.applicationInfo |
Detalhes do aplicativo que foi o ator da atividade. |
actor.applicationInfo.oauthClientId |
ID do cliente OAuth do aplicativo de terceiros usado para realizar a ação. |
actor.applicationInfo.applicationName |
Nome do aplicativo usado para realizar a ação. |
actor.applicationInfo.impersonation |
Se o aplicativo estava falsificando a identidade de um usuário. |
resourceDetails[] |
Detalhes do recurso em que a ação foi realizada. |
ResourceDetails
Detalhes do recurso em que a ação foi realizada.
Representação JSON |
---|
{
"id": string,
"title": string,
"type": string,
"appliedLabels": [
{
object ( |
Campos | |
---|---|
id |
Identificador do recurso. |
title |
Título do recurso. Por exemplo, no caso de um documento do Drive, esse seria o título do documento. No caso de um e-mail, esse seria o assunto. |
type |
Tipo de recurso: documento, e-mail, mensagem de chat |
appliedLabels[] |
activities.lista de rótulos aplicados ao recurso |
relation |
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 ( |
Campos | |
---|---|
id |
Identificador do rótulo: apenas o ID do rótulo, não o nome completo do recurso da OnePlatform. |
title |
Título do rótulo |
fieldValues[] |
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 estar presente nessa lista. |
reason |
O motivo pelo qual o rótulo foi aplicado 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 ( |
Campos | |
---|---|
id |
Identificador do campo |
displayName |
Nome de exibição do campo |
type |
Tipo do campo |
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 |
Se o campo não estiver definido, o valor será verdadeiro. |
longTextValue |
Como definir um valor de texto longo. |
textValue |
Como definir um valor de texto. |
textListValue |
Como definir um valor de lista de texto. |
selectionValue |
Definir um valor de seleção selecionando um único valor em uma lista suspensa. |
selectionListValue |
Definir um valor da lista de seleção selecionando vários valores em um menu suspenso. |
integerValue |
Como definir um valor inteiro. |
userValue |
Como definir um valor de usuário selecionando um único usuário. |
userListValue |
Como definir um valor de lista de usuários selecionando vários usuários. |
dateValue |
Como definir um valor de data. |
TextListValue
Como definir um valor de lista de texto.
Representação JSON |
---|
{ "values": [ string ] } |
Campos | |
---|---|
values[] |
activities.list de valores de texto. |
SelectionValue
Definir um valor de seleção selecionando um único valor em uma lista suspensa.
Representação JSON |
---|
{ "id": string, "displayName": string, "badged": boolean } |
Campos | |
---|---|
id |
Identificador da seleção. |
displayName |
Nome de exibição da seleção. |
badged |
Indica se a seleção tem um selo. |
SelectionListValue
Definir um valor da lista de seleção selecionando vários valores em um menu suspenso.
Representação JSON |
---|
{
"values": [
{
object ( |
Campos | |
---|---|
values[] |
activities.list de seleções. |
UserValue
Como definir um valor de usuário selecionando um único usuário.
Representação JSON |
---|
{ "email": string } |
Campos | |
---|---|
email |
E-mail do usuário. |
UserListValue
Como definir um valor de lista de usuários selecionando vários usuários.
Representação JSON |
---|
{
"values": [
{
object ( |
Campos | |
---|---|
values[] |
activities.list of users. |
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:
google.type.TimeOfDay
google.type.DateTime
google.protobuf.Timestamp
Representação JSON |
---|
{ "year": integer, "month": integer, "day": integer } |
Campos | |
---|---|
year |
Ano da data. Precisa ser de 1 a 9.999 ou 0 para especificar uma data sem ano. |
month |
Mês do ano. Precisa ser de 1 a 12, ou 0 para especificar um ano sem um mês e dia. |
day |
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 pelo qual o marcador/campo foi aplicado.
Representação JSON |
---|
{ "reasonType": string } |
Campos | |
---|---|
reasonType |
O tipo de motivo. |