Recupera um relatório, que é uma coleção de propriedades e estatísticas de entidades usadas pelos usuários na conta. Para mais informações, consulte o guia do Relatório de uso de entidades. Para mais informações sobre os parâmetros do relatório de entidades, consulte os guias de referência Parâmetros de uso de entidades.
Solicitação HTTP
GET https://admin.googleapis.com/admin/reports/v1/usage/{entityType}/{entityKey or all}/dates/{date}
Representa a chave do objeto para filtrar os dados. É uma string que pode receber o valor all para receber eventos de atividade de todos os usuários ou qualquer outro valor para uma entidade específica do app. Para ver detalhes sobre como acessar o entityKey de um entityType específico, consulte os guias de referência dos Parâmetros de uso de entidades.
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 entidades 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 em URL na string de consulta da solicitação (%3C%3E):
GET
https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-01
?parameters=gplus:community_name,gplus:num_total_members
&filters=gplus:num_total_members%3C%3E0
Os operadores relacionais incluem:
==: "igual a".
<>: "não é igual a". Ele é codificado em URL (%3C%3E).
<: "menor que". Ele é codificado em URL (%3C).
<=: "menor que ou igual a". Ele é codificado em URL (%3C=).
>: "maior que". Ele é codificado em URL (%3E).
>=: "maior que ou igual a". Ele é codificado em URL (%3E=).
Os filtros só podem ser aplicados a parâmetros numéricos.
Determina quantos registros de atividade são mostrados em cada página de resposta. Por exemplo, se a solicitação definir <span>maxResults=1</span> e o relatório tiver duas atividades, ele terá duas páginas. A propriedade <span>nextPageToken</span> da resposta tem o token para a segunda página.
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 de parâmetros de evento separados por vírgulas 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 de entidades são apenas gplus. Uma string de consulta parameter está no formato CSV de [app_name1:param_name1],
[app_name2:param_name2]....
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.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Não contém as informações de que eu preciso","missingTheInformationINeed","thumb-down"],["Muito complicado / etapas demais","tooComplicatedTooManySteps","thumb-down"],["Desatualizado","outOfDate","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Problema com as amostras / o código","samplesCodeIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2024-11-09 UTC."],[[["Retrieves properties and statistics for entities used within a Google Workspace account."],["Allows filtering by entity type, entity key, and date."],["Data can be refined using query parameters like `customerId`, `filters`, and `parameters`."],["Requires the `https://www.googleapis.com/auth/admin.reports.usage.readonly` authorization scope."],["Currently supports Google+ communities as an entity type."]]],[]]
