Method: entityUsageReports.get

enum (EntityType)

Representa o tipo de entidade do relatório.

string

Representa a chave do objeto com o qual filtrar os dados. É uma string que pode usar 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.

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.

string

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

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, 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/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 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=).

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.

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.

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]....