REST Resource: properties.reportTasks

Tài nguyên: ReportTask

Cấu hình tác vụ báo cáo cụ thể.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "reportMetadata": {
    object (ReportMetadata)
  }
}
Trường
name

string

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

object (ReportDefinition)

Không bắt buộc. Định nghĩa báo cáo để tìm nạp dữ liệu báo cáo, mô tả cấu trúc của báo cáo. Thẻ 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.
reportMetadata

object (ReportMetadata)

Chỉ có đầu ra. Siêu dữ liệu báo cáo cho một tác vụ báo cáo cụ thể, tác vụ này cung cấp thông tin về báo cáo. Báo cáo thường bao gồm những 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 được tạo, v.v.

ReportDefinition

Định nghĩa về cách chạy báo cáo.

Biểu diễn dưới dạng JSON 
{
  "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
}
Trường
dimensions[]

object (Dimension)

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

object (Metric)

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

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 của 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 phải chỉ định dateRanges này.
dimensionFilter

object (FilterExpression)

Không bắt buộc. Bộ lọc phương diện chỉ cho phép bạn yêu cầu một số giá trị phương diện cụ thể trong báo cáo. Để tìm hiểu thêm, hãy xem Nguyên tắc cơ bản về bộ lọc phương diện để biết ví dụ. Không thể sử dụng chỉ số trong bộ lọc này.
metricFilter

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 phương diện trong bộ lọc này.
offset

string (int64 format)

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

Khi tạo một tác vụ trong 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 trong bộ nhớ của Google Analytics để đưa vào báo cáo được tạo. Ví dụ: nếu có tổng cộng 300.000 hàng trong bộ nhớ Google Analytics, 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 10.000 hàng và mức bù trừ là 10.000.
limit

string (int64 format)

Không bắt buộc. Số hàng cần trả về trong Báo cáo. Nếu không chỉ định, hàm sẽ trả về 10.000 hàng. API 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. Ví dụ: có thể có ít hơn 300 giá trị 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 đặt limit thành giá trị cao hơn.
metricAggregations[]

enum (MetricAggregation)

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

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

string

Không bắt buộc. Mã đơn vị tiền tệ theo đị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.
cohortSpec

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 nhóm thuần tập trong yêu cầu, thì bạn phải cung cấp phương diện "nhóm thuần tập".
keepEmptyRows

boolean

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

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ể hiển thị trong báo cáo.

Ví dụ: nếu một tài sản không ghi nhận 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.

Phương diện

Thứ nguyên là thuộc tính dữ liệu của bạn. Ví dụ: thành phố của phương diện cho biết thành phố nơi một sự kiện bắt nguồn. Giá trị phương diện trong phản hồi của báo cáo là chuỗi; ví dụ: thành phố có thể là "Paris" hoặc "New York".

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}
Trường
name

string

Tên phương diện. Xem phần 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ợ (chẳng hạn như runReport và batchRunReports). Hãy xem mục Phương diện theo thời gian thực để biết danh sách các tên phương diện mà phương thức runRealtimeReport hỗ trợ. Xem mục Phương diện phễu để biết danh sách các tên phương diện mà phương thức runFunnelReport hỗ trợ.

Nếu bạn chỉ định dimensionExpression, name có thể là chuỗi bất kỳ mà 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 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.
dimensionExpression

object (DimensionExpression)

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

DimensionExpression

Được dùng để thể hiện một phương diện là kết quả của công thức của nhiều phương diện. Ví dụ về cách sử dụng: 1) lowerCase(dimension) 2) concatenate(dimension1, character, dimension2).

Biểu diễn dưới dạng JSON 
{

  // 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.
}
Trường
Trường hợp one_expression. Chỉ định một loại biểu thức phương diện cho DimensionExpression. one_expression chỉ có thể là một trong những trạng thái sau:
lowerCase

object (CaseExpression)

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

object (CaseExpression)

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

object (ConcatenateExpression)

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

CaseExpression

Được dùng để chuyển đổi một giá trị thứ nguyên sang một trường hợp duy nhất.

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

string

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

ConcatenateExpression

Dùng để kết hợp các giá trị phương diện thành một phương diện duy nhất.

Biểu diễn dưới dạng JSON 
{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}
Trường
dimensionNames[]

string

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

string

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

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

Chỉ số

Các chỉ số đo lường định lượng của một báo cáo. Ví dụ: chỉ số eventCount là tổng số sự kiện. Hệ thống cho phép yêu cầu có tối đa 10 chỉ số.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "expression": string,
  "invisible": boolean
}
Trường
name

string

