REST Resource: properties.reportTasks

{
  "name": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "reportMetadata": {
    object (ReportMetadata)
  }
}

string

Chỉ có đầu ra. Giá trị nhận dạng. Tên tài nguyên của việc cần làm báo cáo được chỉ định trong quá trình tạo. Định dạng: "properties/{property}/reportTasks/{reportTask}"

object (ReportDefinition)

Không bắt buộc. Định nghĩa về báo cáo để tìm nạp dữ liệu báo cáo, phần này mô tả cấu trúc của báo cáo. Thông tin này thường bao gồm các trường sẽ được đưa vào báo cáo và tiêu chí sẽ được dùng để lọc dữ liệu.

object (ReportMetadata)

Chỉ có đầu ra. Siêu dữ liệu báo cáo cho một công việc báo cáo cụ thể, trong đó cung cấp thông tin về một báo cáo. Thông tin này thường bao gồm các thông tin sau: tên tài nguyên của báo cáo, trạng thái của báo cáo, dấu thời gian tạo báo cáo, v.v.

{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean
}

object (Dimension)

Không bắt buộc. Các phương diện được yêu cầu và hiển thị.

object (Metric)

Không bắt buộc. Các chỉ số được yêu cầu và được hiển thị.

object (DateRange)

Không bắt buộc. Phạm vi ngày của dữ liệu 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ì dữ liệu sự kiện cho những ngày bị 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. Trong yêu cầu nhóm thuần tập, bạn không được chỉ định dateRanges này.

object (FilterExpression)

Không bắt buộc. Bộ lọc phương diện cho phép bạn chỉ yêu cầu các giá trị phương diện cụ thể trong báo cáo. Để 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.

object (FilterExpression)

Không bắt buộc. Mệnh đề bộ lọc của 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. Không thể sử dụng các phương diện trong bộ lọc này.

string (int64 format)

Không bắt buộc. Số lượng hàng của hàng bắt đầu từ Bộ nhớ Google Analytics. Hàng đầu tiên được tính là hàng 0.

Khi bạn tạo một nhiệm vụ báo cáo, thông số offset và limit sẽ xác định một nhóm nhỏ các hàng dữ liệu từ bộ nhớ Google Analytics để đưa vào báo cáo đã tạo. Ví dụ: nếu bộ nhớ Google Analytics có tổng cộng 300.000 hàng, thì tác vụ báo cáo ban đầu có thể có 10.000 hàng đầu tiên với giới hạn là 10.000 hàng và mức chênh lệch là 0. Sau đó, một tác vụ báo cáo khác có thể bao gồm 10.000 hàng tiếp theo với giới hạn là 10.000 và độ lệch là 10.000.

string (int64 format)

Không bắt buộc. Số lượng hàng cần trả về trong Báo cáo. Nếu bạn không chỉ định thì 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. 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 nhiều hơn 300 hàng, ngay cả khi bạn đặt limit thành giá trị cao hơn.

enum (MetricAggregation)

Không bắt buộc. Tổng hợp các chỉ số. Các giá trị chỉ số được tổng hợp sẽ hiển thị trong những hàng mà giá trị tham số được đặt thành "RESERVED_(MetricTổng hợp)".

object (OrderBy)

Không bắt buộc. Chỉ định cách sắp xếp các hàng trong phản hồi.

string

Không bắt buộc. Mã đơn vị tiền tệ ở định dạng ISO4217, chẳng hạn như "AED", "USD", "JPY". Nếu trường này trống, báo cáo sẽ sử dụng đơn vị tiền tệ mặc định của tài sản.

object (CohortSpec)

Không bắt buộc. Nhóm thuần tập được liên kết với yêu cầu này. Nếu có một nhóm thuần tập trong yêu cầu, thì "nhóm thuần tập" bắt buộc phải có phương diện.

boolean

Không bắt buộc. Nếu giá trị là false hoặc không được chỉ định, thì hệ thống sẽ không trả về mỗi hàng có tất cả các chỉ số bằng 0. Nếu đúng, các hàng này sẽ được trả về nếu chúng không bị bộ lọc loại bỏ riêng biệt.

