Method: userUsageReport.get

Recupera um relatório, que é um conjunto de propriedades e estatísticas para um conjunto de usuários com a conta. Para mais informações, consulte o guia do Relatório de uso do usuário. Para mais informações sobre os parâmetros do relatório do usuário, consulte os guias de referência Parâmetros de uso dos usuários.

Solicitação HTTP

GET https://admin.googleapis.com/admin/reports/v1/usage/users/{userKey or all}/dates/{date}

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 do perfil exclusivo do Google Workspace de um usuário ou o endereço de e-mail principal. Não pode ser um usuário excluído. Para um usuário excluído, chame users.list na API Directory com o showDeleted=true e use o ID retornado como userKey.

date

string

Representa a data em que o uso ocorreu, com base no UTC-8:00 (horário padrão do Pacífico). O carimbo de data/hora está no formato ISO 8601, yyyy-mm-dd.

Parâmetros de consulta

Parâmetros
customerId

string

O ID exclusivo do cliente para o qual os dados serão recuperados.

filters

string

A string de consulta filters é uma lista separada por vírgulas dos parâmetros de evento de um aplicativo em que o valor do parâmetro é manipulado por um operador relacional. A string de consulta filters inclui o nome do aplicativo cujo uso é retornado no relatório. Os valores do aplicativo para o Relatório de uso dos usuários incluem accounts, docs e gmail.

Os filtros estão no formato [application name]:[parameter name][relational operator][parameter value],....

Neste exemplo, o operador <> "não é igual a" é codificado para URL na string de consulta da solicitação (%3C%3E):

GET
https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time
&filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z 

Os operadores relacionais incluem:

  • == – 'igual a'.
  • <>: "diferente de". É codificada para uso em URL (%3C%3E).
  • <: "menor que". É codificada para uso em URLs (%3C).
  • <=: "menor ou igual a". É codificada para uso em URLs (%3C=).
  • >: "maior que". É codificada para uso em URLs (%3E).
  • >=: "maior ou igual a". É codificada para uso em URL (%3E=).

maxResults

integer (uint32 format)

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.

orgUnitID

string

ID da unidade organizacional que será usada no relatório. A atividade do usuário só vai aparecer para os usuários que pertencem à unidade organizacional especificada.

pageToken

string

Token para especificar a próxima página. Um relatório com várias páginas tem uma propriedade nextPageToken na resposta. Na sua solicitação seguinte para acessar a próxima página do relatório, insira o valor nextPageToken na string de consulta pageToken.

parameters

string

A string de consulta parameters é uma lista separada por vírgulas de parâmetros de evento que refinam os resultados de um relatório. O parâmetro está associado a um aplicativo específico. Os valores dos aplicativos do relatório de uso dos clientes incluem accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet e sites.
Uma string de consulta parameters está no formato CSV de app_name1:param_name1, app_name2:param_name2.

groupIdFilter

string

IDs de grupos separados por vírgulas (ofuscados) em que as atividades do usuário são filtradas. Ou seja, a resposta 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

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de UsageReports.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/admin.reports.usage.readonly

Para mais informações, consulte o Guia de autorização.