Reports API: raport o wykorzystaniu encji

Raport o wykorzystaniu encji przedstawia aktywność w usłudze Google Workspace powiązaną z elementami używanymi przez użytkowników Twojego konta. Te raporty można dostosowywać i filtrować pod kątem określonych informacji o wykorzystaniu. Dostępne są dane z ostatnich 30 dni.

Raport dotyczący wykorzystania jednostek może być używany wyłącznie do celów prawnych zgodnie z umową klienta. Te raporty dotyczą też Google Workspace i Education.

Pobieranie wszystkich działań związanych z wykorzystaniem elementów

Obecnie jedynym typem elementu obsługiwanym przez ten interfejs API są społeczności Google+. Aby pobrać raport o wszystkich działaniach związanych z elementami aplikacji na koncie, użyj poniższego żądania HTTP GET i dołącz token autoryzacji opisany w dokumentacji autoryzacji. W przypadku czytelności w tym przykładzie podano następujący zwrot:

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 i sygnatura czasowa w formacie ISO 8601, rrrr-mm-dd. Zalecamy używanie w tym celu 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 wykorzystania encji znajdziesz w dokumentacji parametrów wykorzystania encji.

applicationParameters to oddzielona przecinkami lista parametrów, które chcesz pobrać. Każdy parametr ma format application:parameter_name, np. gplus:community_name. Dostępne parametry znajdziesz w dokumentacji parametrów wykorzystania encji. Jeśli nie podasz żadnych parametrów, zostaną zwrócone wszystkie.

parameterFilters to oddzielona 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 pokazuje wyniki tylko wtedy, gdy 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 zostanie uwzględniona nextPageToken (zobacz przykład odpowiedzi JSON poniżej).

Przykłady

Poniższy przykład zawiera raport zawierający wszystkie parametry wszystkich elementów gplus_communities.

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

Poniższy przykład przedstawia raport zawierający parametr community_name dla 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 filtrowanego przez społeczności z ponad 100 członkami. Przykładowa odpowiedź 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": [],
}