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 raporcie o wykorzystaniu elementów. Więcej informacji o parametrach w raporcie encji znajdziesz w przewodnikach referencyjnych Parametry wykorzystania elementów.

Żą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 raportu.
entityKey or all

string

Reprezentuje klucz obiektu, za pomocą którego chcesz filtrować dane. Jest to ciąg znaków, który może przyjmować wartość all, aby pobierać zdarzenia związane z aktywnością dla wszystkich użytkowników lub dowolną inną wartość dla encji związanej z aplikacją. Szczegółowe informacje o tym, jak uzyskać entityKey w przypadku określonego elementu entityType, znajdziesz w przewodnikach referencyjnych dotyczących parametrów wykorzystania encji.
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 o wykorzystaniu 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 na potrzeby adresu 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 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=).
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 np. żądanie ustawia w żądaniu ustawienie <span>maxResults=1</span>, a raport zawiera 2 działania, raport składa się z 2 stron. Właściwość <span>nextPageToken</span> odpowiedzi zawiera token drugiej strony.
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 o wykorzystaniu elementów to tylko gplus.
Ciąg zapytania parameter ma postać pliku CSV [app_name1:param_name1], [app_name2:param_name2]....

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.

EntityType

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