Method: properties.runAccessReport

Trả về báo cáo tuỳ chỉnh về bản ghi truy cập dữ liệu. Báo cáo này cung cấp bản ghi về mỗi lần người dùng đọc dữ liệu báo cáo của Google Analytics. Bản ghi truy cập được lưu giữ trong tối đa 2 năm.

Bạn có thể yêu cầu Báo cáo truy cập dữ liệu cho một tài sản. Bạn có thể yêu cầu báo cáo cho bất kỳ tài sản nào, nhưng chỉ có thể yêu cầu những phương diện không liên quan đến hạn mức trên tài sản Google Analytics 360. Phương thức này chỉ dành cho Quản trị viên.

Những bản ghi quyền truy cập dữ liệu này bao gồm Báo cáo giao diện người dùng GA4, Khám phá giao diện người dùng GA4, API dữ liệu GA4 và các sản phẩm khác như Firebase và AdMob có thể truy xuất dữ liệu từ Google Analytics thông qua một mối liên kết. Những bản ghi này không bao gồm các thay đổi về cấu hình tài sản như việc thêm luồng hoặc thay đổi múi giờ của một tài sản. Để biết nhật ký thay đổi cấu hình, hãy xem searchChangeHistoryEvents.

Yêu cầu HTTP

POST https://analyticsadmin.googleapis.com/v1beta/{entity=properties/*}:runAccessReport

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

Tham số đường dẫn

Thông số
entity

string

Báo cáo Quyền truy cập dữ liệu hỗ trợ yêu cầu ở cấp tài sản hoặc cấp tài khoản. Nếu được yêu cầu ở cấp tài khoản, Báo cáo truy cập dữ liệu sẽ bao gồm tất cả quyền truy cập cho tất cả các tài sản trong tài khoản đó.

Để yêu cầu ở cấp tài sản, thực thể phải là "properties/123" nếu "123" là mã tài sản GA4 của bạn. Để yêu cầu ở cấp tài khoản, thực thể phải là "accounts/1234" nếu "1234" là mã tài khoản GA4 của bạn.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "dimensions": [
    {
      object (AccessDimension)
    }
  ],
  "metrics": [
    {
      object (AccessMetric)
    }
  ],
  "dateRanges": [
    {
      object (AccessDateRange)
    }
  ],
  "dimensionFilter": {
    object (AccessFilterExpression)
  },
  "metricFilter": {
    object (AccessFilterExpression)
  },
  "offset": string,
  "limit": string,
  "timeZone": string,
  "orderBys": [
    {
      object (AccessOrderBy)
    }
  ],
  "returnEntityQuota": boolean,
  "includeAllUsers": boolean,
  "expandGroups": boolean
}
Trường
dimensions[]

object (AccessDimension)

Các phương diện được yêu cầu và hiển thị trong phản hồi. Bạn có thể sử dụng tối đa 9 phương diện để yêu cầu.
metrics[]

object (AccessMetric)

Các chỉ số được yêu cầu và hiển thị trong phản hồi. Mỗi yêu cầu được phép có tối đa 10 chỉ số.
dateRanges[]

object (AccessDateRange)

Phạm vi ngày của bản ghi truy cập cần đọc. Nếu bạn yêu cầu nhiều phạm vi ngày, thì mỗi hàng phản hồi sẽ chứa một chỉ mục phạm vi ngày dựa trên 0. Nếu hai phạm vi ngày trùng lặp, thì các bản ghi truy cập cho những ngày trùng lặp sẽ được đưa vào các hàng phản hồi cho cả hai phạm vi ngày. Mỗi yêu cầu được phép có tối đa 2 phạm vi ngày.
dimensionFilter

object (AccessFilterExpression)

Bộ lọc phương diện cho phép bạn giới hạn phản hồi báo cáo ở một số giá trị phương diện cụ thể khớp với bộ lọc. Ví dụ: lọc các bản ghi quyền truy cập của một người dùng. Để tìm hiểu thêm, hãy xem bài viết Nguyên tắc cơ bản về bộ lọc phương diện để xem ví dụ. Không thể sử dụng chỉ số trong bộ lọc này.
metricFilter

object (AccessFilterExpression)

Bộ lọc chỉ số cho phép bạn giới hạn phản hồi báo cáo ở những giá trị chỉ số cụ thể khớp với bộ lọc. Bộ lọc chỉ số được áp dụng sau khi tổng hợp các hàng của báo cáo, tương tự như mệnh đề SQL. Bạn không thể sử dụng phương diện trong bộ lọc này.
offset

string (int64 format)

Số hàng của hàng bắt đầu. Hàng đầu tiên được tính là hàng 0. Nếu không chỉ định độ dời, hệ thống sẽ coi độ dời là 0. Nếu độ dời bằng 0, thì phương thức này sẽ trả về trang kết quả đầu tiên có các mục limit.

Để tìm hiểu thêm về thông số phân trang này, hãy xem phần Phân trang.
limit

string (int64 format)

Số lượng hàng sẽ trả về. Nếu không chỉ định, hệ thống sẽ trả về 10.000 hàng. API sẽ trả về tối đa 100.000 hàng cho mỗi yêu cầu, bất kể bạn yêu cầu bao nhiêu hàng. limit phải là số dương.

API có thể trả về ít hàng hơn limit được yêu cầu nếu số hàng còn lại không bằng limit. Ví dụ: có ít hơn 300 giá trị có thể có cho phương diện country. Vì vậy, khi chỉ báo cáo về country, bạn không thể nhận được nhiều hơn 300 hàng, ngay cả khi bạn đặt limit thành một giá trị cao hơn.

Để tìm hiểu thêm về thông số phân trang này, hãy xem phần Phân trang.
timeZone

string

Múi giờ của yêu cầu này nếu được chỉ định. Nếu bạn không chỉ định, hệ thống sẽ sử dụng múi giờ của tài sản. Múi giờ của yêu cầu được dùng để diễn giải ngày bắt đầu và ngày kết thúc của báo cáo.

Được định dạng dưới dạng chuỗi từ cơ sở dữ liệu Múi giờ IANA (https://www.iana.org/time-zones); ví dụ: "America/New_ Được" hoặc "Châu Á/Tokyo".
orderBys[]

object (AccessOrderBy)

Chỉ định cách sắp xếp các hàng trong phản hồi.
returnEntityQuota

boolean

Bật/tắt tuỳ chọn trả về trạng thái hiện tại của hạn mức của Tài sản Analytics này. Hạn mức được trả về trong AccessQuota. Đối với các yêu cầu ở cấp tài khoản, trường này phải có giá trị là false.
includeAllUsers

boolean

Không bắt buộc. Xác định xem có nên đưa những người dùng chưa từng thực hiện lệnh gọi API vào phản hồi hay không. Nếu đúng, tất cả người dùng có quyền truy cập vào tài sản hoặc tài khoản được chỉ định đều được đưa vào phản hồi, bất kể họ đã thực hiện lệnh gọi API hay chưa. Nếu giá trị là false thì chỉ bao gồm những người dùng đã thực hiện lệnh gọi API.
expandGroups

boolean

Không bắt buộc. Quyết định xem có trả về người dùng trong các nhóm người dùng hay không. Trường này chỉ hoạt động khi bạn đặt includeAllUsers thành true. Nếu giá trị là true, thì hàm này sẽ trả về tất cả người dùng có quyền truy cập vào tài sản hoặc tài khoản được chỉ định. Nếu giá trị là false, thì hệ thống chỉ trả về những người dùng có quyền truy cập trực tiếp.

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 RunAccessReportResponse.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit