REST Resource: customerUsageReports

Ressource: UsageReports

JSON-Darstellung
{
  "kind": string,
  "etag": string,
  "warnings": [
    {
      "code": string,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "usageReports": [
    {
      object (UsageReport)
    }
  ],
  "nextPageToken": string
}
Felder
kind

string

Der Typ der API-Ressource. Bei einem Nutzungsbericht ist der Wert admin#reports#usageReports.

etag

string

Das ETag der Ressource.

warnings[]

object

Warnungen, falls vorhanden.

warnings[].code

string

Maschinenlesbarer Code oder Warnungstyp. Der Wert des Warncodes lautet 200.

warnings[].message

string

Folgende Warnungen sind für Menschen lesbar:

  • Warnung „Daten nicht verfügbar“ - Entschuldigung, Daten für das Datum yyyy-mm-dd für die Anwendung „application name“ ist nicht verfügbar.
  • Warnung zu unvollständigen Daten – Daten für das Datum yyyy-mm-dd für die Anwendung „application name“ ist derzeit nicht verfügbar. Bitte versuchen Sie es in ein paar Stunden noch einmal.

warnings[].data[]

object

Schlüssel/Wert-Paare, um detaillierte Informationen zur Warnung anzuzeigen.

warnings[].data[].key

string

Schlüssel, der einem Schlüssel/Wert-Paar zugeordnet ist, um detaillierte Informationen zur Warnung anzuzeigen.

warnings[].data[].value

string

Wert, der einem Schlüssel/Wert-Paar zugeordnet ist, um detaillierte Informationen zur Warnung bereitzustellen.

usageReports[]

object (UsageReport)

Verschiedene Anwendungsparametereinträge.

nextPageToken

string

Token zum Angeben der nächsten Seite. Ein Bericht mit mehreren Seiten hat die Property nextPageToken in der Antwort. Geben Sie für Folgeanfragen, die alle Seiten des Berichts erhalten sollen, den Wert nextPageToken im Abfragestring pageToken ein.

UsageReport

JSON-Vorlage für einen Nutzungsbericht.

JSON-Darstellung
{
  "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
  }
}
Felder
kind

string

Der Typ der API-Ressource. Bei einem Nutzungsbericht ist der Wert admin#reports#usageReport.

date

string

Nur Ausgabe. Das Datum der Berichtsanfrage.

parameters[]

object

Nur Ausgabe. Parameterwerte für verschiedene Anwendungen. Informationen zu den Parametern und Werten des Berichts zur Entitätsnutzung finden Sie in der Referenz zu den Parametern zur Entitätsnutzung.

parameters[].intValue

string (int64 format)

Nur Ausgabe. Ganzzahlwert des Parameters.

parameters[].name

string

Name des Parameters. Die Parameternamen für den Bericht zur Nutzernutzung finden Sie in der Referenz zu Parametern für die Nutzernutzung.

parameters[].stringValue

string

Nur Ausgabe. Stringwert des Parameters.

parameters[].datetimeValue

string

Der Wert des Parameters in RFC 3339-Format, z. B. 2010-10-28T10:26:35.000Z.

parameters[].boolValue

boolean

Nur Ausgabe. Boolescher Wert des Parameters.

parameters[].msgValue[]

object (Struct format)

Nur Ausgabe. Verschachtelter Meldungswert des Parameters.

etag

string

Das ETag der Ressource.

entity

object

Nur Ausgabe. Informationen zum Elementtyp.

entity.customerId

string

Nur Ausgabe. Die eindeutige Kennung des Kundenkontos.

entity.userEmail

string

Nur Ausgabe. Die E-Mail-Adresse des Nutzers. Nur relevant, wenn entity.type = "NUTZER"

entity.profileId

string

Nur Ausgabe. Die unveränderliche Google Workspace-Profil-ID des Nutzers.

entity.entityId

string

Nur Ausgabe. Objektschlüssel. Nur relevant, wenn entity.type = "OBJECT" Hinweis: Der nach außen gerichtete Name des Berichts lautet „Entitäten“. und nicht auf „Objekte“.

entity.type

string

Nur Ausgabe. Der Elementtyp. Der Wert ist user.

Methoden

get

Ruft einen Bericht ab, der eine Sammlung von Eigenschaften und Statistiken für ein bestimmtes Kundenkonto enthält.