API Reports: relatório de uso de clientes

Esse relatório agrega informações de uso do serviço do Google Workspace para todos os usuários em todo o domínio. Esse relatório retorna informações sobre o uso do serviço do Google Workspace na sua conta. Essas informações de uso são organizadas por tipo de aplicativo, que é composta por parâmetros específicos do aplicativo. O período padrão e máximo de cada relatório são os últimos 450 dias.

Este relatório de uso só pode ser utilizado para fins legais de acordo com seu Contrato de Cliente. Além disso, esses relatórios são válidos para o Google Workspace e o Google Workspace for Education.

Recuperar um relatório de uso do cliente

Para recuperar o relatório das atividades da 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/dates/yyyy-mm-dd date
?parameters=app name: usage parameter,...
&customerId=the customer's ID
&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 as strings de consulta e as propriedades de resposta da solicitação, acesse a Referência da API e a referência de parâmetros do relatório de uso do cliente.

O exemplo a seguir exibe um relatório com o total de todos os logins bem-sucedidos na sua conta nos últimos 30 dias e uma lista de aplicativos autorizados, com o número de autorizações de usuário por aplicativo, a partir de 03/03/2013. A string de consulta maxResults mostra que esse relatório retorna dois eventos por página de relatório:

GET https://admin.googleapis.com/admin/reports/v1/usage/dates/2013-03-03
?parameters=accounts:num_30day_logins%2Caccounts:authorized_apps&maxResults=2

Resposta JSON para relatório de uso do cliente

{
 "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": "CUSTOMER",
    "customerId": "C03az79cb"
   },
   "parameters": [
    {
     "name": "accounts:num_1day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_30day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_7day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_disabled_accounts",
     "intValue": "5"
    },
    {
     "name": "accounts:authorized_apps",
     "msgValue": [
      {
       "client_id": "1234.apps.googleusercontent.com",
       "client_name": "www.example.com",
       "num_users": 2
      },
      {
       "client_id": "4567.apps.googleusercontent.com",
       "client_name": "Example",
       "num_users": 1
      },
     ...
     ]
    }
   ]
  }
 ]
}