Tên của chỉ số. Hãy xem phần Chỉ số API để biết danh sách tên chỉ số được hỗ trợ bởi các phương pháp báo cáo chính (chẳng hạn như runReport và batchRunReports). Xem phần 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ợ. Xem mục 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, name có thể là chuỗi bất kỳ mà 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ố đó là = 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.
expression

string

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

boolean

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

DateRange

Một nhóm ngày liền nhau: startDate, startDate + 1, ..., endDate. Hệ thống cho phép yêu cầu có tối đa 4 phạm vi ngày.

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

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 sẽ được suy ra dựa trên múi giờ báo cáo của tài sản.
endDate

string

Ngày kết thúc bao gồm cho 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 sẽ được suy ra dựa trên múi giờ báo cáo của tài sản.
name

string

Gán tên cho phạm vi ngày này. Phương diện dateRange được đánh giá bằng tên này trong phản hồi báo cáo. Nếu được đặt thì không được bắt đầu bằng date_range_ hoặc RESERVED_. Nếu không được đặt, 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.

FilterExpression

Để thể hiện bộ lọc phương diện hoặc chỉ số. Các trường trong cùng một FilterExpression cần phải là tất cả phương diện hoặc tất cả chỉ số.

Biểu diễn dưới dạng JSON 
{

  // 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.
}
Trường
Trường hợp expr. Chỉ định một loại biểu thức lọc cho FilterExpression. expr chỉ có thể là một trong những trạng thái sau:
andGroup

object (FilterExpressionList)

FilterExpressions trong andGroup có mối quan hệ AND.
orGroup

object (FilterExpressionList)

FilterExpression trong orGroup có mối quan hệ OR.
notExpression

object (FilterExpression)

FilterExpression KHÔNG phải là của notExpression.
filter

object (Filter)

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

FilterExpressionList

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

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

object (FilterExpression)

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

Lọc

Biểu thức để lọc các giá trị thứ nguyên hoặc chỉ số.

Biểu diễn dưới dạng JSON 
{
  "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.
}
Trường
fieldName

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ố.
Trường hợp one_filter. Chỉ định một loại bộ lọc cho Filter. one_filter chỉ có thể là một trong những trạng thái sau:
stringFilter

object (StringFilter)

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

object (InListFilter)

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

object (NumericFilter)

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

object (BetweenFilter)

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

StringFilter

Bộ lọc cho chuỗi

Biểu diễn dưới dạng JSON 
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
Trường
matchType

enum (MatchType)

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

string

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

boolean

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

MatchType

Kiểu khớp của bộ lọc chuỗi

Enum
MATCH_TYPE_UNSPECIFIED Không xác định
EXACT Khớp chính xác giá trị chuỗi.
BEGINS_WITH Bắt đầu bằng giá trị chuỗi.
ENDS_WITH Kết thúc bằng giá trị chuỗi.
CONTAINS Chứa giá trị chuỗi.
FULL_REGEXP Kết quả khớp đầy đủ cho biểu thức chính quy có giá trị chuỗi.
PARTIAL_REGEXP Khớp một phần cho biểu thức chính quy với giá trị chuỗi.

InListFilter

Kết quả phải nằm trong danh sách giá trị chuỗi.

Biểu diễn dưới dạng JSON 
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
Trường
values[]

string

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

boolean

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

NumericFilter

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

Biểu diễn dưới dạng JSON 
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
Trường
operation

enum (Operation)

Loại toán tử cho bộ lọc này.
value

object (NumericValue)

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

Hoạt động

Thao tác được áp dụng cho bộ lọc số

Enum
OPERATION_UNSPECIFIED Không xác định.
EQUAL Bằng
LESS_THAN Nhỏ hơn
LESS_THAN_OR_EQUAL Nhỏ hơn hoặc bằng
GREATER_THAN Lớn hơn
GREATER_THAN_OR_EQUAL Lớn hơn hoặc bằng

NumericValue

Để biểu diễn một số.

Biểu diễn dưới dạng JSON 
{

  // 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.
}
Trường
Trường hợp one_value. Một trong các giá trị số one_value chỉ được là một trong các giá trị sau:
int64Value

string (int64 format)

Giá trị số nguyên
doubleValue

number

Gấp đôi giá trị

BetweenFilter

Để thể hiện rằng kết quả phải nằm giữa hai số (bao gồm).

Biểu diễn dưới dạng JSON 
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
Trường
fromValue

object (NumericValue)

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

object (NumericValue)

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

MetricAggregation

Biểu thị hoạt động tổng hợp các chỉ số.

Enum
METRIC_AGGREGATION_UNSPECIFIED Toán tử chưa được chỉ định.
TOTAL Toán tử SUM.
MINIMUM Toán tử tối thiểu.
MAXIMUM Toán tử tối đa.
COUNT Toán tử đếm.

