Method: userUsageReport.get

Pobiera raport będący zbiorem usług i statystyk dla zestawu użytkowników konta. Więcej informacji znajdziesz w przewodniku po raportach na temat wykorzystania użytkowników. Więcej informacji o parametrach raportu użytkownika znajdziesz w przewodnikach dotyczących parametrów wykorzystania użytkowników.

Żądanie HTTP

GET https://admin.googleapis.com/admin/reports/v1/usage/users/{userKey or all}/dates/{date}

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
userKey or all

string

Reprezentuje identyfikator profilu lub adres e-mail użytkownika, w przypadku którego dane mają być filtrowane. Może to być all w przypadku wszystkich informacji, userKey w przypadku unikalnego identyfikatora profilu Google Workspace użytkownika lub jego podstawowego adresu e-mail. Nie może być usuniętym użytkownikiem. W przypadku usuniętego konta użytkownika wywołaj users.list w interfejsie Directory API za pomocą polecenia showDeleted=true, a następnie użyj zwróconego ID jako userKey.
date

string

Reprezentuje datę użycia danych według czasu UTC–8:00 (czasu pacyficznego). Sygnatura czasowa jest w formacie ISO 8601, yyyy-mm-dd.

Parametry zapytania

Parametry
customerId

string

Unikalny identyfikator klienta, dla którego chcesz pobrać dane.
filters

string

Ciąg zapytania filters to rozdzielana przecinkami lista parametrów zdarzenia aplikacji, w których wartość tego parametru jest modyfikowana przez operator relacyjny. Ciąg zapytania filters zawiera nazwę aplikacji, której użycie jest zwracane w raporcie. Wartości aplikacji w raporcie wykorzystania użytkowników to accounts, docs i gmail.

Filtry mają postać [application name]:[parameter name][relational operator][parameter value],....

W tym przykładzie <> „nie równa się” jest zakodowany na potrzeby adresu URL w ciągu zapytania żądania (%3C%3E): 

GET
https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time
&filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z

Operatory relacyjne to między innymi:

  • == – „równa się”.
  • <> – „nie równa się”. Jest on zakodowany w adresie URL (%3C%3E).
  • < – „mniej niż”. Jest on zakodowany na potrzeby adresu URL (%3C).
  • <= – „mniejsze lub równe”. Jest on zakodowany w adresie URL (%3C=).
  • > – „większe niż”. Jest on zakodowany na potrzeby adresu URL (%3E).
  • >= – „większe niż lub równe”. Jest on zakodowany w adresie URL (%3E=).
maxResults

integer (uint32 format)

Określa, ile rekordów aktywności ma być wyświetlanych na każdej stronie odpowiedzi. Jeśli np. żądanie ustawia maxResults=1, a raport zawiera 2 działania, raport ma 2 strony. Właściwość nextPageToken odpowiedzi ma token drugiej strony.
Ciąg zapytania maxResults jest opcjonalny.
orgUnitID

string

Identyfikator jednostki organizacyjnej, której ma dotyczyć raport. Aktywność użytkowników będzie widoczna tylko dla użytkowników, którzy należą do określonej jednostki organizacyjnej.

pageToken

string

Token do określenia następnej strony. Raport z wieloma stronami zawiera w odpowiedzi właściwość nextPageToken. W kolejnym żądaniu pobierającym następną stronę raportu wpisz wartość nextPageToken w ciągu zapytania pageToken.
parameters

string

Ciąg zapytania parameters to rozdzielana przecinkami lista parametrów zdarzenia, które zawężają wyniki raportu. Parametr jest powiązany z konkretną aplikacją. Wartości aplikacji w raporcie Wykorzystanie klientów to: accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet i sites.
Ciąg zapytania typu parameters ma format CSV app_name1:param_name1, app_name2:param_name2.

groupIdFilter

string

Rozdzielone przecinkami identyfikatory grup (zaciemnione), według których działania użytkowników są filtrowane. Odpowiedź będzie zawierać działania tylko dla tych użytkowników, którzy są częścią co najmniej jednego z wymienionych tutaj identyfikatorów grupy. Format: „id:abc123,id:xyz456”

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu UsageReports.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/admin.reports.usage.readonly

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.