Der Nutzungsbericht zu Entitäten gibt Google Workspace-Dienstaktivitäten im Zusammenhang mit Entitäten zurück, die von den Nutzern Ihres Kontos verwendet werden. Diese Berichte können nach bestimmten Nutzungsinformationen angepasst und gefiltert werden. Es sind Daten für die letzten 30 Tage verfügbar.
Der Nutzungsbericht zu Rechtspersönlichkeiten darf nur zu rechtmäßigen Zwecken gemäß Ihrer Kundenvereinbarung verwendet werden. Diese Berichte gelten auch für Google Workspace und Education.
Alle Nutzungsaktivitäten für Entitäten abrufen
Derzeit werden von dieser API nur Google+ Communities unterstützt. Wenn Sie einen Bericht über alle Aktivitäten im Zusammenhang mit Anwendungsentitäten in Ihrem Konto abrufen möchten, verwenden Sie die folgende GET-HTTP-Anfrage und fügen Sie das Autorisierungstoken ein, das in der Dokumentation zur Autorisierung beschrieben wird. Das folgende Beispiel ist zur besseren Lesbarkeit 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. Der Zeitstempel hat das ISO 8601-Format, jjjj-mm-tt. Wir empfehlen Ihnen, dafür die Zeitzone Ihres Kontos zu verwenden. Weitere Informationen zu den Abfragestringparametern und Antwortattributen finden Sie in der API-Referenz. Informationen zu den Parametern des Berichts zur Nutzung von Entitäten finden Sie in der Referenz zu Nutzungsparametern von Entitäten.
applicationParameters ist eine durch Kommas getrennte Liste von Parametern, 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 Nutzungsparametern von Entitäten 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. Beispielsweise filtert der Filter gplus:num_total_members>100 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 sollen. Ist die Gesamtzahl der Ergebnisse größer, wird die Antwort abgeschnitten und ein nextPageToken eingefügt (siehe Beispiel für JSON-Antwort 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 ein Bericht mit community_name und num_total_members für jede gplus_communities-Entität abgerufen, gefiltert nach Communities mit mehr als 100 Mitgliedern. 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
Verwenden Sie die folgende GET-HTTP-Anfrage und fügen Sie das in der Dokumentation zur Autorisierung beschriebene Autorisierungstoken ein, um einen Bericht für eine bestimmte Entität abzurufen. Das folgende Beispiel ist zur besseren Lesbarkeit mit Zeilenumbrüchen formatiert.
GET https://admin.googleapis.com/admin/reports/v1/gplus_communities/entityKey/dates/date ?parameters=applicationParameters &filters=parameterFilters &maxResults=maxResults
Die entityKey ist eine Entitäts-ID, die für die Anwendung spezifisch ist, in der sich die Entität befindet. In der API-Referenz erfahren Sie, wie Sie den entityKey für die Entität abrufen, an der Sie interessiert sind. Die anderen Parameter sind oben unter Nutzungsaktivitäten aller Entitäten abrufen dokumentiert.
Weitere Informationen zu den Abfragestringparametern und Antwortattributen finden Sie in der API-Referenz. Informationen zu den Parametern des Berichts zur Nutzung von Entitäten finden Sie in der Referenz zu Nutzungsparametern von Entitäten.
Beispiele
Im folgenden Beispiel wird der Entitätsbericht für eine gplus_community-Entität mit dem entityKey „1234“ abgerufen.
https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/1234/dates/2017-12-11
Beispiel für eine JSON-Antwort für einen Nutzungsbericht
Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200 zurückgegeben. Zusammen mit dem Statuscode wird in der Antwort ein Bericht zurückgegeben. Einige Parameter in der Antwort wurden zur besseren Lesbarkeit weggelassen.
Beispiel für eine JSON-Antwort für einen Entitätenbericht
{
"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 für einen Entitätenbericht mit Warnungen
Wenn die Anfrage nicht ausgeführt werden kann, werden in der Antwort möglicherweise eine oder mehrere Warnungen zurückgegeben. 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: visuell lesbare Warnmeldungdata: Liste der Schlüssel/Wert-Paare, die detaillierte Warninformationen liefern