Reports API: Kundennutzungsbericht

Im Nutzungsbericht des Kunden werden Informationen zur Nutzung des Google Workspace-Dienstes für alle Nutzer in der gesamten Domain zusammengefasst. Der Bericht zur Nutzernutzung enthält Informationen zur Nutzung der Google Workspace-Dienste in Ihrem Konto. Diese Nutzungsinformationen sind nach Anwendungstyp organisiert, der aus Parametern besteht, die für die jeweilige Anwendung spezifisch sind. Der standardmäßige und maximale Zeitraum für jeden Bericht umfasst die letzten 450 Tage.

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

Bericht zur Kundennutzung abrufen

Verwenden Sie die folgende GET-HTTP-Anfrage und geben Sie das Autorisierungstoken an, das in der Dokumentation zur Autorisierung beschrieben wird, um Berichte über Ihre Kontoaktivitäten abzurufen. Das folgende Beispiel ist zur besseren Lesbarkeit 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. Der Zeitstempel hat das ISO 8601-Format, jjjj-mm-tt. Wir empfehlen Ihnen, hierfür die Zeitzone Ihres Kontos zu verwenden. Weitere Informationen zu den Abfragestrings und Antwortattributen der Anfrage finden Sie in der API-Referenz und in der Referenz zu den Parametern des Kundennutzungsberichts.

Im folgenden Beispiel werden alle erfolgreichen Anmeldungen in Ihrem Konto in den letzten 30 Tagen und eine Liste autorisierter Anwendungen mit der Anzahl der Nutzerautorisierungen pro Anwendung ab dem 03.03.2013 angezeigt. Der Abfragestring maxResults gibt an, 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 auf 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
      },
     ...
     ]
    }
   ]
  }
 ]
}