Method: entityUsageReports.get

Recupera um relatório, que é um conjunto 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}

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
entityType

enum (EntityType)

Representa o tipo de entidade do relatório.
entityKey or all

string

Representa a chave do objeto com o qual os dados serão filtrados. É uma string que pode receber o valor all para receber eventos de atividade para todos os usuários ou qualquer outro valor para uma entidade específica do app. Para ver detalhes sobre como conseguir o entityKey de uma entityType específica, 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 de aplicativo do 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 para 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'.
  • <>: "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=).
Os filtros só podem ser aplicados a parâmetros numéricos.
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 <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 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 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.

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.

EntityType

Enums
gplus_communities Retorna um relatório sobre as Comunidades do Google+.