Reports API: Nutzungsbericht für Kunden

Im Bericht zur Kundennutzung werden Informationen zur Nutzung von Google Workspace-Diensten für alle Nutzer in einer gesamten Domain zusammengefasst. Der Bericht zur Nutzung enthält Informationen zur Nutzung von Google Workspace in Ihrem Konto. Diese Nutzungsinformationen sind nach Anwendungstyp organisiert und bestehen aus Parametern, die für diese Anwendung spezifisch sind. Der Standard- und der maximale Zeitraum für jeden Bericht sind die letzten 450 Tage.

Dieser Nutzungsbericht darf nur gemäß rechtmäßiger Zwecke gemäß Ihrer Kundenvereinbarung verwendet werden. Diese Berichte gelten auch für Google Workspace und Education.

Kundennutzungsbericht abrufen

Verwenden Sie die folgende GET-HTTP-Anfrage und fügen Sie das Autorisierungstoken hinzu, das in der Autorisierungsdokumentation beschrieben ist, um Ihre Kontoaktivitäten abzurufen. Zur besseren Lesbarkeit ist das folgende Beispiel 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 der Nutzung an und 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 der Referenz zu Parametern im Bericht zur Kundennutzung.

Im folgenden Beispiel sehen Sie einen Bericht mit allen erfolgreichen Anmeldungen in Ihrem Konto in den letzten 30 Tagen und einer Liste autorisierter Anwendungen mit der Anzahl der Nutzerautorisierungen pro Anwendung ab dem 03.03.2013. Der Abfragestring maxResults zeigt, dass dieser Bericht pro Berichtsseite zwei Ereignisse 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 den 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
      },
     ...
     ]
    }
   ]
  }
 ]
}