Method: entityUsageReports.get

Pobiera raport będący zbiorem usług i statystyk dotyczących elementów używanych przez użytkowników na koncie. Więcej informacji znajdziesz w przewodniku po raportach wykorzystania jednostek. Więcej informacji o parametrach raportu „Baza jednostek” znajdziesz w materiałach referencyjnych Parametry „Baza jednostek”.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
entityType

enum (EntityType)

Reprezentuje typ elementu w raporcie.
entityKey

string

Reprezentuje klucz obiektu, według którego mają być filtrowane dane. Jest to ciąg znaków, który może przyjmować wartość all, aby uzyskać zdarzenia aktywności dotyczące wszystkich użytkowników, lub dowolną inną wartość w przypadku elementu związanego z konkretną aplikacją. Szczegółowe informacje o tym, jak uzyskać entityKey dla konkretnego entityType, znajdziesz w przewodnikach Parametry korzystania z obiektów.
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, 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. Ciąg zapytania filters zawiera nazwę aplikacji, której użycie jest zwracane w raporcie. Wartości aplikacji w raporcie Użycie elementó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 w adresie URL w ciągu zapytania żądania (%3C%3E): 

GET
https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-01
?parameters=gplus:community_name,gplus:num_total_members
&filters=gplus:num_total_members%3C%3E0

Operatory relacji:

  • == – „równa się”.
  • <> – „nie równa się”. Jest on zakodowany w formacie adresu URL (%3C%3E).
  • < – „mniej niż”. Jest on zakodowany w formacie 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=).
Filtry można stosować tylko do parametrów liczbowych.
maxResults

integer (uint32 format)

Określa, ile rekordów aktywności jest wyświetlanych na każdej stronie odpowiedzi. Jeśli na przykład żądanie zawiera zestawy <span>maxResults=1</span>, a raport ma 2 działania, ma on 2 strony. Właściwość <span>nextPageToken</span> odpowiedzi zawiera token do drugiej strony.
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ą. W raporcie wykorzystania encji wartość aplikacji w raporcie to tylko gplus.
Ciąg znaków zapytania parameter ma postać [app_name1:param_name1], [app_name2:param_name2]... w formacie CSV.

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 dotyczącym autoryzacji.

Typ encji

Wartości w polu enum
gplus_communities Zwraca raport o społecznościach Google+.