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 ACTIVE (Đ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ị cột và hàng 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 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ố 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 độ dời; hoặc tương đương, đặt độ dời thành 0; yêu cầu đầu tiên trả về limit đầu tiên của các hàng. Yêu cầu thứ hai đặt độ dời 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ề thông 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 sẽ 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 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 thêm theo 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 với offset=900 và limit=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 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 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 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 kết hợp giá trị phương diện và giá trị chỉ số trong báo cáo.
totals[]

object (Row)

Tổng giá trị 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 của 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 phản hồi chứa thêm thông tin về nội dung báo cáo.

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

boolean

Nếu là true, cho biết một số nhóm kết hợp phương diện được gộp vào hàng "(other)". Điều này có thể xảy ra đối với các báo cáo có lượng số 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ị xoá khỏi báo cáo vì yêu cầu chứa một bộ lọc trên sessionSource = google. Thông số này vẫn sẽ được điền sẵn nếu dữ liệu bị mất từ hàng khác 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à tính năng lấy mẫu dữ liệu.
samplingMetadatas[]

object (SamplingMetadata)

Nếu kết quả báo cáo này là đã lấy mẫu, thì chỉ số này mô tả tỷ lệ phần trăm sự kiện được sử dụng trong báo cáo này. Hệ thống sẽ điền một samplingMetadatas cho mỗi phạm vi ngày. Mỗi samplingMetadatas tương ứng với một phạm vi ngày theo thứ tự các phạm vi ngày đã được chỉ định trong yêu cầu.

Tuy nhiên, nếu kết quả không được lấy mẫu, trường này sẽ không được xác định.
schemaRestrictionResponse

object (SchemaRestrictionResponse)

Mô tả các quy định hạn chế về giản đồ được thực thi tích cực 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 tắc 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. Dùng để định dạng các chỉ số tiền tệ như purchaseRevenue để tạo hình ảnh trực quan. Nếu currencyCode được chỉ định trong yêu cầu, 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 là currencyCode hiện tại của tài sản.

Mã đơn vị tiền tệ là mã hoá chuỗi của 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 bài viết https://support.google.com/analytics/answer/9796179.
timeZone

string

Múi giờ hiện tại của cơ sở lưu trú. 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_York" hoặc "Asia/Tokyo".
emptyReason

string

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

boolean

Nếu subjectToThresholding là đúng, 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. Một yêu cầu có thể phải chịu ngưỡng và không có dữ liệu nào trong báo cáo. Điều này xảy ra khi tất cả dữ liệu đều cao hơn 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ề dữ liệu nhân khẩu học và mối quan tâm.

SchemaRestrictionResponse

Các quy định hạn chế về giản đồ được thực thi tích cực 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 tắc 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ế đều được thực thi tích cực trong quá trình 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, quy tắc 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ế khi 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 Google Analytics.

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