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 o użytkownikach znajdziesz w przewodnikach referencyjnych Parametry użytkowania przez 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, dla których mają zostać odfiltrowane dane. Może to być all w przypadku wszystkich informacji albo userKey w przypadku unikalnego identyfikatora profilu Google Workspace lub podstawowego adresu e-mail użytkownika. Adres 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 wartości userKey.
date

string

Reprezentuje datę wykorzystania na podstawie czasu UTC-8:00 (czas pacyficzny standardowy). 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 rozdzielona przecinkami lista parametrów zdarzenia aplikacji, w których wartość parametru jest zmieniana 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 operator „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:

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

integer (uint32 format)

Określa, ile rekordów aktywności jest wyświetlanych na każdej stronie odpowiedzi. Jeśli np. żądanie ustawia w żądaniu ustawienie maxResults=1, a raport zawiera 2 działania, raport składa się z 2 stron. Właściwość nextPageToken odpowiedzi zawiera 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 w przypadku użytkowników należących do określonej jednostki organizacyjnej.

pageToken

string

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

string

Ciąg zapytania parameters to rozdzielona 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 parameters ma postać pliku CSV app_name1:param_name1, app_name2:param_name2.

groupIdFilter

string

Rozdzielone przecinkami identyfikatory grup (zaciemnione), według których są filtrowane aktywności użytkownika. Oznacza to, że odpowiedź będzie zawierać działania tylko tych użytkowników, którzy należą do co najmniej jednego z wymienionych tutaj identyfikatorów grup. 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 po autoryzacji.