Reports API: Nutzungsbericht zu Entitäten

Im Bericht zur Nutzung von Entitäten werden Google Workspace-Dienstaktivitäten zurückgegeben, die mit Entitäten zusammenhängen die von den Nutzern Ihres Kontos verwendet werden. Diese Berichte können für bestimmte Anwendungsfälle angepasst und gefiltert werden. Informationen. Es sind Daten für die letzten 30 Tage verfügbar.

Der Bericht zur Nutzung von Entitäten darf nur für rechtmäßige Zwecke in gemäß Ihrer Kundenvereinbarung erfolgen. Diese Berichte gelten auch für Google Workspace und Education

Alle Nutzungsaktivitäten für Entitäten abrufen

Derzeit werden nur Google+ Communitys von dieser API unterstützt. So rufen Sie eine Bericht aller Aktivitäten im Zusammenhang mit App-Entitäten in Ihrem Konto enthalten, verwenden Sie GET-HTTP-Anfrage senden und das Autorisierungstoken angeben, das im Dokumentation zur Autorisierung. Für 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 an, an dem die Nutzung stattgefunden hat, und der Zeitstempel befindet sich in der ISO 8601-Format, jjjj-mm-tt. Wir empfehlen Ihnen, Verwenden Sie hierfür die Zeitzone Ihres Kontos. Weitere Informationen zu Abfragestringparametern und finden Sie in der API Referenz. Informationen zu den Parametern für den Bericht zur Entitätsnutzung finden Sie in der Parameter für die Nutzung von Entitäten Referenz.

applicationParameters ist eine durch Kommas getrennte Liste von Parametern, die Sie abrufen möchten. Jeder Parameter hat das Format application:parameter_name, z. B.: gplus:community_name. Die verfügbaren Parameter sind in der Parameter für die Entitätsnutzung Referenz. 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. Jedes Filter ist formatiert als application:parameter_name[relational_operator]parameter_value Beispiel: Der Parameter Filter gplus:num_total_members>100 filtert die Ergebnisse so, dass sie nur Ergebnisse enthalten Dabei hat der Parameter gplus:num_total_members einen Wert größer als 100.

maxResults ist die maximale Anzahl der Ergebnisse, die in einem einzelnen Abruf zurückgegeben werden sollen. Wenn die Summe Anzahl der Ergebnisse größer als dieser Wert ist, wird die Antwort abgeschnitten und nextPageToken werden eingeschlossen (siehe Beispiel für eine JSON-Antwort unten).

Beispiele

Im folgenden Beispiel wird ein Bericht abgerufen, der alle Parameter enthält für alle gplus_communities-Entitäten.

GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all
/dates/2017-12-11

Im folgenden Beispiel wird ein Bericht mit dem Parameter community_name abgerufen für alle gplus_communities-Entitäten.

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 von community_name und num_total_members für jede gplus_communities-Entität, gefiltert nach Communitys mit mehr als 100 Mitgliedern. Ein Beispiel für eine API-Antwort finden Sie in der 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

GET https://admin.googleapis.com/admin/reports/v1/gplus_communities/entityKey/dates/date
?parameters=applicationParameters
&filters=parameterFilters
&maxResults=maxResults

https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/1234/dates/2017-12-11

{
 "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
    },
   ]
  }
 ]
}

{
 "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": [],
}