REST Resource: customerUsageReports

Ressource: UsageReports

Représentation JSON
{
  "kind": string,
  "etag": string,
  "warnings": [
    {
      "code": string,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "usageReports": [
    {
      object (UsageReport)
    }
  ],
  "nextPageToken": string
}
Champs
kind

string

Type de ressource d'API. Pour un rapport d'utilisation, la valeur est admin#reports#usageReports.

etag

string

ETag de la ressource.

warnings[]

object

Avertissements, le cas échéant.

warnings[].code

string

Code ou type d'avertissement lisible par un ordinateur. La valeur du code d'avertissement est 200.

warnings[].message

string

Voici les messages lisibles d'un avertissement:

  • Avertissement Les données ne sont pas disponibles - Les données datent du aaaa-mm-jj pour l'application application name ne sont pas disponibles.
  • Avertissement de données partielles disponibles - Les données de la date aaaa-mm-jj pour l'application "application name" ne sont pas disponibles pour l'instant. Veuillez réessayer dans quelques heures.

warnings[].data[]

object

Paires clé-valeur pour fournir des informations détaillées sur l'avertissement.

warnings[].data[].key

string

Clé associée à une paire clé-valeur pour fournir des informations détaillées sur l'avertissement.

warnings[].data[].value

string

Valeur associée à une paire clé-valeur pour fournir des informations détaillées sur l'avertissement.

usageReports[]

object (UsageReport)

Divers enregistrements de paramètres d'application.

nextPageToken

string

Jeton permettant de spécifier la page suivante. Un rapport comportant plusieurs pages comporte une propriété nextPageToken dans la réponse. Pour les requêtes consécutives qui obtiennent toutes les pages du rapport, saisissez la valeur nextPageToken dans la chaîne de requête pageToken.

Rapport d'utilisation

Modèle JSON pour un rapport d'utilisation.

Représentation 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
  }
}
Champs
kind

string

Type de ressource d'API. Pour un rapport d'utilisation, la valeur est admin#reports#usageReport.

date

string

Uniquement en sortie. Date de la demande de rapport.

parameters[]

object

Uniquement en sortie. Paires de valeurs de paramètre pour différentes applications. Pour les valeurs et les paramètres du rapport d'utilisation des entités, consultez le document de référence sur les paramètres d'utilisation des entités.

parameters[].intValue

string (int64 format)

Uniquement en sortie. Valeur entière du paramètre.

parameters[].name

string

Nom du paramètre. Pour en savoir plus sur les noms des paramètres du rapport d'utilisation, consultez la documentation de référence sur les paramètres d'utilisation utilisateur.

parameters[].stringValue

string

Uniquement en sortie. Valeur de chaîne du paramètre.

parameters[].datetimeValue

string

Valeur au format RFC 3339 du paramètre, par exemple 2010-10-28T10:26:35.000Z.

parameters[].boolValue

boolean

Uniquement en sortie. Valeur booléenne du paramètre.

parameters[].msgValue[]

object (Struct format)

Uniquement en sortie. Valeur du message imbriqué du paramètre.

etag

string

ETag de la ressource.

entity

object

Uniquement en sortie. Informations sur le type de l'article.

entity.customerId

string

Uniquement en sortie. Identifiant unique du compte du client.

entity.userEmail

string

Uniquement en sortie. Adresse e-mail de l'utilisateur. Uniquement pertinent si entité.type = "USER"

entity.profileId

string

Uniquement en sortie. Identifiant de profil Google Workspace immuable de l'utilisateur.

entity.entityId

string

Uniquement en sortie. Clé de l'objet. Uniquement pertinent si "entity.type" est "OBJECT". Remarque: le nom externe du rapport est de type "Entités" et non "Objets".

entity.type

string

Uniquement en sortie. Type d'élément. La valeur est de user.

Méthodes

get

Récupère un rapport, qui est un ensemble de propriétés et de statistiques pour le compte d'un client spécifique.