Bất kể chế độ cài đặt keepEmptyRows này là gì, chỉ những dữ liệu do tài sản Google Analytics (GA4) ghi lại mới có thể xuất hiện trong báo cáo.

Ví dụ: nếu một tài sản chưa bao giờ ghi lại sự kiện purchase, thì truy vấn cho phương diện eventName và chỉ số eventCount sẽ không có hàng chứa eventName: "purchase" và eventCount: 0.

{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}

string

Tên phương diện. Xem Phương diện API để biết danh sách tên phương diện được các phương pháp báo cáo chính hỗ trợ như runReport và batchRunReports. Hãy xem mục Phương diện theo thời gian thực để biết danh sách tên phương diện được phương thức runRealtimeReport hỗ trợ. Xem phần Phương diện phễu để biết danh sách tên phương diện được phương thức runFunnelReport hỗ trợ.

Nếu bạn chỉ định dimensionExpression, thì name có thể là bất kỳ chuỗi nào bạn muốn trong bộ ký tự cho phép. Ví dụ: nếu dimensionExpression nối country và city, bạn có thể gọi phương diện đó là countryAndCity. Tên phương diện mà bạn chọn phải khớp với biểu thức chính quy ^[a-zA-Z0-9_]$.

Các phương diện được name tham chiếu trong dimensionFilter, orderBys, dimensionExpression và pivots.

object (DimensionExpression)

Một phương diện có thể là kết quả của biểu thức của nhiều phương diện. Ví dụ: phương diện "quốc gia, thành phố": nối(quốc gia, ", ", thành phố).

{

  // Union field one_expression can be only one of the following:
  "lowerCase": {
    object (CaseExpression)
  },
  "upperCase": {
    object (CaseExpression)
  },
  "concatenate": {
    object (ConcatenateExpression)
  }
  // End of list of possible types for union field one_expression.
}

object (CaseExpression)

Được dùng để chuyển đổi một giá trị thứ nguyên thành chữ thường.

object (CaseExpression)

Được dùng để chuyển đổi một giá trị thứ nguyên thành chữ hoa.

object (ConcatenateExpression)

Dùng để kết hợp các giá trị phương diện vào một phương diện duy nhất. Ví dụ: phương diện "quốc gia, thành phố": nối(quốc gia, ", ", thành phố).

{
  "dimensionName": string
}

string

Tên phương diện. Tên này phải tham chiếu lại tên trong trường phương diện của yêu cầu.

{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}

string

Tên phương diện. Các tên này phải tham chiếu lại tên trong trường phương diện của yêu cầu.

string

Dấu phân cách được đặt giữa các tên phương diện.

Dấu phân cách thường là các ký tự đơn, chẳng hạn như "|" hoặc "," nhưng có thể là các chuỗi dài hơn. Nếu một giá trị phương diện chứa dấu phân cách, thì cả hai dấu phân cách này sẽ xuất hiện mà không có sự khác biệt. Ví dụ: nếu giá trị phương diện 1 = "US,FR", giá trị phương diện 2 = "JP" và dấu phân cách = ", thì phản hồi sẽ chứa "US,FR,JP".

{
  "name": string,
  "expression": string,
  "invisible": boolean
}

string

Tên của chỉ số. Xem Chỉ số API để biết danh sách tên chỉ số được các phương pháp báo cáo chính như runReport và batchRunReports hỗ trợ. Hãy xem bài viết Chỉ số theo thời gian thực để biết danh sách tên chỉ số mà phương thức runRealtimeReport hỗ trợ. Hãy xem phần Chỉ số phễu để biết danh sách tên các chỉ số mà phương thức runFunnelReport hỗ trợ.

Nếu bạn chỉ định expression, thì name có thể là bất kỳ chuỗi nào bạn muốn trong bộ ký tự cho phép. Ví dụ: nếu expression là screenPageViews/sessions, bạn có thể gọi tên của chỉ số đó = viewsPerSession. Tên chỉ số mà bạn chọn phải khớp với biểu thức chính quy ^[a-zA-Z0-9_]$.

Các chỉ số được name tham chiếu trong metricFilter, orderBys và chỉ số expression.

string

