API Reports: relatório de uso dos usuários

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

O relatório de uso do usuário retorna informações de uso do serviço do Google Workspace de um usuário específico no seu domínio. Esses relatórios podem ser personalizados e filtrados por informações de uso específico. O período padrão e máximo de cada relatório são os últimos 450 dias.

Esses relatórios de uso do usuário só podem ser usados para fins legais de acordo com o Contrato do Cliente. Esses relatórios são válidos para o Google Workspace e o Google Workspace for Education.

Recuperar todas as atividades de uso do usuário

Para recuperar um relatório de todas as atividades do usuário na sua conta, use a seguinte solicitação HTTP GET e inclua o token de autorização descrito na documentação de autorização. Para facilitar a leitura, o exemplo a seguir é formatado com retornos de linha:

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/yyyy-mm-dd date
?parameters=application: user usage parameter,...
&filters=application: user usage parameter relational operator usage parameter's value,...
&maxResults=number of events listed on each page of the report

O valor dates é a data em que o uso ocorreu e o carimbo de data/hora está no formato ISO 8601, aaaa-mm-dd. Recomendamos que você use o fuso horário da sua conta para isso. Para mais informações sobre os parâmetros da string de consulta e as propriedades de resposta, consulte a Referência da API. Para informações sobre os parâmetros de relatório de uso do usuário, consulte a referência de parâmetros de uso do usuário.

O exemplo a seguir gera um relatório sobre todas as atividades do usuário da conta.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all
/dates/2013-03-03?maxResults=2

O exemplo a seguir mostra um relatório sobre todas as atividades do usuário de uma conta de cliente específica.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all
/dates/2013-03-03?customerId=C03az79cb

O exemplo a seguir gera um relatório sobre os últimos carimbos de data/hora de login dos usuários na conta. Para ver um exemplo de resposta de API, consulte este link.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time&maxResults=2

O exemplo a seguir exibe um relatório sobre os últimos carimbos de data/hora de login dos usuários na conta, filtrados por usuários que fizeram login após um período específico. Para ver um exemplo de resposta de API, consulte este link.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time&filters=accounts:last_login_time
>2010-10-28T10:26:35.000Z"

O exemplo a seguir mostra um relatório sobre os últimos carimbos de data/hora de login e o status suspenso dos usuários na conta. Para ver um exemplo de resposta de API, consulte este link.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time,accounts:is_disabled"

Recuperar atividades de uso de um usuário específico

Para recuperar um relatório das atividades específicas de um usuário na sua conta, use a solicitação HTTP GET a seguir e inclua o token de autorização descrito na documentação de autorização. Para facilitar a leitura, o exemplo a seguir é formatado com retornos de linha.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/userKey/dates/yyyy-mm-dd date
?parameters=application: user usage parameter,...
&filters=application: user usage parameter relational operator usage parameter's value,...
&maxResults=number of events listed on each page of the report

O userKey pode ser o endereço de e-mail principal do usuário no relatório ou o profileId do Google Workspace exclusivo do usuário. O valor dates é a data em que o uso ocorreu e o carimbo de data/hora está no formato ISO 8601, aaaa-mm-dd. Recomendamos que você use o fuso horário da sua conta para isso. Para mais informações sobre os parâmetros da string de consulta e as propriedades de resposta, consulte a Referência da API. Para informações sobre os parâmetros de relatório de uso do usuário, consulte a referência de parâmetros de uso do usuário.

No exemplo a seguir, recebemos o relatório de uso de joao@example.com.

https://admin.googleapis.com/admin/reports/v1/usage/users/john@example.com/dates/2013-03-03

Exemplo de resposta JSON do relatório de uso

Uma resposta bem-sucedida retorna um código de status HTTP 200. Junto com o código de status, a resposta retorna um relatório.

Resposta JSON para relatório de usuário

{
 "kind": "reports#usageReports",
 "warnings": [
    {
      "code": warning machine-readable code,
      "message": warning human-readable message,
      "data": [
        {
          "key": key for key-value pair that gives detailed warning information,
          "value": value for key-value pair giving detailed warning information
        }
      ]
    }
  ],
 "nextPageToken": "N:NNN:NNN:N:C03az79cb",
 "usageReports": [
{
   "kind": "usageReport",
   "date": "2013-03-03",
   "entity": {
    "type": "USER",
    "customerId": "C03az79cb",
    "userEmail": "liz@example.com",
    "profileId": "user's unique Google Workspace ID"
   },
   "parameters": [
    {
      "name": "accounts:is_disabled",
      "boolValue": false
     },
    {
     "name": "accounts:disabled_reason",
     "stringValue": "reason description"
    },
    {
     "name": "accounts:first_name",
     "stringValue": "Liz"
    },
    {
     "name": "accounts:is_2sv_enforced",
     "boolValue": false
    },
    {
     "name": "accounts:is_2sv_enrolled",
     "boolValue": false
    },
    {
     "name": "accounts:last_name",
     "stringValue": "Smith"
    },
    {
     "name": "accounts:creation_time",
     "datetimeValue": "2010-10-28T10:26:35.000Z"
    },
    {
     "name": "accounts:last_login_time",
     "datetimeValue": "1970-01-01T00:00:00.000Z"
    },
    {
     "name": "accounts:last_sso_time",
     "datetimeValue": "1970-01-01T00:00:00.000Z"
    }
   ]
  }
 ]
}