Method: activities.list

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 ou o endereço de e-mail principal de um usuário. 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 em que os eventos serão recuperados.

string

O endereço IP do host em que o evento foi realizado. Essa é uma forma adicional 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 um endereço da 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 o qual os dados serão recuperados.

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 horário aproximado da solicitação de 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 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 à endTime (se especificado) e o horário atual em que a solicitação é feita. Caso contrário, a API vai retornar um erro.
• Horário de término do relatório: o término 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 poderá 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 Admin Console. A estrutura type das configurações da Agenda inclui todas as atividades eventName do Agenda 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 dos 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 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 a 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 atividades do Drive a seguir, a lista retornada consiste em todos os eventos edit em que o valor de 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 é compatível com estes operadores relacionais:

• ==: "igual a".
• <> — "diferente de". Precisa ser codificado para uso em URL (%3C%3E).
• <—'menor que'. Precisa ser codificado para uso em URL (%3C).
• <= — "menor ou igual a". Precisa ser codificado para uso em URL (%3C=).
• > — "maior que". Precisa ser codificado para uso em URL (%3E).
• >=: "maior ou igual a". Precisa ser codificado para uso em URL (%3E=).

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 da API, a API aceita apenas o último valor desse parâmetro. Além disso, se um parâmetro inválido é fornecido na solicitação da API, a API ignora esse parâmetro e retorna 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

ID da unidade organizacional que vai gerar o relatório. Os registros de atividades serão exibidos 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 à endTime (se especificado) e o horário atual em que a solicitação é feita. Caso contrário, a API vai retornar um erro.

string

IDs de grupos separados por vírgula (ofuscados) em que as atividades do usuário são filtradas, ou seja, a resposta conterá atividades somente para os usuários que fazem parte de pelo menos um dos IDs de grupo mencionados aqui. Formato: "id:abc123,id:xyz456"

{
  "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)
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "id": {
    "time": string,
    "uniqueQualifier": string,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "profileId": string,
    "email": string,
    "callerType": string,
    "key": string
  }
}

string

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

string

ETag da entrada.

string

Este é 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.

string

Endereço IP do usuário que está realizando a ação. Este é o endereço IP do usuário ao fazer login no Google Workspace e 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 um endereço da rede privada virtual (VPN). A API oferece suporte a IPv4 e IPv6.

object

Eventos de atividade no relatório.

string

Tipo de evento. O serviço ou recurso do Google Workspace alterado por um administrador é 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 dos vários aplicativos acima em applicationName.

string

Nome do evento. Esse é o nome específico da atividade informada pela API. Cada eventName está relacionada 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 de eventName em geral:

• Se nenhum eventName for fornecido, o relatório 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.

object

Pares de valores de parâmetros para diversos aplicativos. Para mais informações sobre os parâmetros eventName, consulte a lista de nomes de eventos para vários aplicativos acima em applicationName.

object

Pares de valores de parâmetros aninhados associados a este parâmetro. Tipo de valor complexo para 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 [{parameter: [{name: city, value: abc}]}].

object (NestedParameter)

Valores de parâmetros

string

O nome do parâmetro.

string

Valor de string do parâmetro.

string

Valores de string do parâmetro.

string (int64 format)

Valor inteiro do parâmetro.

string (int64 format)

Valores inteiros do parâmetro.

boolean

Valor booleano do parâmetro.

object

activity.list de objetos messageValue.

object (NestedParameter)

Valores de parâmetros

object

Identificador exclusivo de cada registro de atividade.

string

Hora de ocorrência da atividade. Isso está no horário de época do UNIX em segundos.

string (int64 format)

Qualificador exclusivo se vários eventos tiverem o mesmo tempo.

string

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

string

O identificador exclusivo de uma conta do Google Workspace.

object

Usuário que realiza a ação.

string

O ID exclusivo do perfil do Google Workspace do ator. Esse valor poderá estar ausente se o agente não for um usuário do Google Workspace ou pode ser o número 105250506097979753968, que atua como um ID de marcador.

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.

string

O tipo de ator.

string

Presente apenas quando callerType é KEY. Pode ser o consumer_key do solicitante para solicitações da API OAuth 2LO ou um identificador para contas robô.