Method: entityUsageReports.get

Hiermit wird ein Bericht mit einer Sammlung von Properties und Statistiken für Entitäten abgerufen, die von Nutzern im Konto verwendet werden. Weitere Informationen finden Sie im Leitfaden zum Bericht zur Entitätennutzung. Weitere Informationen zu den Parametern des Berichts zu Entitäten finden Sie in den Referenzhandbüchern zu Parametern zur Entitätsnutzung.

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

Der Schlüssel des Objekts, mit dem die Daten gefiltert werden sollen. Es ist ein String, der den Wert all haben kann, um Aktivitätsereignisse für alle Nutzer oder einen beliebigen anderen Wert für ein app-spezifisches Element abzurufen. Weitere Informationen dazu, wie Sie die entityKey für eine bestimmte entityType abrufen, finden Sie in den Referenzhandbüchern zu Nutzungsparametern für Entitäten.
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 Entitätsnutzung 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/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:

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

integer (uint32 format)

Damit wird festgelegt, wie viele Aktivitätseinträge auf jeder Antwortseite angezeigt werden. Wenn in der Anfrage beispielsweise <span>maxResults=1</span> festgelegt ist und der Bericht zwei Aktivitäten enthält, hat er zwei Seiten. Die <span>nextPageToken</span>-Eigenschaft der Antwort enthält das Token für die zweite Seite.
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

Die parameters-Abfragezeichenfolge ist eine durch Kommas getrennte Liste von Ereignisparametern, mit denen die Ergebnisse eines Berichts verfeinert werden. Der Parameter ist einer bestimmten Anwendung zugeordnet. Die Anwendungswerte für den Bericht zur Entitätsnutzung sind nur gplus.
Ein parameter-Abfragestring ist im CSV-Format von [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 Hier finden Sie einen Bericht zu Google+-Communitys.