Biểu thức toán học cho các chỉ số phái sinh. Ví dụ: chỉ số Số sự kiện trên mỗi người dùng là eventCount/totalUsers.

boolean

Cho biết liệu một chỉ số có bị ẩn trong phản hồi báo cáo hay không. Nếu một chỉ số không xuất hiện, thì chỉ số đó sẽ không tạo ra cột trong phản hồi, nhưng có thể được dùng trong metricFilter, orderBys hoặc chỉ số expression.

{
  "startDate": string,
  "endDate": string,
  "name": string
}

string

Ngày bắt đầu bao gồm cho truy vấn ở định dạng YYYY-MM-DD. Không được sau endDate. Định dạng NdaysAgo, yesterday hoặc today cũng được chấp nhận và trong trường hợp đó, ngày được suy ra dựa trên múi giờ báo cáo của tài sản.

string

Ngày kết thúc toàn diện của truy vấn ở định dạng YYYY-MM-DD. Không được trước startDate. Định dạng NdaysAgo, yesterday hoặc today cũng được chấp nhận và trong trường hợp đó, ngày được suy ra dựa trên múi giờ báo cáo của tài sản.

string

Chỉ định tên cho phạm vi ngày này. Phương diện dateRange có giá trị đối với tên này trong một phản hồi báo cáo. Nếu đặt giá trị, không được bắt đầu bằng date_range_ hoặc RESERVED_. Nếu bạn không đặt chính sách này, các phạm vi ngày sẽ được đặt tên theo chỉ mục dựa trên 0 trong yêu cầu: date_range_0, date_range_1, v.v.

{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FilterExpressionList)
  },
  "orGroup": {
    object (FilterExpressionList)
  },
  "notExpression": {
    object (FilterExpression)
  },
  "filter": {
    object (Filter)
  }
  // End of list of possible types for union field expr.
}

object (FilterExpressionList)

Các biểu thức bộ lọc trong andGroup có quan hệ AND.

object (FilterExpressionList)

Các biểu thức bộ lọc trong orGroup có quan hệ OR.

object (FilterExpression)

Biểu thức bộ lọc KHÔNG phải là biểu thức.

object (Filter)

Bộ lọc dữ liệu gốc. Trong cùng một FilterExpression, tất cả tên trường của bộ lọc cần phải là tất cả phương diện hoặc tất cả chỉ số.

{
  "expressions": [
    {
      object (FilterExpression)
    }
  ]
}

object (FilterExpression)

Danh sách biểu thức lọc.

{
  "fieldName": string,

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}

string

Tên phương diện hoặc tên chỉ số. Phải là tên được xác định trong phương diện hoặc chỉ số.

object (StringFilter)

Bộ lọc liên quan đến chuỗi.

object (InListFilter)

Bộ lọc cho các giá trị trong danh sách.

object (NumericFilter)

Bộ lọc cho các giá trị số hoặc ngày tháng.

object (BetweenFilter)

Bộ lọc cho giữa hai giá trị.

{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}

enum (MatchType)

Kiểu khớp cho bộ lọc này.

string

Giá trị chuỗi dùng để so khớp.

boolean

Nếu đúng, giá trị chuỗi có phân biệt chữ hoa chữ thường.

{
  "values": [
    string
  ],
  "caseSensitive": boolean
}

string

Danh sách các giá trị chuỗi. Không được để trống.

boolean

Nếu đúng, giá trị chuỗi có phân biệt chữ hoa chữ thường.

{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}

enum (Operation)

Loại thao tác cho bộ lọc này.

object (NumericValue)

Giá trị số hoặc giá trị ngày tháng.

{

  // Union field one_value can be only one of the following:
  "int64Value": string,
  "doubleValue": number
  // End of list of possible types for union field one_value.
}

string (int64 format)

Giá trị số nguyên

number

Gấp đôi giá trị

{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}

object (NumericValue)

Bắt đầu bằng số này.

object (NumericValue)

Kết thúc bằng số này.

{
  "desc": boolean,

  // Union field one_order_by can be only one of the following:
  "metric": {
    object (MetricOrderBy)
  },
  "dimension": {
    object (DimensionOrderBy)
  }
  // End of list of possible types for union field one_order_by.
}

