Interfejs Reports API: raport o wykorzystaniu elementów

Raport o wykorzystaniu encji zwraca działania usługi Google Workspace związane z encjami używane przez użytkowników konta. Raporty można dostosowywać i filtrować pod kątem określonego wykorzystania i informacjami o nich. Dostępne są dane z ostatnich 30 dni.

Raportu o korzystaniu z podmiotów może być wykorzystany tylko do celów zgodnych z prawem zgodnie z Umową klienta. Raporty te dotyczą również Google Workspace i Google Workspace for Education.

Pobieranie wszystkich aktywności związanych z wykorzystaniem encji

Obecnie jedynym typem encji obsługiwanym przez ten interfejs API są społeczności Google+. Aby pobrać wszystkich działań związanych z elementami aplikacji na Twoim koncie, użyj GET i podaj token autoryzacji opisany w dokumentację autoryzacji. Dla: w poniższym przykładzie formatowany jest za pomocą funkcji zwracania 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 znajduje się w Format ISO 8601, rrrr-mm-dd. Nasze wskazówki użyj do tego strefy czasowej swojego konta. Więcej informacji o parametrach ciągu zapytania właściwości odpowiedzi można znaleźć w interfejsie API Plik referencyjny. Informacje o parametrach raportu na temat wykorzystania encji znajdziesz tutaj: Parametry wykorzystania encji odniesienie.

applicationParameters to rozdzielona przecinkami lista parametrów, które chcesz pobrać. Każdy parametr ma format application:parameter_name, np. gplus:community_name Dostępne parametry są opisane w Parametry wykorzystania encji odniesienie. Jeśli nie podasz żadnych parametrów, zwracane są wszystkie.

parameterFilters to oddzielona przecinkami lista filtrów, które mają zostać zastosowane do wyników. Każdy filtr jest sformatowany jako application:parameter_name[relational_operator]parameter_value Na przykład parametr filtr gplus:num_total_members>100 filtruje wyniki, aby zawierały tylko wyniki gdzie parametr gplus:num_total_members ma wartość większą niż 100.

maxResults to maksymalna liczba wyników do zwrócenia w ramach jednego pobrania. Jeśli suma liczba wyników jest większa od tej wartości, odpowiedź zostanie skrócona, a nextPageToken (zobacz przykład odpowiedzi JSON poniżej).

Przykłady

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

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

Poniższy przykład pokazuje 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 obejmuje raport community_name i num_total_members dla każdej jednostki gplus_communities, przefiltrowane według społeczności liczące ponad 100 członków. Przykładowa odpowiedź 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

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