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 lisible par un ordinateur ou type d'avertissement. La valeur du code d'avertissement est 200.

warnings[].message

string

Voici les messages d'avertissement lisibles par l'humain:

  • Avertissement : Données non disponibles : données pour la date aaaa-mm-jj pour l'application "application name" n'est pas disponible.
  • Avertissement : Données partielles disponibles à la date aaaa-mm-jj pour l'application "application name" n'est pas disponible pour le moment. Veuillez réessayer dans quelques heures.

warnings[].data[]

object

Des 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 pour spécifier la page suivante. Un rapport comportant plusieurs pages comporte une propriété nextPageToken dans la réponse. Pour vos requêtes ultérieures obtenant toutes les pages du rapport, saisissez la valeur nextPageToken dans la chaîne de requête pageToken.

UsageReport

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 valeur/paramètre pour diverses applications. Pour en savoir plus sur les paramètres et les valeurs du rapport sur l'utilisation des entités, consultez la documentation 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 connaître les noms des paramètres du rapport sur l'utilisation des utilisateurs, consultez la documentation de référence sur les paramètres d'utilisation des utilisateurs.

parameters[].stringValue

string

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

parameters[].datetimeValue

string

Valeur du paramètre au format RFC 3339 (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 d'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. Pertinent uniquement si entity.type = "UTILISATEUR"

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. Pertinent uniquement si entity.type = "OBJECT" Remarque: Le nom du rapport (externe) est "Entities" (Entités). plutôt que sur des "objets".

entity.type

string

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

Méthodes

get

Récupère un rapport sous la forme d'un ensemble de propriétés et de statistiques pour le compte d'un client spécifique.