Method: properties.reportTasks.query

Truy xuất nội dung của một tác vụ báo cáo. Sau khi yêu cầu reportTasks.create, bạn có thể truy xuất nội dung báo cáo khi báo cáo ở trạng thái ĐANG HOẠT ĐỘNG. Phương thức này sẽ trả về lỗi nếu trạng thái của tác vụ báo cáo không phải là ACTIVE. Phản hồi truy vấn sẽ trả về các giá trị hàng và cột dạng bảng của báo cáo.

Yêu cầu HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query

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

Tham số đường dẫn

Tham số
name

string

Bắt buộc. Tên nguồn báo cáo. Định dạng properties/{property}/reportTasks/{report}

Nội dung yêu cầu

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

Biểu diễn dưới dạng JSON 
{
  "offset": string,
  "limit": string
}
Trường
offset

string (int64 format)

Không bắt buộc. Số hàng của hàng bắt đầu trong báo cáo. Hàng đầu tiên được tính là hàng 0.

Khi phân trang, yêu cầu đầu tiên không chỉ định độ lệch; hoặc tương đương với việc đặt độ lệch thành 0; yêu cầu đầu tiên trả về limit hàng đầu tiên. Yêu cầu thứ hai đặt độ lệch thành limit của yêu cầu đầu tiên; yêu cầu thứ hai trả về limit thứ hai của các hàng.

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

string (int64 format)

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

API cũng có thể trả về ít hàng hơn limit được yêu cầu, nếu không có nhiều giá trị phương diện như limit. Số lượng hàng có sẵn cho QueryReportTaskRequest còn bị giới hạn bởi giới hạn của ReportTask được liên kết. Một truy vấn có thể truy xuất tối đa ReportTask.limit hàng. Ví dụ: nếu ReportTask có giới hạn là 1.000, thì yêu cầu reportTasks.query có offset=900 và limit=500 sẽ trả về tối đa 100 hàng.

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

Nội dung phản hồi

Nội dung báo cáo tương ứng với một tác vụ báo cáo.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  }
}
Trường
dimensionHeaders[]

object (DimensionHeader)

Mô tả các cột phương diện. Số lượng DimensionHeader và thứ tự của DimensionHeader khớp với các phương diện có trong hàng.
metricHeaders[]

object (MetricHeader)

Mô tả các cột chỉ số. Số lượng MetricHeader và thứ tự của MetricHeader khớp với các chỉ số có trong hàng.
rows[]

object (Row)

Các hàng gồm tổ hợp giá trị thứ nguyên và giá trị chỉ số trong báo cáo.
totals[]

object (Row)

Nếu được yêu cầu, tổng giá trị của các chỉ số.
maximums[]

object (Row)

Nếu được yêu cầu, giá trị tối đa của các chỉ số.
minimums[]

object (Row)

Nếu được yêu cầu, giá trị tối thiểu của các chỉ số.
rowCount

integer

Tổng số hàng trong kết quả truy vấn.
metadata

object (ResponseMetaData)

Siêu dữ liệu cho báo cáo.

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