boolean

Nếu đúng, hãy sắp xếp theo thứ tự giảm dần.

object (MetricOrderBy)

Sắp xếp kết quả theo giá trị của một chỉ số.

object (DimensionOrderBy)

Sắp xếp kết quả theo giá trị của một phương diện.

{
  "metricName": string
}

string

Tên chỉ số trong yêu cầu sắp xếp theo.

{
  "dimensionName": string,
  "orderType": enum (OrderType)
}

string

Tên phương diện trong yêu cầu sắp xếp theo.

enum (OrderType)

Kiểm soát quy tắc về thứ tự giá trị phương diện.

{
  "cohorts": [
    {
      object (Cohort)
    }
  ],
  "cohortsRange": {
    object (CohortsRange)
  },
  "cohortReportSettings": {
    object (CohortReportSettings)
  }
}

object (Cohort)

Xác định tiêu chí lựa chọn để nhóm người dùng thành các nhóm thuần tập.

Hầu hết các báo cáo nhóm thuần tập chỉ xác định một nhóm thuần tập. Nếu bạn chỉ định nhiều nhóm thuần tập, thì báo cáo có thể nhận dạng từng nhóm thuần tập theo tên.

object (CohortsRange)

Báo cáo nhóm thuần tập theo dõi các nhóm thuần tập trong một phạm vi ngày báo cáo mở rộng. Phạm vi này xác định thời lượng bù trừ để theo dõi các nhóm thuần tập.

object (CohortReportSettings)

Các chế độ cài đặt không bắt buộc cho báo cáo nhóm thuần tập.

{
  "name": string,
  "dimension": string,
  "dateRange": {
    object (DateRange)
  }
}

string

Chỉ định tên cho nhóm thuần tập này. Phương diện cohort có giá trị đối với tên này trong một phản hồi báo cáo. Nếu đặt giá trị, không được bắt đầu bằng cohort_ hoặc RESERVED_. Nếu bạn không đặt chính sách này, các nhóm thuần tập sẽ được đặt tên theo chỉ mục dựa trên 0 cohort_0, cohort_1, v.v.

string

Phương diện mà nhóm thuần tập sử dụng. Bắt buộc và chỉ hỗ trợ firstSessionDate.

object (DateRange)

Nhóm thuần tập chọn những người dùng có ngày tiếp xúc đầu tiên nằm trong khoảng từ ngày bắt đầu đến ngày kết thúc được xác định trong dateRange. dateRange này không chỉ định phạm vi ngày đầy đủ của dữ liệu sự kiện có trong báo cáo nhóm thuần tập. Trong một báo cáo nhóm thuần tập, dateRange này được mở rộng theo mức độ chi tiết và mức chênh lệch có trong cohortsRange; dữ liệu sự kiện cho phạm vi ngày báo cáo mở rộng sẽ xuất hiện trong báo cáo nhóm thuần tập.

Trong yêu cầu nhóm thuần tập, dateRange này là bắt buộc và không được chỉ định dateRanges trong RunReportRequest hoặc RunPivotReportRequest.

dateRange này thường phải phù hợp với độ chi tiết của nhóm thuần tập. Nếu CohortsRange sử dụng độ chi tiết hằng ngày, thì dateRange này có thể là một ngày. Nếu CohortsRange sử dụng độ chi tiết hằng tuần, thì dateRange này có thể được điều chỉnh theo giới hạn một tuần, bắt đầu từ Chủ Nhật và kết thúc vào thứ Bảy. Nếu CohortsRange sử dụng độ chi tiết hằng tháng, thì dateRange này có thể điều chỉnh theo một tháng, bắt đầu từ ngày đầu tiên và kết thúc vào ngày cuối cùng của tháng.

{
  "granularity": enum (Granularity),
  "startOffset": integer,
  "endOffset": integer
}

enum (Granularity)

Bắt buộc. Độ chi tiết được dùng để diễn giải startOffset và endOffset cho phạm vi ngày báo cáo mở rộng cho một báo cáo nhóm thuần tập.

integer

