Raport dotyczący wykorzystania podmiotów zwraca aktywności w usługach Google Workspace związane z podmiotami używanymi przez użytkowników konta. Te raporty można dostosowywać i filtrować, aby uzyskać konkretne informacje o wykorzystaniu. Dane są dostępne z ostatnich 30 dni.
Raport dotyczący wykorzystania podmiotów może być wykorzystywany wyłącznie w celach zgodnych z prawem i zgodnie z Umową klienta. Te raporty dotyczą również Google Workspace i Education.
Pobieranie wszystkich działań związanych z używaniem encji
Jedynym typem elementu obsługiwanym przez ten interfejs API są społeczności Google+. Aby pobrać raport o wszystkich aktywnościach związanych z podmiotami aplikacji na Twoim koncie, użyj poniższego żądania HTTP GET i dołącz token autoryzacji opisany w dokumentacji autoryzacji. Aby ułatwić czytanie, poniższy przykład zawiera znaki łamania wierszy:
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/date ?parameters=applicationParameters &filters=parameterFilters &maxResults=maxResults
Wartość date to data użycia, a sygnatura czasowa jest podana w formacie ISO 8601, rrrr-mm-dd. Zalecamy używanie strefy czasowej konta. Więcej informacji o parametrach ciągu zapytania i właściwościach odpowiedzi znajdziesz w dokumentacji API. Informacje o parametrach raportu dotyczącego wykorzystania jednostek znajdziesz w tym artykule.
applicationParameters to lista parametrów rozdzielona przecinkami, które chcesz pobrać.
Każdy parametr ma format application:parameter_name, np. gplus:community_name. Dostępne parametry są opisane w dokumentacji parametrów użycia jednostek. Jeśli nie podasz żadnych parametrów, zwracane są wszystkie.
parameterFilters to lista filtrów rozdzielonych przecinkami, które mają zostać zastosowane do wyników. Każdy filtr jest sformatowany jako application:parameter_name[relational_operator]parameter_value. Na przykład filtr gplus:num_total_members>100 filtruje wyniki tak, aby zawierały tylko te, w których parametr gplus:num_total_members ma wartość większą niż 100.
maxResults to maksymalna liczba wyników do zwrócenia w ramach jednego pobierania. Jeśli łączna liczba wyników jest większa, odpowiedź zostanie obcięta i będzie zawierać nextPageToken (patrz przykład odpowiedzi JSON poniżej).
Przykłady
Ten przykład pobiera raport zawierający wszystkie parametry wszystkich podmiotów gplus_communities.
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all /dates/2017-12-11
W tym przykładzie pobierany jest raport zawierający parametr community_name dla wszystkich podmiotów gplus_communities.
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all /dates/2017-12-11?parameters=gplus:community_name
W tym przykładzie pobieramy raport dotyczący community_name i num_total_members dla każdego podmiotu gplus_communities, filtrowany według społeczności z ponad 100 członkami. Przykład odpowiedzi interfejsu API znajdziesz w sekcji Przykład odpowiedzi JSON.
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-11 ?parameters=gplus:community_name,gplus:num_total_members&filters=gplus:num_total_members>100
Pobieranie raportu dotyczącego konkretnego elementu
Aby pobrać raport dotyczący konkretnego podmiotu, użyj tego żądania HTTP GET i dołącz token autoryzacji opisany w dokumentacji autoryzacji. Aby zwiększyć czytelność, poniższy przykład zawiera znaki łamania wierszy.
GET https://admin.googleapis.com/admin/reports/v1/gplus_communities/entityKey/dates/date ?parameters=applicationParameters &filters=parameterFilters &maxResults=maxResults
entityKey to identyfikator jednostki, który jest specyficzny dla aplikacji, w której znajduje się jednostka. Szczegółowe informacje o tym, jak uzyskać wartość entityKey dla konkretnego podmiotu, który Cię interesuje, znajdziesz w dokumentacji interfejsu API. Pozostałe parametry zostały opisane wcześniej w sekcji Pobieranie działań związanych z używaniem wszystkich elementów.
Więcej informacji o parametrach ciągu zapytania i właściwościach odpowiedzi znajdziesz w dokumentacji API. Informacje o parametrach raportu dotyczącego wykorzystania jednostek znajdziesz w tym artykule.
Przykłady
Poniższy przykład pobiera raport o elemencie gplus_community z wartością entityKey „1234”.
https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/1234/dates/2017-12-11
Przykładowa odpowiedź JSON raportu dotyczącego wykorzystania
Prawidłowa odpowiedź zwraca kod stanu HTTP 200. Oprócz kodu stanu odpowiedź zawiera raport. Niektóre parametry w odpowiedzi zostały pominięte ze względu na czytelność.
Przykładowa odpowiedź JSON w przypadku raportu o podmiotach
{ "kind": "reports#usageReports", "nextPageToken": "NjQ1OTgwODk0MzkxNDAwNjQ0OA", "usageReports": [ { "kind": "admin#reports#usageReport", "date": "2017-12-11", "entity": { "type": "OBJECT", "customerId": "C03az79cb", "objectType": "GPLUS_COMMUNITY", "objectId": "1234", }, "parameters": [ { "name": "gplus:community_name", "stringValue": "My Community" }, { "name": "gplus:num_total_members", "intValue": 37 }, { "name": "gplus:num_7day_active_members", "intValue": 12 }, { "name": "gplus:num_30day_active_members", "intValue": 17 }, ] } ] }
Przykładowa odpowiedź JSON dla raportu o podmiotach z ostrzeżeniami
Jeśli nie można zrealizować żądania, w odpowiedzi może zostać zwrócone co najmniej jedno ostrzeżenie. W tym przykładzie raport jest niedostępny w momencie wysłania żądania.{
"kind": "reports#usageReports",
"warnings": [
{
"code": "PARTIAL_DATA_AVAILABLE"
"message": "Data for date 2017-12-11 for application gplus is not available right now, please try again after a few hours."
"data": [
{
"key": "date"
"value": "2017-12-11"
}
]
}
],
"usageReports": [],
}warnings ma te parametry:
code: kod ostrzeżenia w formacie czytelnym dla komputerów.message: czytelny komunikat ostrzegawczydata: lista par klucz-wartość zawierających szczegółowe informacje o ostrzeżeniu.