Interfejs Reports API: raport o wykorzystaniu elementów

Raport o wykorzystaniu elementów zwraca aktywności usługi Google Workspace związane z elementami używanymi przez użytkowników Twojego konta. Raporty te można dostosowywać i filtrować pod kątem konkretnych informacji o wykorzystaniu. Dostępne są dane z ostatnich 30 dni.

Zgodnie z Twoją Umową klienta raport o korzystaniu z elementów może być używany wyłącznie do celów zgodnych z prawem. Te raporty dotyczą też Google Workspace oraz Google Workspace for Education.

Pobierz wszystkie aktywności związane z użyciem encji

Obecnie jedynym rodzajem encji obsługiwanym przez ten interfejs API są społeczności Google+. Aby pobrać raport o wszystkich działaniach związanych z elementami aplikacji na Twoim koncie, użyj poniższego żądania HTTP GET i dołącz token autoryzacji opisany w dokumentacji autoryzacji. Aby zapewnić czytelność, poniższy przykład jest sformatowany ze zwrotami 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, aby do tego celu użyć strefy czasowej swojego konta. Więcej informacji o parametrach ciągu zapytania i właściwościach odpowiedzi znajdziesz w dokumentacji interfejsu API. Informacje o parametrach raportu o wykorzystaniu encji znajdziesz w dokumentacji parametrów wykorzystania encji.

applicationParameters to rozdzielona przecinkami lista parametrów, które chcesz pobrać. Każdy parametr ma format application:parameter_name, np. gplus:community_name. Informacje o dostępnych parametrach znajdziesz w dokumentacji parametrów wykorzystania encji. Jeśli nie określono żadnych parametrów, zwracane są wszystkie.

parameterFilters to rozdzielona przecinkami lista filtrów, które mają być stosowane do wyników. Każdy filtr ma format application:parameter_name[relational_operator]parameter_value. Na przykład filtr gplus:num_total_members>100 filtruje wyniki, tak aby zawierały tylko te wyniki, w których parametr gplus:num_total_members ma wartość większą niż 100.

maxResults to maksymalna liczba wyników zwracanych w ramach pojedynczego pobierania. Jeśli łączna liczba wyników jest większa, odpowiedź zostanie skrócona i uwzględniona zostanie wartość nextPageToken (patrz przykład odpowiedzi JSON poniżej).

Przykłady

W podanym niżej przykładzie powstaje raport zawierający wszystkie parametry dotyczące wszystkich elementów gplus_communities.

GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all
/dates/2017-12-11

W poniższym przykładzie powstaje raport zawierający parametr community_name w przypadku wszystkich elementów gplus_communities.

GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all
/dates/2017-12-11?parameters=gplus:community_name

Poniższy przykład pokazuje raport community_name i num_total_members dla każdego elementu gplus_communities, przefiltrowany według społeczności liczących ponad 100 członków. Przykład odpowiedzi interfejsu API znajdziesz w przykładzie 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

GET https://admin.googleapis.com/admin/reports/v1/gplus_communities/entityKey/dates/date
?parameters=applicationParameters
&filters=parameterFilters
&maxResults=maxResults

https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/1234/dates/2017-12-11

{
 "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
    },
   ]
  }
 ]
}

{
 "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": [],
}