Reports API: Nutzernutzungsbericht

Der Bericht zur Nutzernutzung enthält Informationen zur Nutzung der Google Workspace-Dienste für einen bestimmten Nutzer in Ihrer Domain. Diese Berichte können nach bestimmten Nutzungsinformationen angepasst und gefiltert werden. Der standardmäßige und maximale Zeitraum für jeden Bericht umfasst die letzten 450 Tage.

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

Alle Nutzungsaktivitäten abrufen

Wenn Sie einen Bericht über alle Nutzeraktivitäten in Ihrem Konto abrufen möchten, verwenden Sie die folgende GET-HTTP-Anfrage und geben Sie das Autorisierungstoken an, das in der Dokumentation zur Autorisierung beschrieben wird. Das folgende Beispiel ist zur besseren Lesbarkeit mit Zeilenumbrüchen formatiert:

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/yyyy-mm-dd date
?parameters=application: user usage parameter,...
&filters=application: user usage parameter relational operator usage parameter's value,...
&maxResults=number of events listed on each page of the report

Der Wert dates gibt das Datum der Nutzung an. Der Zeitstempel hat das ISO 8601-Format, jjjj-mm-tt. Weitere Informationen zu den Abfragestringparametern und Antwortattributen finden Sie in der API-Referenz. Informationen zu den Parametern für den Bericht zur Nutzernutzung finden Sie in der Referenz zu den Parametern zur Nutzernutzung.

Im folgenden Beispiel wird ein Bericht über alle Nutzeraktivitäten für das Konto abgerufen.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all
/dates/2013-03-03?maxResults=2

Im folgenden Beispiel wird ein Bericht über alle Nutzeraktivitäten für ein bestimmtes Kundenkonto abgerufen.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all
/dates/2013-03-03?customerId=C03az79cb

Im folgenden Beispiel wird ein Bericht mit den Zeitstempeln der letzten Anmeldung der Nutzer im Konto abgerufen. Ein Beispiel für eine API-Antwort findest du im Beispiel für eine JSON-Antwort.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time&maxResults=2

Im folgenden Beispiel wird ein Bericht mit Zeitstempeln der letzten Anmeldung von Nutzern im Konto abgerufen, gefiltert nach Nutzern, die sich nach einem bestimmten Zeitpunkt angemeldet haben. Ein Beispiel für eine API-Antwort findest du im Beispiel für eine JSON-Antwort.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time&filters=accounts:last_login_time
>2010-10-28T10:26:35.000Z"

Im folgenden Beispiel wird ein Bericht über den Zeitstempel der letzten Anmeldung und den Sperrstatus der Nutzer im Konto abgerufen. Ein Beispiel für eine API-Antwort findest du im Beispiel für eine JSON-Antwort.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time,accounts:is_disabled"

Nutzungsaktivitäten eines bestimmten Nutzers abrufen

Wenn Sie einen Bericht über die Aktivitäten eines bestimmten Nutzers in Ihrem Konto abrufen möchten, verwenden Sie die folgende GET-HTTP-Anfrage und fügen Sie das Autorisierungstoken ein, wie in der Dokumentation zur Autorisierung beschrieben. Das folgende Beispiel ist zur besseren Lesbarkeit mit Zeilenumbrüchen formatiert.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/userKey/dates/yyyy-mm-dd date
?parameters=application: user usage parameter,...
&filters=application: user usage parameter relational operator usage parameter's value,...
&maxResults=number of events listed on each page of the report

Die userKey kann entweder die primäre E-Mail-Adresse des Nutzers im Bericht oder die eindeutige Google Workspace-profileId des Nutzers sein. Der Wert dates gibt das Datum der Nutzung an. Der Zeitstempel hat das ISO 8601-Format, jjjj-mm-tt. Weitere Informationen zu den Abfragestringparametern und Antwortattributen finden Sie in der API-Referenz. Informationen zu den Parametern für den Bericht zur Nutzernutzung finden Sie in der Referenz zu den Parametern zur Nutzernutzung.

Im folgenden Beispiel wird der Nutzungsbericht für johann@beispiel.de abgerufen.

https://admin.googleapis.com/admin/reports/v1/usage/users/john@example.com/dates/2013-03-03

Beispiel für eine JSON-Antwort für einen Nutzungsbericht

Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200 zurückgegeben. Zusammen mit dem Statuscode wird in der Antwort ein Bericht zurückgegeben.

JSON-Antwort für Nutzerbericht

{
 "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": "USER",
    "customerId": "C03az79cb",
    "userEmail": "liz@example.com",
    "profileId": "user's unique Google Workspace ID"
   },
   "parameters": [
    {
      "name": "accounts:is_disabled",
      "boolValue": false
     },
    {
     "name": "accounts:disabled_reason",
     "stringValue": "reason description"
    },
    {
     "name": "accounts:first_name",
     "stringValue": "Liz"
    },
    {
     "name": "accounts:is_2sv_enforced",
     "boolValue": false
    },
    {
     "name": "accounts:is_2sv_enrolled",
     "boolValue": false
    },
    {
     "name": "accounts:last_name",
     "stringValue": "Smith"
    },
    {
     "name": "accounts:creation_time",
     "datetimeValue": "2010-10-28T10:26:35.000Z"
    },
    {
     "name": "accounts:last_login_time",
     "datetimeValue": "1970-01-01T00:00:00.000Z"
    },
    {
     "name": "accounts:last_sso_time",
     "datetimeValue": "1970-01-01T00:00:00.000Z"
    }
   ]
  }
 ]
}