Der Nutzungsbericht zu Entitäten gibt Google Workspace-Dienstaktivitäten für Entitäten zurück, die von den Nutzern Ihres Kontos verwendet werden. Diese Berichte können angepasst und nach bestimmten Nutzungsinformationen gefiltert werden. Es sind Daten für die letzten 30 Tage verfügbar.
Der Nutzungsbericht zur Rechtspersönlichkeit darf gemäß Ihrer Kundenvereinbarung nur für rechtmäßige Zwecke verwendet werden. Diese Berichte gelten auch für Google Workspace und Education.
Alle Nutzungsaktivitäten von Entitäten abrufen
Derzeit ist Google+ Communities der einzige von dieser API unterstützte Entitätstyp. Verwenden Sie die folgende GET-HTTP-Anfrage und fügen Sie das in der Autorisierungsdokumentation beschriebene Autorisierungstoken ein, um einen Bericht zu allen Aktivitäten in Bezug auf Anwendungsentitäten in Ihrem Konto abzurufen. Zur besseren Lesbarkeit ist das folgende Beispiel mit Zeilenumbrüchen formatiert:
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/date ?parameters=applicationParameters &filters=parameterFilters &maxResults=maxResults
Der Wert date gibt das Datum der Nutzung an und der Zeitstempel hat das ISO 8601-Format, jjjj-mm-tt. Wir empfehlen, hierfür die Zeitzone Ihres Kontos zu verwenden. Weitere Informationen zu Abfragestringparametern und Antwortattributen finden Sie in der API-Referenz. Informationen zu den Parametern des Berichts zur Entitätennutzung finden Sie in der Referenz zu Entitätennutzungsparametern.
applicationParameters ist eine durch Kommas getrennte Liste der Parameter, die Sie abrufen möchten.
Jeder Parameter ist als application:parameter_name formatiert, z. B. gplus:community_name. Die verfügbaren Parameter sind in der Referenz zu Entitätennutzungsparametern dokumentiert. Wenn keine Parameter angegeben sind, werden alle zurückgegeben.
parameterFilters ist eine durch Kommas getrennte Liste von Filtern, die auf die Ergebnisse angewendet werden sollen. Jeder Filter ist als application:parameter_name[relational_operator]parameter_value formatiert. Der Filter gplus:num_total_members>100 filtert beispielsweise die Ergebnisse so, dass nur Ergebnisse angezeigt werden, bei denen der Parameter gplus:num_total_members einen Wert größer als 100 hat.
maxResults ist die maximale Anzahl der Ergebnisse, die in einem einzelnen Abruf zurückgegeben werden. Wenn die Gesamtzahl der Ergebnisse größer ist, wird die Antwort abgeschnitten und nextPageToken zurückgegeben (siehe JSON-Antwortbeispiel unten).
Beispiele
Im folgenden Beispiel wird ein Bericht abgerufen, der alle Parameter für alle gplus_communities-Entitäten enthält.
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all /dates/2017-12-11
Im folgenden Beispiel wird ein Bericht abgerufen, der den Parameter community_name für alle gplus_communities-Entitäten enthält.
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all /dates/2017-12-11?parameters=gplus:community_name
Im folgenden Beispiel wird für jede gplus_communities-Entität ein Bericht zu community_name und num_total_members abgerufen, der nach Communities mit mehr als 100 Mitgliedern gefiltert ist. Ein Beispiel für eine API-Antwort findest du im Beispiel für eine JSON-Antwort.
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-11 ?parameters=gplus:community_name,gplus:num_total_members&filters=gplus:num_total_members>100
Bericht für eine bestimmte Entität abrufen
Wenn Sie einen Bericht für eine bestimmte Entität abrufen möchten, verwenden Sie die folgende GET-HTTP-Anfrage und fügen Sie das in der Autorisierungsdokumentation beschriebene Autorisierungstoken ein. Zur besseren Lesbarkeit ist das folgende Beispiel mit Zeilenumbrüchen formatiert.
GET https://admin.googleapis.com/admin/reports/v1/gplus_communities/entityKey/dates/date ?parameters=applicationParameters &filters=parameterFilters &maxResults=maxResults
entityKey ist eine Entitätskennung, die für die Anwendung spezifisch ist, in der sich die Entität befindet. Weitere Informationen zum Abrufen der entityKey für eine bestimmte Entität finden Sie in der API-Referenz. Die anderen Parameter sind oben unter Alle Aktivitäten zur Entitätennutzung abrufen dokumentiert.
Weitere Informationen zu den Abfragestringparametern und -eigenschaften finden Sie in der API-Referenz. Informationen zu den Parametern des Berichts zur Entitätennutzung finden Sie in der Referenz zu Entitätennutzungsparametern.
Beispiele
Im folgenden Beispiel wird der Entitätsbericht für eine gplus_community-Entität mit der entityKey "1234" abgerufen.
https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/1234/dates/2017-12-11
JSON-Antwortvorlage für Nutzungsbericht
Eine erfolgreiche Antwort gibt einen HTTP 200-Statuscode zurück. Zusammen mit dem Statuscode gibt die Antwort einen Bericht zurück. Einige Parameter in der Antwort wurden zur besseren Lesbarkeit weggelassen.
Beispiel für eine JSON-Antwort im Bericht zu Entitäten
{
"kind": "reports#usageReports",
"nextPageToken": "NjQ1OTgwODk0MzkxNDAwNjQ0OA",
"usageReports": [
{
"kind": "admin#reports#usageReport",
"date": "2017-12-11",
"entity": {
"type": "OBJECT",
"customerId": "C03az79cb",
"objectType": "GPLUS_COMMUNITY",
"objectId": "1234",
},
"parameters": [
{
"name": "gplus:community_name",
"stringValue": "My Community"
},
{
"name": "gplus:num_total_members",
"intValue": 37
},
{
"name": "gplus:num_7day_active_members",
"intValue": 12
},
{
"name": "gplus:num_30day_active_members",
"intValue": 17
},
]
}
]
}
Beispiel für eine JSON-Antwort mit einem Entitätsbericht mit Warnungen
In der Antwort kann eine oder mehrere Warnungen zurückgegeben werden, wenn die Anfrage nicht ausgeführt werden kann. In diesem Beispiel ist der Bericht zum Zeitpunkt der Anfrage nicht verfügbar.{
"kind": "reports#usageReports",
"warnings": [
{
"code": "PARTIAL_DATA_AVAILABLE"
"message": "Data for date 2017-12-11 for application gplus is not available right now, please try again after a few hours."
"data": [
{
"key": "date"
"value": "2017-12-11"
}
]
}
],
"usageReports": [],
}
Jeder Eintrag im Array warnings hat die folgenden Parameter:
code: maschinenlesbarer Warncodemessage: menschenlesbare Warnmeldungdata: Liste von Schlüssel/Wert-Paaren, die detaillierte Warnungen enthalten