Method: properties.reportTasks.query

Truy xuất nội dung của công việc 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 HOẠT ĐỘNG. Phương thức này sẽ trả về một 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ề hàng dạng bảng & các giá trị cột 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 có 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ố lượng 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, đặt giá trị bù trừ bằng 0; yêu cầu đầu tiên sẽ trả về limit hàng đầu tiên. Yêu cầu thứ hai thiết lập độ lệch thành limit của yêu cầu đầu tiên; yêu cầu thứ hai sẽ trả về limit thứ hai của hàng.

Để tìm hiểu thêm về thông số phân trang này, hãy xem nội dung 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 không chỉ định, hệ thống sẽ trả về 10.000 hàng. API sẽ 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 hàng. limit phải là số dương.

API cũng có thể trả về ít hàng hơn so với 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 bị giới hạn nhiều hơn theo giới hạn của ReportTask được liên kết. Truy vấn có thể truy xuất nhiều nhất là hàng ReportTask.limit. Ví dụ: nếu ReportTask có giới hạn là 1.000, thì yêu cầu reportTasks.query với offset=900 và limited=500 sẽ trả về tối đa 100 hàng.

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

Nội dung phản hồi

Nội dung báo cáo tương ứng với một nhiệm 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 Kích thước và thứ tự của tham số này khớp với các phương diện có trong các hàng.
metricHeaders[]

object (MetricHeader)

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

object (Row)

Các hàng gồm các tổ hợp giá trị phương diện và giá trị chỉ số trong báo cáo.
totals[]

object (Row)

Đây là giá trị tổng của các chỉ số (nếu được yêu cầu).
maximums[]

object (Row)

Giá trị tối đa của các chỉ số (nếu được yêu cầu).
minimums[]

object (Row)

Giá trị tối thiểu của các chỉ số (nếu được yêu cầu).
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

ResponseMetaData

Siêu dữ liệu của câu trả lời chứa thông tin bổ sung về nội dung bị báo cáo.

Biểu diễn dưới dạng JSON 
{
  "dataLossFromOtherRow": boolean,
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
Trường
dataLossFromOtherRow

boolean

Nếu đúng, cho biết một số nhóm kết hợp phương diện được tổng hợp vào "(other)" hàng. Điều này có thể xảy ra đối với những báo cáo có số lượng giá trị riêng biệt cao.

Thông số siêu dữ liệu dataLossFromOtherRow được điền dựa trên bảng dữ liệu tổng hợp được dùng trong báo cáo. Thông số này sẽ được điền chính xác bất kể bộ lọc và giới hạn trong báo cáo.

Ví dụ: hàng (other) có thể bị loại bỏ khỏi báo cáo vì yêu cầu chứa bộ lọc cho sessionSource = google. Thông số này sẽ vẫn được điền sẵn nếu dữ liệu bị mất từ hàng khác trong dữ liệu tổng hợp đầu vào dùng để tạo báo cáo này.

Để tìm hiểu thêm, hãy xem bài viết Giới thiệu về hàng (other) và hoạt động lấy mẫu dữ liệu.
schemaRestrictionResponse

object (SchemaRestrictionResponse)

Mô tả các quy định hạn chế của giản đồ được chủ động thực thi trong quá trình tạo báo cáo này. Để tìm hiểu thêm, hãy xem bài viết Quản lý quyền truy cập và quy định hạn chế về dữ liệu.
currencyCode

string

Mã đơn vị tiền tệ được sử dụng trong báo cáo này. Được sử dụng khi định dạng các chỉ số đơn vị tiền tệ như purchaseRevenue để trực quan hoá. Nếu CurrencyCode được chỉ định trong yêu cầu, thì tham số phản hồi này sẽ lặp lại tham số yêu cầu; nếu không, tham số phản hồi này sẽ là CurrencyCode hiện tại của tài sản.

Mã đơn vị tiền tệ là mã hoá chuỗi các loại đơn vị tiền tệ theo tiêu chuẩn ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217); ví dụ: "USD", "EUR", "JPY". Để tìm hiểu thêm, hãy xem https://support.google.com/analytics/answer/9796179.
timeZone

string

Múi giờ hiện tại của cơ sở lưu trú này. Nhằm dùng để diễn giải các phương diện dựa trên thời gian như hour và minute. Đượ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".
emptyReason

string

Nếu bạn chỉ định lý do trống thì báo cáo sẽ trống vì lý do này.
subjectToThresholding

boolean

Nếu subjectToThresholding là true, báo cáo này sẽ tuân theo ngưỡng và chỉ trả về dữ liệu đáp ứng các ngưỡng tổng hợp tối thiểu. Yêu cầu có thể bị áp dụng ngưỡng và sẽ không có dữ liệu nào bị thiếu trong báo cáo. Điều này xảy ra khi tất cả dữ liệu đều vượt quá ngưỡng. Để tìm hiểu thêm, hãy xem bài viết Ngưỡng dữ liệu và Giới thiệu về thông tin nhân khẩu học và mối quan tâm.

SchemaRestrictionResponse

Các quy tắc hạn chế giản đồ được chủ động thực thi khi tạo báo cáo này. Để tìm hiểu thêm, hãy xem bài viết Quản lý quyền truy cập và quy định hạn chế về dữ liệu.

Biểu diễn dưới dạng JSON 
{
  "activeMetricRestrictions": [
    {
      object (ActiveMetricRestriction)
    }
  ]
}
Trường
activeMetricRestrictions[]

object (ActiveMetricRestriction)

Tất cả các quy định hạn chế được chủ động thực thi khi tạo báo cáo. Ví dụ: purchaseRevenue luôn có loại quy định hạn chế là REVENUE_DATA. Tuy nhiên, hạn chế phản hồi đang hoạt động này chỉ được điền nếu vai trò tuỳ chỉnh của người dùng không cho phép truy cập vào REVENUE_DATA.

ActiveMetricRestriction

Một chỉ số bị hạn chế chủ động trong việc tạo báo cáo.

Biểu diễn dưới dạng JSON 
{
  "restrictedMetricTypes": [
    enum (RestrictedMetricType)
  ],
  "metricName": string
}
Trường
restrictedMetricTypes[]

enum (RestrictedMetricType)

Lý do hạn chế chỉ số này.
metricName

string

Tên của chỉ số bị hạn chế.

RestrictedMetricType

Các danh mục dữ liệu mà bạn có thể bị hạn chế xem trên một số tài sản GA4 nhất định.

Enum
RESTRICTED_METRIC_TYPE_UNSPECIFIED Loại không xác định.
COST_DATA Chỉ số về chi phí, chẳng hạn như adCost.
REVENUE_DATA Chỉ số doanh thu, chẳng hạn như purchaseRevenue.