Interfejs Reports API: raport o wykorzystaniu użytkowników

Raport o wykorzystaniu usług Google Workspace zawiera informacje o wykorzystaniu usług Google Workspace przez konkretnego użytkownika w Twojej domenie. Raporty można dostosowywać i filtrować pod kątem konkretnych informacji o użyciu. Domyślny i maksymalny okres dla każdego raportu to ostatnie 450 dni.

Tego raportu dotyczącego użytkowania przez użytkownika można używać tylko do celów zgodnych z prawem, zgodnie z Umową klienta. Raporty te dotyczą Google Workspace oraz Google Workspace for Education.

Pobierz wszystkie dane o aktywności użytkowników

Aby pobrać raport o wszystkich działaniach użytkowników na Twoim koncie, użyj tego żądania HTTP GET i dołącz token autoryzacji opisany w dokumentacji dotyczącej autoryzacji. Aby zapewnić czytelność, ten przykład został sformatowany przy użyciu znaków zwracania wierszy: 

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/yyyy-mm-dd date
?parameters=application: user usage parameter,...
&filters=application: user usage parameter relational operator usage parameter's value,...
&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). Więcej informacji o parametrach ciągu zapytania i właściwościach odpowiedzi znajdziesz w dokumentacji interfejsu API. Informacje o parametrach w raportach o wykorzystaniu użytkowników znajdziesz w dokumentacji parametrów użytkowania użytkowników.

Poniższy przykład pokazuje raport o wszystkich działaniach użytkowników na koncie. 

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all
/dates/2013-03-03?maxResults=2

Poniższy przykład pokazuje raport o wszystkich działaniach użytkowników na określonym koncie klienta.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all
/dates/2013-03-03?customerId=C03az79cb

Poniższy przykład pokazuje raport z sygnaturami czasowymi ostatniego logowania użytkowników na koncie. Przykładowa odpowiedź interfejsu API znajdziesz w przykładzie odpowiedzi JSON. 

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time&maxResults=2

W przykładzie poniżej otrzymasz raport z sygnaturami czasowymi ostatniego logowania użytkowników na koncie przefiltrowany według użytkowników, którzy zalogowali się po określonym czasie. Przykładowa odpowiedź interfejsu API znajdziesz w przykładzie odpowiedzi JSON. 

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time&filters=accounts:last_login_time
>2010-10-28T10:26:35.000Z"

Poniższy przykład pokazuje raport o sygnaturach czasowych ostatniego logowania i stanie zawieszenia kont użytkowników na koncie. Przykładowa odpowiedź interfejsu API znajdziesz w przykładzie odpowiedzi JSON. 

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time,accounts:is_disabled"

Pobieranie informacji o aktywności konkretnego użytkownika

Aby pobrać raport o aktywności określonego użytkownika na Twoim koncie, użyj tego żądania HTTP GET i dołącz token autoryzacji opisany w dokumentacji dotyczącej autoryzacji. Aby zapewnić czytelność, poniższy przykład został sformatowany przy użyciu znaków zwracania wierszy. 

GET https://admin.googleapis.com/admin/reports/v1/usage/users/userKey/dates/yyyy-mm-dd date
?parameters=application: user usage parameter,...
&filters=application: user usage parameter relational operator usage parameter's value,...
&maxResults=number of events listed on each page of the report

userKey może być podstawowym adresem e-mail użytkownika ujętego w raporcie lub niepowtarzalnym adresem profileId Google Workspace użytkownika. Wartość dates to data użycia danych, a sygnatura czasowa jest w formacie ISO 8601 (rrrr-mm-dd). Więcej informacji o parametrach ciągu zapytania i właściwościach odpowiedzi znajdziesz w dokumentacji interfejsu API. Informacje o parametrach w raportach o wykorzystaniu użytkowników znajdziesz w dokumentacji parametrów użytkowania użytkowników.

Poniższy przykład zawiera raport na temat wykorzystania dla adresu jan@example.com.

https://admin.googleapis.com/admin/reports/v1/usage/users/john@example.com/dates/2013-03-03

Przykładowa odpowiedź JSON z raportem o wykorzystaniu

Pomyślna odpowiedź zwraca kod stanu HTTP 200. Oprócz kodu stanu odpowiedź zwróci raport.

Odpowiedź JSON dotycząca raportu dotyczącego użytkownika

{
 "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": "USER",
    "customerId": "C03az79cb",
    "userEmail": "liz@example.com",
    "profileId": "user's unique Google Workspace ID"
   },
   "parameters": [
    {
      "name": "accounts:is_disabled",
      "boolValue": false
     },
    {
     "name": "accounts:disabled_reason",
     "stringValue": "reason description"
    },
    {
     "name": "accounts:first_name",
     "stringValue": "Liz"
    },
    {
     "name": "accounts:is_2sv_enforced",
     "boolValue": false
    },
    {
     "name": "accounts:is_2sv_enrolled",
     "boolValue": false
    },
    {
     "name": "accounts:last_name",
     "stringValue": "Smith"
    },
    {
     "name": "accounts:creation_time",
     "datetimeValue": "2010-10-28T10:26:35.000Z"
    },
    {
     "name": "accounts:last_login_time",
     "datetimeValue": "1970-01-01T00:00:00.000Z"
    },
    {
     "name": "accounts:last_sso_time",
     "datetimeValue": "1970-01-01T00:00:00.000Z"
    }
   ]
  }
 ]
}