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 sur l'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 machine ou type d'avertissement. La valeur du code d'avertissement est 200.

warnings[].message

string

Les messages lisibles par l'utilisateur pour un avertissement sont les suivants:

  • Avertissement : Les données ne sont pas disponibles – Désolé, les données pour la date aaaa-mm-jj de l'application "application name" ne sont pas disponibles.
  • Avertissement : Des données partielles sont disponibles pour l'application "application name" à la date aaaa-mm-jj. Veuillez réessayer dans quelques heures.

warnings[].data[]

object

Paires clé-valeur fournissant 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 contient une propriété nextPageToken dans la réponse. Pour vos requêtes ultérieures qui récupèrent toutes les pages du rapport, saisissez la valeur nextPageToken dans la chaîne de requête pageToken.

UsageReport

Modèle JSON pour un rapport sur l'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 API. Pour un rapport sur l'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ètres 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 par les utilisateurs, consultez la documentation de référence sur les paramètres d'utilisation par les utilisateurs.

parameters[].stringValue

string

Uniquement en sortie. Valeur de la 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 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. Uniquement pertinent si entity.type = "USER"

entity.profileId

string

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

entity.entityId

string

Uniquement en sortie. Clé d'objet. Uniquement pertinent si entity.type = "OBJECT" Remarque: le nom externe du rapport est "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.