OrderBy

Thứ tự theo xác định cách sắp xếp các hàng trong phản hồi. Ví dụ: thứ tự các hàng theo số lượng sự kiện giảm dần là một thứ tự, còn thứ tự các hàng theo chuỗi tên sự kiện là một thứ tự khác.

Biểu diễn dưới dạng JSON 
{
  "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.
}
Trường
desc

boolean

Nếu đúng, hãy sắp xếp theo thứ tự giảm dần.
Trường hợp one_order_by. Chỉ định một loại thứ tự theo cho OrderBy. one_order_by chỉ có thể là một trong những trạng thái sau:
metric

object (MetricOrderBy)

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

object (DimensionOrderBy)

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

MetricOrderBy

Sắp xếp theo giá trị chỉ số.

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

string

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

DimensionOrderBy

Sắp xếp theo giá trị phương diện.

Biểu diễn dưới dạng JSON 
{
  "dimensionName": string,
  "orderType": enum (OrderType)
}
Trường
dimensionName

string

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

enum (OrderType)

Kiểm soát quy tắc sắp xếp giá trị phương diện.

OrderType

Quy tắc sắp xếp thứ tự các giá trị thứ nguyên chuỗi.

Enum
ORDER_TYPE_UNSPECIFIED Không xác định.
ALPHANUMERIC Sắp xếp chữ và số theo điểm mã Unicode. Ví dụ: "2" < "A" < "X" < "b" < "z".
CASE_INSENSITIVE_ALPHANUMERIC Sắp xếp chữ và số không phân biệt chữ hoa chữ thường theo điểm mã Unicode dạng chữ thường. Ví dụ: "2" < "A" < "b" < "X" < "z".
NUMERIC Các giá trị phương diện được chuyển đổi thành số trước khi sắp xếp. Ví dụ: trong sắp xếp Cố, "25" < "100" và "100" < "25" trong ALPHANUMERIC. Tất cả các giá trị phương diện không phải là số đều có giá trị thứ tự bằng nhau bên dưới tất cả các giá trị số.

CohortSpec

Thông số kỹ thuật của nhóm thuần tập cho báo cáo nhóm thuần tập.

Báo cáo nhóm thuần tập tạo ra một chuỗi thời gian về tỷ lệ giữ chân người dùng cho nhóm thuần tập. Ví dụ: bạn có thể chọn nhóm thuần tập gồm những người dùng đã được thu nạp vào tuần đầu tiên của tháng 9 và theo dõi nhóm thuần tập đó trong 6 tuần tiếp theo. Việc chọn những người dùng thu nạp được trong tuần đầu tiên của nhóm thuần tập tháng 9 được chỉ định trong đối tượng cohort. Việc theo dõi nhóm thuần tập đó trong 6 tuần tiếp theo được chỉ định trong đối tượng cohortsRange.

Để biết ví dụ, hãy xem Ví dụ về báo cáo nhóm thuần tập.

Phản hồi trong báo cáo có thể hiển thị một chuỗi thời gian hằng tuần, trong đó giả sử ứng dụng của bạn đã giữ lại 60% nhóm thuần tập này sau 3 tuần và 25% nhóm thuần tập này sau 6 tuần. Hai tỷ lệ phần trăm này có thể được tính theo chỉ số cohortActiveUsers/cohortTotalUsers và sẽ là các hàng riêng biệt trong báo cáo.

Biểu diễn dưới dạng JSON 
{
  "cohorts": [
    {
      object (Cohort)
    }
  ],
  "cohortsRange": {
    object (CohortsRange)
  },
  "cohortReportSettings": {
    object (CohortReportSettings)
  }
}
Trường
cohorts[]

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ì hệ thống có thể nhận dạng từng nhóm trong báo cáo theo tên của nhóm thuần tập đó.
cohortsRange

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 chỉ định một khoảng thời gian bù trừ để theo dõi các nhóm thuần tập.
cohortReportSettings

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.

Nhóm thuần tập

Xác định tiêu chí lựa chọn nhóm thuần tập. Nhóm thuần tập là một nhóm người dùng có chung một đặc điểm. Ví dụ: những người dùng có cùng firstSessionDate thuộc cùng một nhóm thuần tập.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "dimension": string,
  "dateRange": {
    object (DateRange)
  }
}
Trường
name

string

Chỉ định tên cho nhóm thuần tập này. Phương diện cohort được đánh giá bằng tên này trong phản hồi báo cáo. Nếu được đặt thì 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.
dimension

