Reports API: Kundennutzungsbericht

Bericht „Kundennutzung“ werden Informationen zur Nutzung des Google Workspace-Dienstes für alle Nutzer in der gesamten Domain aggregiert. Im Bericht zur Nutzernutzung werden Informationen zur Nutzung des Google Workspace-Dienstes in Ihrem Konto angezeigt. Die Nutzungsinformationen sind nach Anwendungstyp geordnet, der sich aus spezifischen Parametern für die jeweilige Anwendung zusammensetzt. Der standardmäßige und maximale Zeitraum für jeden Bericht umfasst die letzten 450 Tage.

Dieser Nutzungsbericht darf nur zu rechtmäßigen Zwecken gemäß Ihrer Kundenvereinbarung verwendet werden. Diese Berichte gelten für Google Workspace und Education.

Nutzungsbericht für Kunden abrufen

Verwende die folgende GET-HTTP-Anfrage und füge das Autorisierungstoken hinzu, um einen Bericht zu deinen Kontoaktivitäten abzurufen wie in der Dokumentation zur Autorisierung beschrieben. Zur besseren Lesbarkeit Das folgende Beispiel wurde mit Zeilenumbrüchen formatiert: 

GET https://admin.googleapis.com/admin/reports/v1/usage/dates/yyyy-mm-dd date
?parameters=app name: usage parameter,...
&customerId=the customer's ID
&maxResults=number of events listed on each page of the report

Der Wert dates gibt das Datum an, an dem die Nutzung stattfand. Der Zeitstempel hat das ISO 8601-Format jjjj-mm-tt. Wir empfehlen, hierfür die Zeitzone Ihres Kontos zu verwenden. Weitere Informationen zu Abfragestrings und Antworteigenschaften der Anfrage finden Sie in der API-Referenz und in der Referenz zu den Parametern für Berichte zur Kundennutzung.

Im folgenden Beispiel wird ein Bericht mit der Gesamtzahl aller erfolgreichen Anmeldungen in Ihrem Konto der letzten 30 Tage sowie eine Liste erstellt autorisierter Anwendungen mit der Anzahl der Nutzerautorisierungen pro Anwendung seit 03.03.2013. Das maxResults Abfragestring zeigt, dass dieser Bericht zwei Ereignisse pro Berichtsseite zurückgibt: 

GET https://admin.googleapis.com/admin/reports/v1/usage/dates/2013-03-03
?parameters=accounts:num_30day_logins%2Caccounts:authorized_apps&maxResults=2

JSON-Antwort für Bericht zur Kundennutzung

{
 "kind": "reports#usageReports",
 "warnings": [
    {
      "code": warning machine-readable code,
      "message": warning human-readable message,
      "data": [
        {
          "key": key for key-value pair that gives detailed warning information,
          "value": value for key-value pair giving detailed warning information
        }
      ]
    }
  ],
 "nextPageToken": "N:NNN:NNN:N:C03az79cb",
 "usageReports": [
  {
   "kind": "usageReport",
   "date": "2013-03-03",
   "entity": {
    "type": "CUSTOMER",
    "customerId": "C03az79cb"
   },
   "parameters": [
    {
     "name": "accounts:num_1day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_30day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_7day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_disabled_accounts",
     "intValue": "5"
    },
    {
     "name": "accounts:authorized_apps",
     "msgValue": [
      {
       "client_id": "1234.apps.googleusercontent.com",
       "client_name": "www.example.com",
       "num_users": 2
      },
      {
       "client_id": "4567.apps.googleusercontent.com",
       "client_name": "Example",
       "num_users": 1
      },
     ...
     ]
    }
   ]
  }
 ]
}