startOffset chỉ định ngày bắt đầu của phạm vi ngày báo cáo mở rộng cho một báo cáo nhóm thuần tập. startOffset thường được đặt thành 0 để các báo cáo chứa dữ liệu từ việc thu nạp nhóm thuần tập trở đi.

Nếu granularity là DAILY, thì startDate của phạm vi ngày báo cáo mở rộng là startDate của nhóm thuần tập cộng với startOffset ngày.

Nếu granularity là WEEKLY, thì startDate của phạm vi ngày báo cáo mở rộng là startDate của nhóm thuần tập cộng với startOffset * 7 ngày.

Nếu granularity là MONTHLY, thì startDate của phạm vi ngày báo cáo mở rộng là startDate của nhóm thuần tập cộng với startOffset * 30 ngày.

integer

Bắt buộc. endOffset chỉ định ngày kết thúc của phạm vi ngày báo cáo mở rộng cho một báo cáo nhóm thuần tập. endOffset có thể là bất kỳ số nguyên dương nào, nhưng thường được đặt từ 5 đến 10 để báo cáo chứa dữ liệu về nhóm thuần tập trong một số khoảng thời gian chi tiết tiếp theo.

Nếu granularity là DAILY, thì endDate của phạm vi ngày báo cáo mở rộng là endDate của nhóm thuần tập cộng với endOffset ngày.

Nếu granularity là WEEKLY, thì endDate của phạm vi ngày báo cáo mở rộng là endDate của nhóm thuần tập cộng với endOffset * 7 ngày.

Nếu granularity là MONTHLY, thì endDate của phạm vi ngày báo cáo mở rộng là endDate của nhóm thuần tập cộng với endOffset * 30 ngày.

{
  "accumulate": boolean
}

boolean

Nếu đúng, thì kết quả sẽ tích luỹ từ ngày tiếp xúc đầu tiên cho đến ngày kết thúc. Chưa hỗ trợ ở RunReportRequest.

{
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "taskRowCount": integer,
  "errorMessage": string,
  "totalRowCount": integer
}

integer

Chỉ có đầu ra. Tổng mã thông báo hạn mức được tính trong quá trình tạo báo cáo. Vì số lượng mã thông báo này dựa trên hoạt động từ trạng thái CREATING, nên khoản phí mã thông báo này sẽ được cố định sau khi một nhiệm vụ báo cáo chuyển sang trạng thái ACTIVE hoặc FAILED.

enum (State)

Chỉ có đầu ra. Trạng thái hiện tại của nhiệm vụ báo cáo này.

string (Timestamp format)

Chỉ có đầu ra. Thời điểm gọi reportTasks.create và báo cáo bắt đầu trạng thái CREATING.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".

integer

Chỉ có đầu ra. Tổng số hàng trong kết quả báo cáo. Trường này sẽ được điền khi trạng thái đang hoạt động. Bạn có thể sử dụng taskRowCount để phân trang trong phạm vi báo cáo hiện có.

string

Chỉ có đầu ra. Thông báo lỗi sẽ được điền nếu tác vụ báo cáo không thành công trong khi tạo.

integer

Chỉ có đầu ra. Tổng số hàng trong bộ nhớ Google Analytics. Nếu bạn muốn truy vấn các hàng dữ liệu khác ngoài báo cáo hiện tại, các hàng này có thể bắt đầu một tác vụ báo cáo mới dựa trên totalRowCount.

taskRowCount thể hiện số hàng cụ thể liên quan đến báo cáo hiện tại, trong khi totalRowCount bao gồm tổng số hàng trên tất cả dữ liệu được truy xuất từ bộ nhớ Google Analytics.

Ví dụ: giả sử taskRowCount của báo cáo hiện tại là 20, sẽ hiển thị dữ liệu từ 20 hàng đầu tiên. Đồng thời, totalRowCount là 30, cho biết sự hiện diện của dữ liệu cho cả 30 hàng. Bạn có thể sử dụng taskRowCount để phân trang thông qua 20 hàng ban đầu. Để mở rộng báo cáo và thêm dữ liệu từ tất cả 30 hàng, bạn có thể tạo một công việc báo cáo mới bằng cách sử dụng totalRowCount để truy cập vào tập hợp đầy đủ gồm 30 hàng giá trị dữ liệu.