Interfejs Reports API: raport o wykorzystaniu klientów

Raport dotyczący wykorzystania przez klientów zbiera informacje o korzystaniu z usługi Google Workspace przez wszystkich użytkowników w całej domenie. Raport o wykorzystaniu usług Google Workspace zawiera informacje o wykorzystaniu usług Google Workspace na całym koncie. Informacje o wykorzystaniu są uporządkowane według typu aplikacji, na który składają się parametry właściwe dla tej aplikacji. Domyślny i maksymalny okres dla każdego raportu to ostatnie 450 dni.

Tego raportu można używać tylko do celów zgodnych z przepisami i zgodnie z Umową klienta. Również te dotyczy tylko Google Workspace oraz Google Workspace for Education.

Pobieranie raportu dotyczącego wykorzystania przez klienta

Aby pobrać raport o aktywności na koncie, użyj tego żądania HTTP GET i dołącz token autoryzacji opisane w dokumentacji dotyczącej autoryzacji. Aby zapewnić czytelność, Ten przykład jest sformatowany przy użyciu funkcji zwracania wierszy: 

GET https://admin.googleapis.com/admin/reports/v1/usage/dates/yyyy-mm-dd date
?parameters=app name: usage parameter,...
&customerId=the customer's ID
&maxResults=number of events listed on each page of the report

Wartość dates to data użycia danych, a sygnatura czasowa jest w formacie ISO 8601 (rrrr-mm-dd). Zalecamy użycie w tym celu strefy czasowej konta. Więcej informacji o ciągach zapytań i właściwościach odpowiedzi w żądaniu znajdziesz w dokumentacji interfejsu API i dokumentacji parametrów raportów o wykorzystaniu przez klienta.

Poniższy przykład zawiera raport z łączną liczbą wszystkich udanych logowań na konto z ostatnich 30 dni oraz listę autoryzowanych aplikacji z liczbą autoryzacji użytkowników na aplikację, począwszy od 3.03.2013 r. maxResults ciąg zapytania wskazuje, że ten raport zwraca 2 zdarzenia na stronę raportu: 

GET https://admin.googleapis.com/admin/reports/v1/usage/dates/2013-03-03
?parameters=accounts:num_30day_logins%2Caccounts:authorized_apps&maxResults=2

Odpowiedź JSON dotycząca raportu na temat wykorzystania przez klienta

{
 "kind": "reports#usageReports",
 "warnings": [
    {
      "code": warning machine-readable code,
      "message": warning human-readable message,
      "data": [
        {
          "key": key for key-value pair that gives detailed warning information,
          "value": value for key-value pair giving detailed warning information
        }
      ]
    }
  ],
 "nextPageToken": "N:NNN:NNN:N:C03az79cb",
 "usageReports": [
  {
   "kind": "usageReport",
   "date": "2013-03-03",
   "entity": {
    "type": "CUSTOMER",
    "customerId": "C03az79cb"
   },
   "parameters": [
    {
     "name": "accounts:num_1day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_30day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_7day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_disabled_accounts",
     "intValue": "5"
    },
    {
     "name": "accounts:authorized_apps",
     "msgValue": [
      {
       "client_id": "1234.apps.googleusercontent.com",
       "client_name": "www.example.com",
       "num_users": 2
      },
      {
       "client_id": "4567.apps.googleusercontent.com",
       "client_name": "Example",
       "num_users": 1
      },
     ...
     ]
    }
   ]
  }
 ]
}