Method: entityUsageReports.get

Truy xuất báo cáo là tập hợp các thuộc tính và thống kê cho các thực thể được người dùng sử dụng trong tài khoản. Để biết thêm thông tin, hãy xem Hướng dẫn về Báo cáo mức sử dụng thực thể. Để biết thêm thông tin về các thông số của báo cáo thực thể, hãy xem hướng dẫn tham khảo về Thông số sử dụng thực thể.

Yêu cầu HTTP

GET https://admin.googleapis.com/admin/reports/v1/usage/{entityType}/{entityKey or all}/dates/{date}

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Tham số
entityType

enum (EntityType)

Đại diện cho loại thực thể của báo cáo.
entityKey or all

string

Đại diện cho khoá của đối tượng cần dùng để lọc dữ liệu. Đây là một chuỗi có thể nhận giá trị all để nhận các sự kiện hoạt động cho tất cả người dùng hoặc bất kỳ giá trị nào khác của một thực thể dành riêng cho ứng dụng. Để biết thông tin chi tiết về cách lấy entityKey cho một entityType cụ thể, hãy xem hướng dẫn tham khảo Tham số sử dụng thực thể.
date

string

Thể hiện ngày sử dụng, dựa trên UTC-8:00 (Giờ chuẩn Thái Bình Dương). Dấu thời gian ở định dạng ISO 8601, yyyy-mm-dd.

Tham số truy vấn

Tham số
customerId

string

Mã nhận dạng duy nhất của khách hàng cần truy xuất dữ liệu.
filters

string

Chuỗi truy vấn filters là một danh sách các tham số sự kiện của một ứng dụng được phân tách bằng dấu phẩy, trong đó giá trị của tham số được toán tử quy chiếu điều khiển. Chuỗi truy vấn filters bao gồm tên của ứng dụng có mức sử dụng được trả về trong báo cáo. Các giá trị ứng dụng trong Báo cáo sử dụng thực thể bao gồm accounts, docs và gmail.

Các bộ lọc có dạng [application name]:[parameter name][relational operator][parameter value],....

Trong ví dụ này, toán tử 'không bằng' <> được mã hoá URL trong chuỗi truy vấn của yêu cầu (%3C%3E): 

GET
https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-01
?parameters=gplus:community_name,gplus:num_total_members
&filters=gplus:num_total_members%3C%3E0

Các toán tử quy chiếu bao gồm:

  • == – "bằng".
  • <> – "không bằng". Đó là URL được mã hóa (%3C%3E).
  • < – 'nhỏ hơn'. Đó là URL được mã hoá (%3C).
  • <= – "nhỏ hơn hoặc bằng". Đó là URL được mã hoá (%3C=).
  • > – "lớn hơn". Đó là URL được mã hoá (%3E).
  • >= – "lớn hơn hoặc bằng". Đó là URL được mã hoá (%3E=).
Bạn chỉ có thể áp dụng bộ lọc cho các thông số dạng số.
maxResults

integer (uint32 format)

Xác định số lượng bản ghi hoạt động được hiển thị trên mỗi trang phản hồi. Ví dụ: nếu yêu cầu đặt <span>maxResults=1</span> và báo cáo có hai hoạt động, thì báo cáo sẽ có hai trang. Thuộc tính <span>nextPageToken</span> của phản hồi có mã thông báo đến trang thứ hai.
pageToken

string

Mã thông báo để chỉ định trang tiếp theo. Một báo cáo có nhiều trang sẽ có một thuộc tính nextPageToken trong phản hồi. Trong yêu cầu tiếp theo khi bạn nhận trang tiếp theo của báo cáo, hãy nhập giá trị nextPageToken vào chuỗi truy vấn pageToken.
parameters

string

Chuỗi truy vấn parameters là danh sách các thông số sự kiện được phân tách bằng dấu phẩy sẽ tinh chỉnh kết quả của báo cáo. Thông số này được liên kết với một ứng dụng cụ thể. Giá trị ứng dụng cho Báo cáo sử dụng thực thể chỉ có gplus.
Chuỗi truy vấn parameter có dạng CSV của [app_name1:param_name1], [app_name2:param_name2]....

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của UsageReports.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/admin.reports.usage.readonly

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.

EntityType

Enum
gplus_communities Trả về báo cáo về cộng đồng trên Google+.