REST Resource: customerUsageReports

Recurso: UsageReports

Representación JSON
{
  "kind": string,
  "etag": string,
  "warnings": [
    {
      "code": string,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "usageReports": [
    {
      object (UsageReport)
    }
  ],
  "nextPageToken": string
}
Campos
kind

string

El tipo de recurso de la API. Para un informe de uso, el valor es admin#reports#usageReports.

etag

string

ETag del recurso.

warnings[]

object

Advertencias, si las hay

warnings[].code

string

Código legible por máquinas o tipo de advertencia El valor del código de advertencia es 200.

warnings[].message

string

Los mensajes legibles por humanos para una advertencia son los siguientes:

  • Advertencia de datos no disponibles: Lamentablemente, los datos de la fecha aaaa-mm-dd para la aplicación "application name" no están disponibles.
  • Advertencia de "datos parciales disponibles" - Los datos de la fecha aaaa-mm-dd para la aplicación "application name" no están disponibles en este momento. Vuelve a intentarlo después de unas horas.

warnings[].data[]

object

Son pares clave-valor que proporcionan información detallada sobre la advertencia.

warnings[].data[].key

string

Es la clave asociada con un par clave-valor para proporcionar información detallada sobre la advertencia.

warnings[].data[].value

string

Valor asociado con un par clave-valor para proporcionar información detallada sobre la advertencia.

usageReports[]

object (UsageReport)

Varios registros de parámetros de la aplicación

nextPageToken

string

Es un token para especificar la página siguiente. Un informe con varias páginas tiene una propiedad nextPageToken en la respuesta. Para las solicitudes posteriores que obtengan todas las páginas del informe, ingresa el valor nextPageToken en la cadena de consulta pageToken.

UsageReport

Plantilla JSON para un informe de uso.

Representación 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

El tipo de recurso de la API. Para un informe de uso, el valor es admin#reports#usageReport.

date

string

Solo salida. Es la fecha de la solicitud del informe.

parameters[]

object

Solo salida. Pares de valores de parámetros para varias aplicaciones. Para conocer los parámetros y valores del informe de uso de entidades, consulta la referencia de parámetros de uso de entidades.

parameters[].intValue

string (int64 format)

Solo salida. Es el valor entero del parámetro.

parameters[].name

string

El nombre del parámetro. Para obtener información sobre los nombres de los parámetros del informe de uso del usuario, consulta la referencia de los parámetros de uso del usuario.

parameters[].stringValue

string

Solo salida. Es el valor de cadena del parámetro.

parameters[].datetimeValue

string

Es el valor del parámetro con el formato RFC 3339, por ejemplo, 2010-10-28T10:26:35.000Z.

parameters[].boolValue

boolean

Solo salida. Es el valor booleano del parámetro.

parameters[].msgValue[]

object (Struct format)

Solo salida. Es el valor del mensaje anidado del parámetro.

etag

string

ETag del recurso.

entity

object

Solo salida. Información sobre el tipo de elemento.

entity.customerId

string

Solo salida. Es el identificador único de la cuenta del cliente.

entity.userEmail

string

Solo salida. La dirección de correo electrónico del usuario. Solo es relevante sientity.type = "USER"

entity.profileId

string

Solo salida. Es el identificador inmutable del perfil de Google Workspace del usuario.

entity.entityId

string

Solo salida. Clave de objeto. Solo es relevante si entity.type = "OBJECT". Nota: El nombre del informe para el público externo es "Entidades" en lugar de "Objetos".

entity.type

string

Solo salida. Es el tipo de elemento. El valor es user.

Métodos

get

Recupera un informe que es una colección de propiedades y estadísticas de la cuenta de un cliente específico.