API Báo cáo: Báo cáo về việc sử dụng thực thể

Báo cáo mức sử dụng thực thể trả về các hoạt động dịch vụ của Google Workspace liên quan đến thực thể mà người dùng tài khoản của bạn sử dụng. Bạn có thể tuỳ chỉnh và lọc các báo cáo này theo mức sử dụng cụ thể của bạn. Dữ liệu có sẵn trong 30 ngày qua.

Báo cáo mức sử dụng thực thể chỉ có thể được sử dụng cho các mục đích hợp pháp tại theo Thoả thuận khách hàng của bạn. Các báo cáo này cũng áp dụng cho Google Workspace và Education.

Truy xuất hoạt động sử dụng của tất cả thực thể

Hiện tại, loại thực thể duy nhất được API này hỗ trợ là cộng đồng trên Google+. Để truy xuất một báo cáo về tất cả hoạt động liên quan đến thực thể ứng dụng trong tài khoản của bạn, hãy sử dụng Yêu cầu HTTP GET và bao gồm mã thông báo uỷ quyền được mô tả trong tài liệu uỷ quyền. Cho dễ đọc hơn, ví dụ sau đây được định dạng với lệnh trả về dòng:

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

Giá trị date là ngày sử dụng và dấu thời gian nằm trong Định dạng ISO 8601, yyyy-mm-dd. Bạn nên hãy dùng múi giờ trong tài khoản của bạn cho việc này. Để biết thêm thông tin về tham số chuỗi truy vấn và các thuộc tính phản hồi, hãy xem API Tệp đối chiếu. Để biết thông tin về các thông số báo cáo sử dụng thực thể, hãy xem Tham số sử dụng thực thể tham khảo.

applicationParameters là danh sách các tham số được phân tách bằng dấu phẩy mà bạn muốn truy xuất. Mỗi tham số được định dạng là application:parameter_name, ví dụ: gplus:community_name Các thông số có sẵn được ghi lại trong Tham số sử dụng thực thể tham khảo. Nếu bạn không chỉ định tham số, hàm sẽ trả về tất cả các tham số.

parameterFilters là danh sách bộ lọc được phân tách bằng dấu phẩy để áp dụng cho kết quả. Một có định dạng như sau: application:parameter_name[relational_operator]parameter_value. Ví dụ: bộ lọc gplus:num_total_members>100 lọc kết quả để chỉ chứa kết quả trong đó tham số gplus:num_total_members có giá trị lớn hơn 100.

maxResults là số lượng kết quả tối đa cần trả về trong một lần tìm nạp. Nếu tổng số nhiều hơn số kết quả này, phản hồi sẽ bị cắt bớt và nextPageToken sẽ được đưa vào (xem Ví dụ về phản hồi JSON ở bên dưới).

Ví dụ

Ví dụ sau đây tạo một báo cáo chứa tất cả các thông số cho tất cả các thực thể gplus_communities.

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

Ví dụ sau đây sẽ tạo một báo cáo chứa thông số community_name cho tất cả các thực thể gplus_communities.

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

Ví dụ sau đây tạo một báo cáo về community_name và num_total_members cho mỗi thực thể gplus_communities, được lọc theo các cộng đồng có hơn 100 thành viên. Để biết ví dụ về phản hồi của API, hãy xem Ví dụ về phản hồi 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": [],
}