Method: userUsageReport.get

Pobiera raport, czyli zbiór właściwości i statystyk dotyczących zbioru użytkowników na koncie. Więcej informacji znajdziesz w przewodniku Raportowanie wykorzystania przez użytkowników. Więcej informacji o parametrach raportu o użytkownikach znajdziesz w przewodnikach na temat parametrów Użytkownicy – Użycie.

Żą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

string

Reprezentuje identyfikator profilu lub adres e-mail użytkownika, którego dane mają zostać odfiltrowane. 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 to być usunięty użytkownik. 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 adresu ID jako userKey.
date

string

Reprezentuje datę, w której nastąpiło wykorzystanie, według czasu UTC-8:00 (czasu pacyficznego standardowego). Znak czasu jest podany w formacie ISO 8601, yyyy-mm-dd.

Parametry zapytania

Parametry
customerId

string

Unikalny identyfikator klienta, którego dane mają zostać pobrane.
filters

string

Ciąg znaków filters to lista oddzielonych przecinkami parametrów zdarzenia aplikacji, w której wartość parametru jest modyfikowana przez operator relacji. Parametr ciągu zapytania filters zawiera nazwę aplikacji, której użycie jest zwracane w raporcie. Wartości aplikacji w raporcie Użycie przez użytkowników to accounts, docs i gmail.

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

W tym przykładzie operator „nierówna” <> jest zakodowany w adresie URL w ciągu zapytania (%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 relacji:

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

integer (uint32 format)

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

string

Identyfikator jednostki organizacyjnej, której 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ślenia następnej strony. Raport obejmujący kilka stron zawiera w odpowiedzi właściwość nextPageToken. W kolejnych żądaniach o kolejne strony raportu w ciągu zapytania pageToken wpisz wartość nextPageToken.
parameters

string

Ciąg znaków zapytania parameters to lista oddzielonych przecinkami parametrów zdarzenia, które umożliwiają zawężenie wyników raportu. Parametr jest powiązany z konkretną aplikacją. Wartości aplikacji w raporcie Użycie przez klientów to accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet i sites.
Ciąg znaków zapytania parameters ma postać app_name1:param_name1, app_name2:param_name2 w formacie CSV.

groupIdFilter

string

Identyfikatory grup (zaciemnione) oddzielone przecinkami, według których filtrowane są aktywności użytkowników, czyli odpowiedź będzie zawierać aktywności tylko tych użytkowników, którzy należą do co najmniej 1 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 na temat autoryzacji.