REST Resource: customerUsageReports

Recurso: UsageReports

Representação JSON 
{
  "kind": string,
  "etag": string,
  "warnings": [
    {
      "code": string,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "usageReports": [
    {
      object (UsageReport)
    }
  ],
  "nextPageToken": string
}
Campos
kind

string

O tipo de recurso da API. Para um relatório de uso, o valor é admin#reports#usageReports.
etag

string

ETag do recurso.
warnings[]

object

Avisos, se houver.
warnings[].code

string

Código legível por máquina ou tipo de aviso. O valor do código de aviso é 200.
warnings[].message

string

As mensagens legíveis de um aviso são:

  • Aviso de dados não disponíveis - Os dados para a data aaaa-mm-dd para o aplicativo "application name" não estão disponíveis.
  • Alerta de dados parciais disponíveis: os dados da data yyyy-mm-dd para o aplicativo "application name" não estão disponíveis no momento. Tente novamente em algumas horas.

warnings[].data[]

object

Pares de chave-valor para fornecer informações detalhadas sobre o aviso.
warnings[].data[].key

string

Chave associada a um par de chave-valor para fornecer informações detalhadas sobre o aviso.
warnings[].data[].value

string

Valor associado a um par de chave-valor para fornecer informações detalhadas sobre o aviso.
usageReports[]

object (UsageReport)

Vários registros de parâmetros do aplicativo.
nextPageToken

string

Token para especificar a próxima página. Um relatório com várias páginas tem uma propriedade nextPageToken na resposta. Para as solicitações subsequentes que recebem todas as páginas do relatório, insira o valor nextPageToken na string de consulta pageToken.

UsageReport

Modelo JSON para um relatório de uso.

Representação JSON 
{
  "kind": string,
  "date": string,
  "parameters": [
    {
      "intValue": string,
      "name": string,
      "stringValue": string,
      "datetimeValue": string,
      "boolValue": boolean,
      "msgValue": [
        {
          object
        }
      ]
    }
  ],
  "etag": string,
  "entity": {
    "customerId": string,
    "userEmail": string,
    "profileId": string,
    "entityId": string,
    "type": string
  }
}
Campos
kind

string

O tipo de recurso da API. Para um relatório de uso, o valor é admin#reports#usageReport.
date

string

Apenas saída. A data da solicitação de denúncia.
parameters[]

object

Apenas saída. Pares de valores de parâmetro para vários aplicativos. Para conferir os parâmetros e valores do relatório de uso da entidade, consulte a referência de parâmetros de uso da entidade.
parameters[].intValue

string (int64 format)

Apenas saída. Valor inteiro do parâmetro.
parameters[].name

string

O nome do parâmetro. Para conferir os nomes dos parâmetros do relatório de uso do usuário, consulte a Referência dos parâmetros de uso do usuário.
parameters[].stringValue

string

Apenas saída. Valor de string do parâmetro.
parameters[].datetimeValue

string

O valor formatado do parâmetro no RFC 3339, por exemplo, 2010-10-28T10:26:35.000Z.
parameters[].boolValue

boolean

Apenas saída. Valor booleano do parâmetro.
parameters[].msgValue[]

object (Struct format)

Apenas saída. Valor da mensagem aninhada do parâmetro.
etag

string

ETag do recurso.
entity

object

Apenas saída. Informações sobre o tipo do item.
entity.customerId

string

Apenas saída. O identificador exclusivo da conta do cliente.
entity.userEmail

string

Apenas saída. O endereço de e-mail do usuário. Relevante apenas se entity.type = "USER"
entity.profileId

string

Apenas saída. O identificador de perfil imutável do Google Workspace do usuário.
entity.entityId

string

Apenas saída. Chave do objeto. Relevante apenas se entity.type = "OBJECT". Observação: o nome externo do relatório é "Entities", e não "Objects".
entity.type

string

Apenas saída. O tipo de item. O valor é user.

Métodos

get

 Recupera um relatório, que é uma coleção de propriedades e estatísticas da conta de um cliente específico.