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 de 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}
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.
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 de usuários incluem accounts, docs e gmail.
Os filtros estão no formato [application name]:[parameter
name][relational operator][parameter value],....
Neste exemplo, a <> "not equal to" é codificado por 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 URL (%3C%3E).
<: "menor que". É codificada para URL (%3C).
<=: "menor ou igual a". É codificada para URL (%3C=).
>: "maior que". É codificada para URL (%3E).
>=: "maior ou igual a". É codificada para URL (%3E=).
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 vai gerar o relatório. A atividade do usuário será exibida apenas 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 solicitação de acompanhamento 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 do aplicativo para o 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í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"
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.