string

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

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 xuất hiện trong báo cáo nhóm thuần tập. Trong báo cáo nhóm thuần tập, dateRange này được mở rộng theo độ chi tiết và mức bù trừ có trong cohortsRange; dữ liệu sự kiện cho phạm vi ngày báo cáo mở rộng 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à dateRanges trong RunReportRequest hoặc RunPivotReportRequest phải không được chỉ định.

dateRange này thường phải phù hợp với mức độ 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 ranh giới 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ể được căn chỉnh thành 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.

CohortsRange

Thiết lập phạm vi ngày báo cáo mở rộng cho báo cáo nhóm thuần tập. Chỉ định một khoảng thời gian bù trừ để theo dõi các nhóm thuần tập.

Biểu diễn dưới dạng JSON 
{
  "granularity": enum (Granularity),
  "startOffset": integer,
  "endOffset": integer
}
Trường
granularity

enum (Granularity)

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

integer

startOffset chỉ định ngày bắt đầu của phạm vi ngày báo cáo mở rộng cho báo cáo nhóm thuần tập. startOffset thường được đặt thành 0 để báo cáo chứa dữ liệu từ hoạt động 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 sẽ 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 sẽ 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 sẽ là startDate của nhóm thuần tập cộng với startOffset * 30 ngày.
endOffset

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 báo cáo nhóm thuần tập. endOffset có thể là số nguyên dương bất kỳ, nhưng thường được đặt thành từ 5 đến 10 để báo cáo chứa dữ liệu về nhóm thuần tập trong vài 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 sẽ 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 sẽ 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 sẽ là endDate của nhóm thuần tập cộng với endOffset * 30 ngày.

Độ chi tiết

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

Enum
GRANULARITY_UNSPECIFIED Không được chỉ định.
DAILY Độ chi tiết hằng ngày. Thường được sử dụng nếu dateRange của nhóm thuần tập là một ngày và yêu cầu chứa cohortNthDay.
WEEKLY Độ chi tiết hằng tuần. Thường được dùng nếu dateRange của nhóm thuần tập kéo dài một tuần (bắt đầu vào Chủ Nhật và kết thúc vào thứ Bảy) và yêu cầu chứa cohortNthWeek.
MONTHLY Thông tin chi tiết hằng tháng. Thường được sử dụng nếu dateRange của nhóm thuần tập là một tháng và yêu cầu chứa cohortNthMonth.

CohortReportSettings

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

Biểu diễn dưới dạng JSON 
{
  "accumulate": boolean
}
Trường
accumulate

boolean

Nếu đúng, hãy tích luỹ kết quả từ ngày chạm đầu tiên đến ngày kết thúc. Không được hỗ trợ trong RunReportRequest.

ReportMetadata

Siêu dữ liệu báo cáo cho một tác vụ báo cáo cụ thể.

Biểu diễn dưới dạng JSON 
{
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "taskRowCount": integer,
  "errorMessage": string,
  "totalRowCount": integer
}
Trường
creationQuotaTokensCharged

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 ở trạng thái CREATING, nên khoản phí từ mã thông báo này sẽ được khắc phục khi một tác vụ báo cáo chuyển sang trạng thái ACTIVE hoặc FAILED.
state

enum (State)

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

string (Timestamp format)

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

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
taskRowCount

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 giới hạn của báo cáo hiện có.
errorMessage

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 quá trình tạo.
totalRowCount

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, thì các hàng đó 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ớ của Google Analytics.

Ví dụ: giả sử taskRowCount của báo cáo hiện tại là 20, 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ể tận dụng taskRowCount để phân trang thông qua 20 hàng đầu tiên. Để mở rộng báo cáo và bao gồm dữ liệu từ tất cả 30 hàng, bạn có thể tạo một tác vụ mới trong báo cáo bằng cách sử dụng giá trị totalRowCount để truy cập vào tập dữ liệu đầy đủ gồm 30 hàng.

Tiểu bang

Trạng thái xử lý.

Enum
STATE_UNSPECIFIED Trạng thái chưa xác định sẽ không bao giờ được sử dụng.
CREATING Báo cáo này hiện đang được tạo và sẽ có trong tương lai. Quá trình tạo sẽ diễn ra ngay sau lệnh gọi CreateReport.
ACTIVE Báo cáo đã được tạo hoàn chỉnh và sẵn sàng để truy vấn.
FAILED Không tạo được báo cáo.

Phương thức

create

 Bắt đầu tạo một nhiệm vụ báo cáo.

get

 Lấy siêu dữ liệu báo cáo về một tác vụ báo cáo cụ thể.

list

 Liệt kê tất cả các tác vụ báo cáo cho một tài sản.

query

 Truy xuất nội dung của tác vụ báo cáo.