Method: userUsageReport.get

Ruft einen Bericht ab, der eine Sammlung von Properties und Statistiken für eine Gruppe von Nutzern des Kontos enthält. Weitere Informationen finden Sie im Leitfaden zur Nutzernutzung. Weitere Informationen zu den Parametern des Nutzerberichts finden Sie im Referenzhandbuch zur Nutzernutzung.

HTTP-Anfrage

GET https://admin.googleapis.com/admin/reports/v1/usage/users/{userKey or all}/dates/{date}

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
userKey or all

string

Die Profil-ID oder die E-Mail-Adresse des Nutzers, nach dem die Daten gefiltert werden sollen. Kann all für alle Informationen oder userKey für die eindeutige Google Workspace-Profil-ID eines Nutzers oder seine primäre E-Mail-Adresse sein. Darf kein gelöschter Nutzer sein. Rufen Sie für einen gelöschten Nutzer users.list in der Directory API mit showDeleted=true auf und verwenden Sie dann den zurückgegebenen ID als userKey.
date

string

Das Datum, an dem die Nutzung stattgefunden hat, basierend auf der Zeitzone UTC-8:00 (Pacific Standard Time). Der Zeitstempel hat das ISO 8601-Format: yyyy-mm-dd.

Abfrageparameter

Parameter
customerId

string

Die eindeutige ID des Kunden, für den Daten abgerufen werden sollen.
filters

string

Der Abfragestring filters ist eine durch Kommas getrennte Liste der Ereignisparameter einer Anwendung, bei der der Wert des Parameters durch einen relationalen Operator geändert wird. Der Abfragestring filters enthält den Namen der Anwendung, deren Nutzung im Bericht zurückgegeben wird. Die Anwendungswerte für den Nutzungsbericht für Nutzer umfassen accounts, docs und gmail.

Filter haben das Format [application name]:[parameter name][relational operator][parameter value],....

In diesem Beispiel hat der <>-Wert „not equal to“ ist im Abfragestring der Anfrage (%3C%3E) URL-codiert: 

GET
https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time
&filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z

Zu den relationalen Operatoren gehören:

  • == – "gleich".
  • <> – „ungleich“. Sie ist URL-codiert (%3C%3E).
  • < – „kleiner als“. Sie ist URL-codiert (%3C).
  • <= – „kleiner als oder gleich“. Sie ist URL-codiert (%3C=).
  • > – „größer als“. Sie ist URL-codiert (%3E).
  • >= – „größer als oder gleich“. Sie ist URL-codiert (%3E=).
maxResults

integer (uint32 format)

Legt fest, wie viele Aktivitätsdatensätze auf jeder Antwortseite angezeigt werden. Wenn in der Anfrage beispielsweise maxResults=1 festgelegt wird und der Bericht zwei Aktivitäten enthält, umfasst er zwei Seiten. Das Attribut nextPageToken der Antwort enthält das Token für die zweite Seite.
Der Abfragestring maxResults ist optional.
orgUnitID

string

ID der Organisationseinheit, für die der Bericht erstellt werden soll. Die Nutzeraktivität wird nur für Nutzer angezeigt, die zur angegebenen Organisationseinheit gehören.

pageToken

string

Token zum Angeben der nächsten Seite. Ein Bericht mit mehreren Seiten hat die Property nextPageToken in der Antwort. Geben Sie in Ihrer Folgeanfrage zum Abrufen der nächsten Seite des Berichts den Wert nextPageToken in den Abfragestring pageToken ein.
parameters

string

Der Abfragestring „parameters“ ist eine durch Kommas getrennte Liste von Ereignisparametern, mit denen die Ergebnisse eines Berichts optimiert werden. Der Parameter ist einer bestimmten Anwendung zugeordnet. Die Anwendungswerte für den Bericht zur Kundennutzung umfassen accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet und sites.
Ein parameters-Abfragestring hat das CSV-Format app_name1:param_name1, app_name2:param_name2.

groupIdFilter

string

Kommagetrennte Gruppen-IDs (verschleiert), nach denen Nutzeraktivitäten gefiltert werden. Das heißt, die Antwort enthält nur Aktivitäten für die Nutzer, die zu mindestens einer der hier genannten Gruppen-IDs gehören. Format: „id:abc123,id:xyz456“

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von UsageReports.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/admin.reports.usage.readonly

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.