Method: userUsageReport.get

Hiermit wird ein Bericht mit einer Sammlung von Properties und Statistiken für eine Gruppe von Nutzern im Konto abgerufen. Weitere Informationen finden Sie im Leitfaden zum Bericht zur Nutzernutzung. Weitere Informationen zu den Parametern des Nutzerberichts finden Sie in den Referenzhandbüchern zu Nutzungsparametern.

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

string

Stellt die Profil-ID oder die E-Mail-Adresse des Nutzers dar, für den die Daten gefiltert werden sollen. Kann all für alle Informationen oder userKey für die eindeutige Google Workspace-Profil-ID oder die primäre E-Mail-Adresse eines Nutzers sein. Der Nutzer darf nicht gelöscht worden 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 UTC-8:00 (Pacific Standard Time). Der Zeitstempel ist im 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 filters-Abfragestring ist eine durch Kommas getrennte Liste der Ereignisparameter einer Anwendung, bei der der Parameterwert durch einen relationalen Operator manipuliert wird. Der filters-Suchstring enthält den Namen der Anwendung, deren Nutzung im Bericht zurückgegeben wird. Zu den Anwendungswerten für den Bericht zur Nutzernutzung gehören accounts, docs und gmail.

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

In diesem Beispiel wird der <>-Operator „nicht gleich“ 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:

  • ==: „ist gleich“
  • <> – "nicht gleich". Sie ist URL-codiert (%3C%3E).
  • < – „kleiner als“. Es ist URL-codiert (%3C).
  • <= – „kleiner als oder gleich“. Es 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)

Damit wird festgelegt, wie viele Aktivitätseinträge 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 Berichte erstellt werden sollen. Nutzeraktivitäten werden nur für Nutzer angezeigt, die zur angegebenen Organisationseinheit gehören.

pageToken

string

Token, um die nächste Seite anzugeben. Ein Bericht mit mehreren Seiten enthält in der Antwort die Property nextPageToken. Geben Sie in der nachfolgenden Anfrage, mit der die nächste Seite des Berichts abgerufen wird, den Wert nextPageToken in den Abfragestring pageToken ein.
parameters

string

Der parameters-Abfragestring ist eine durch Kommas getrennte Liste von Ereignisparametern, mit denen die Ergebnisse eines Berichts verfeinert werden. Der Parameter ist einer bestimmten Anwendung zugeordnet. Zu den Anwendungswerten für den Bericht zur Kundennutzung gehören accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet und sites.
Ein parameters-Abfragestring ist im CSV-Format von app_name1:param_name1, app_name2:param_name2.

groupIdFilter

string

Kommagetrennte Gruppen-IDs (verschleiert), nach denen Nutzeraktivitäten gefiltert werden. Die Antwort enthält also nur Aktivitäten der 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.