Method: entityUsageReports.get

Ruft einen Bericht ab, bei dem es sich um eine Sammlung von Properties und Statistiken zu Entitäten handelt, die von Nutzern im Konto verwendet werden. Weitere Informationen finden Sie im Leitfaden zur Nutzung von Entitäten. Weitere Informationen zu den Parametern des Berichts zu Entitäten finden Sie in den Referenzleitfäden zu Parameter für die Entitätennutzung.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
entityType

enum (EntityType)

Der Entitätstyp für den Bericht.
entityKey or all

string

Stellt den Schlüssel des Objekts dar, mit dem die Daten gefiltert werden sollen. Es ist ein String, der den Wert all verwenden kann, um Aktivitätsereignisse für alle Nutzer abzurufen, oder einen anderen Wert für eine App-spezifische Entität. Weitere Informationen dazu, wie Sie den entityKey für eine bestimmte entityType abrufen, finden Sie in den Referenzleitfäden zu Entitätsnutzungsparametern.
date

string

Das Datum, an dem die Nutzung stattgefunden hat, basierend auf 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 denen der Wert des Parameters mit einem 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 zu Entitäten umfassen accounts, docs und gmail.

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

In diesem Beispiel ist der <>-Operator "nicht gleich" im Abfragestring der Anfrage (%3C%3E) URL-codiert: 

GET
https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-01
?parameters=gplus:community_name,gplus:num_total_members
&filters=gplus:num_total_members%3C%3E0

Zu den relationalen Operatoren gehören:

  • ==: „gleich“.
  • <>: "nicht gleich". Die Datei ist URL-codiert (%3C%3E).
  • <: „kleiner als“. Es ist URL-codiert (%3C).
  • <=: „kleiner als oder gleich“. Die Datei ist URL-codiert (%3C=).
  • >: „größer als“. Es ist URL-codiert (%3E).
  • >=: „größer als oder gleich“. Die Datei ist URL-codiert (%3E=).
Filter können nur auf numerische Parameter angewendet werden.
maxResults

integer (uint32 format)

Legt fest, wie viele Aktivitätsdatensätze auf jeder Antwortseite angezeigt werden. Wenn in der Anfrage beispielsweise <span>maxResults=1</span> festgelegt wird und der Bericht zwei Aktivitäten enthält, hat er zwei Seiten. Das Attribut <span>nextPageToken</span> der Antwort hat das Token für die zweite Seite.
pageToken

string

Token zur Angabe der nächsten Seite. Ein Bericht mit mehreren Seiten enthält die Property nextPageToken in der Antwort. Geben Sie in der 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 können. Der Parameter ist einer bestimmten Anwendung zugeordnet. Die Anwendungswerte für den Bericht zur Entitätennutzung sind nur gplus.
Ein parameter-Abfragestring hat das CSV-Format [app_name1:param_name1], [app_name2:param_name2]....

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.

EntityType

Enums
gplus_communities Gibt einen Bericht zu Google+ Communities zurück.