REST Resource: properties.reportTasks

Tài nguyên: ReportTask

Một 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 tác vụ báo cáo được chỉ định trong quá trình tạo. Định dạng: "properties/{property}/reportTasks/{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ường thì yêu cầu này bao gồm các trường sẽ có trong 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ể, cung cấp thông tin về một báo cáo. Thông thường, siêu dữ liệu này 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 tạo báo cá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,
  "samplingLevel": enum (SamplingLevel)
}
Trường
dimensions[]

object (Dimension)

Không bắt buộc. Phương diện được yêu cầu và 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 dải ngày, mỗi hàng phản hồi sẽ chứa một chỉ mục dải ngày dựa trên số 0. Nếu hai phạm vi ngày trùng nhau, dữ liệu sự kiện cho những ngày trùng nhau 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 về nhóm, bạn không được chỉ định dateRanges này.
dimensionFilter

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 Các nguyên tắc cơ bản về bộ lọc phương diện để xem ví dụ. Bạn 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 đề having trong SQL. Bạn 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ố 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ụ báo cáo, các tham số offset và limit sẽ xác định tập hợp con gồm các hàng dữ liệu trong bộ nhớ Google Analytics sẽ được đưa vào báo cáo đã tạo. Ví dụ: nếu có tổng cộng 300.000 hàng trong bộ nhớ của Google Analytics, thì tác vụ báo cáo ban đầu có thể có 10.000 hàng đầu tiên với hạn mức là 10.000 và độ 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.
limit

string (int64 format)

Không bắt buộc. Số hàng sẽ trả về trong 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. Ví dụ: phương diện country có ít hơn 300 giá trị có thể có, vì vậy, khi chỉ báo cáo về country, bạn không thể nhận được hơn 300 hàng, ngay cả khi bạn đặt limit thành một 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ố được tổng hợp sẽ xuất hiện trong những hàng có dimensionValues được đặt thành "RESERVED_(MetricAggregation)".
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 когорта đượ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ì bạn phải có phương diện "nhóm thuần tập".
keepEmptyRows

boolean

Không bắt buộc. Nếu là false hoặc không được chỉ định, thì mỗi hàng có tất 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 không bị bộ lọc xoá riêng.

Bất kể chế độ cài đặt keepEmptyRows này, chỉ dữ liệu do tài sản Google Analytics 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 không 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 nào chứa eventName: "purchase" và eventCount: 0.
samplingLevel

enum (SamplingLevel)

Không bắt buộc. Cấp lấy mẫu của báo cáo.

Phương diện

Thứ nguyên là thuộc tính dữ liệu của bạn. Ví dụ: phương diện thành phố 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 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 của phương diện. Hãy xem Phương diện API để biết danh sách tên phương diện được các phương thức báo cáo chính hỗ trợ, chẳng hạn như runReport và batchRunReports. Hãy xem Phương diện theo thời gian thực để biết danh sách tên phương diện mà phương thức runRealtimeReport hỗ trợ. Hãy xem Phương diện trong phễu để biết danh sách tên phương diện mà phương thức runFunnelReport hỗ trợ.

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

object (DimensionExpression)

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

DimensionExpression

Dùng để biểu thị một phương diện là kết quả của công thức gồm nhiều phương diện. Ví dụ về cách sử dụng: 1) lowerCase(phương diện) 2) concatenate(phương diện1, ký hiệu, phương diện2).

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 nhóm 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)

Dùng để chuyển đổi một giá trị phương diện thành chữ thường.
upperCase

object (CaseExpression)

Được dùng để chuyển đổi một giá trị phương diệ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 "quốc gia, thành phố": concatenate(quốc gia, ", ", thành phố).

CaseExpression

Được dùng để chuyển đổi một giá trị phương diện thành 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 lại đến một 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 của phương diện. Các tên này phải tham chiếu lại đến tên trong trường phương diện của yêu cầu.
delimiter

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 như "|" hoặc ",", nhưng cũ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 sẽ xuất hiện trong phản hồi mà không có sự phân 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".

Chỉ số

Các số đo định lượng của một báo cáo. Ví dụ: chỉ số eventCount là tổng số sự kiện. Bạn có thể yêu cầu 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 Chỉ số API để biết danh sách tên chỉ số được các phương thức báo cáo chính hỗ trợ, chẳng hạn như runReport và batchRunReports. Hãy 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ợ. Hãy xem Chỉ số trong phễu để biết danh sách tên chỉ số mà phương thức runFunnelReport hỗ trợ.

Nếu bạn chỉ định expression, thì name có thể là chuỗi bất kỳ mà bạn muốn trong bộ ký tự được 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 tham chiếu theo name trong metricFilter, orderBys và chỉ số expression.
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.
invisible

boolean

Cho biết liệu một chỉ số có xuất hiện trong 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 một cột trong phản hồi, nhưng có thể được dùng trong metricFilter, orderBys hoặc một chỉ số expression.

DateRange

Một tập hợp liên tục các ngày: startDate, startDate + 1, ..., endDate. Bạn được phép yêu cầu tối đa 4 dải 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 ngày endDate. Định dạng NdaysAgo, yesterday hoặc today cũng được chấp nhận. Trong trường hợp đó, ngày sẽ được suy luận 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 cả ngày này) cho truy vấn ở định dạng YYYY-MM-DD. Không được trước ngày startDate. Định dạng NdaysAgo, yesterday hoặc today cũng được chấp nhận. Trong trường hợp đó, ngày sẽ được suy luận dựa trên múi giờ báo cáo của tài sản.
name

string

Chỉ định tên cho phạm vi ngày này. Phương diện dateRange được định giá theo tên này trong phản hồi báo cáo. Nếu được đặt, 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 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 nhóm expr. Chỉ định một loại biểu thức bộ 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à notExpression.
filter

object (Filter)

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

FilterExpressionList

Danh sách các biểu thức bộ 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 bộ lọc.

Lọc

Một biểu thức để lọc giá trị phương diệ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)
  },
  "emptyFilter": {
    object (EmptyFilter)
  }
  // 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 nhóm 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 giá trị ngày.
betweenFilter

object (BetweenFilter)

Bộ lọc cho khoảng giữa hai giá trị.
emptyFilter

object (EmptyFilter)

Bộ lọc cho các giá trị trống, chẳng hạn như giá trị "(not set)" và "".

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 dùng để so khớp.
caseSensitive

boolean

Nếu là true, giá trị chuỗi sẽ phân biệt chữ hoa chữ thường.

MatchType

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

Enum
MATCH_TYPE_UNSPECIFIED Không xác định
EXACT Giá trị chuỗi khớp chính xác.
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 Khớp hoàn toàn biểu thức chính quy với 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 các 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 là true, giá trị chuỗi sẽ phân biệt chữ hoa chữ thường.

NumericFilter

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

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

enum (Operation)

Loại thao tác 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 nhau
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 thị 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 nhóm one_value. Một trong các giá trị số one_value chỉ có thể là một trong những giá trị sau:
int64Value

string (int64 format)

Giá trị nguyên
doubleValue

number

Gấp đôi giá trị

BetweenFilter

Để thể hiện rằng kết quả cần nằm trong khoảng giữa hai số (tính cả hai số).

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.

EmptyFilter

Loại này không có trường nào.

Lọc các giá trị trống.

MetricAggregation

Biểu thị việc tổng hợp các chỉ số.

Enum
METRIC_AGGREGATION_UNSPECIFIED Nhà mạng không xác đị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

Order by xác định cách sắp xếp các hàng trong phản hồi. Ví dụ: sắp xếp các hàng theo số lượng sự kiện giảm dần là một cách sắp xếp, còn sắp xếp các hàng theo chuỗi tên sự kiện là một cách sắp xếp 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, sắp xếp theo thứ tự giảm dần.
Trường nhóm one_order_by. Chỉ định một loại thứ tự sắp xếp 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 theo.

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 theo.
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 các giá trị phương diện chuỗi.

Enum
ORDER_TYPE_UNSPECIFIED Không xác định.
ALPHANUMERIC Sắp xếp theo thứ tự 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 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 chế độ sắp xếp NUMERIC, "25" < "100" và trong chế độ sắp xếp ALPHANUMERIC, "100" < "25". Tất cả các giá trị phương diện không phải là số đều có giá trị sắp xếp bằng nhau bên dưới tất cả các giá trị số.

CohortSpec

Quy cách 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 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 người dùng được thu nạp trong tuần đầu tiên của tháng 9 và theo dõi nhóm đó trong 6 tuần tiếp theo. Việc chọn nhóm thuần tập gồm những người dùng được thu nạp trong tuần đầu tiên của tháng 9 được chỉ định trong đối tượng cohort. Việc theo dõi nhóm người dùng đó trong 6 tuần tiếp theo được chỉ định trong đối tượng cohortsRange.

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

Phản hồi báo cáo có thể cho thấy chuỗi thời gian hằng tuần, trong đó giả sử ứng dụng của bạn đã giữ chân được 60% nhóm này sau 3 tuần và 25% nhóm này sau 6 tuần. Hai tỷ lệ phần trăm này có thể được tính bằng 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 duy nhất. Nếu bạn chỉ định nhiều nhóm thuần tập, thì mỗi nhóm thuần tập có thể được nhận dạng trong báo cáo theo tên của nhóm.
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 khoảng thời gian bù để theo dõi các nhóm thuần tập.
cohortReportSettings

object (CohortReportSettings)

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 tập hợp những người dùng có một đặc điểm chung. Ví dụ: những người dùng có cùng firstSessionDate sẽ 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 này. Phương diện cohort được định giá theo tên này trong phản hồi báo cáo. Nếu được đặt, không được bắt đầu bằng cohort_ hoặc RESERVED_. Nếu không được đặt, các nhóm thuần tập sẽ được đặt tên theo chỉ mục dựa trên số 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 tương tá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 toàn bộ phạm vi ngày của dữ liệu sự kiện có 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à độ lệch có trong cohortsRange; dữ liệu sự kiện cho phạm vi ngày báo cáo mở rộng có trong báo cáo nhóm thuần tập.

Trong yêu cầu nhóm, bạn phải có dateRange này và không được chỉ định dateRanges trong RunReportRequest hoặc RunPivotReportRequest.

dateRange này thường phải phù hợp với mức độ chi tiết của nhóm. Nếu CohortsRange sử dụng mức độ chi tiết hằng ngày, thì dateRange có thể là một ngày duy nhất. Nếu CohortsRange sử dụng độ chi tiết theo tuần, thì dateRange này có thể được căn 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 theo tháng, thì dateRange này có thể được căn chỉnh theo 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

Định cấu hình 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 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. Mứ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 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ừ thời điểm 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.
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à 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 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 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.

Độ chi tiết

Mứ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 của báo cáo nhóm thuần tập.

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

CohortReportSettings

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, sẽ tích luỹ kết quả từ ngày tương tác đầu tiên đến ngày kết thúc. Không được hỗ trợ trong RunReportRequest.

SamplingLevel

Các danh mục cấp lấy mẫu cho các yêu cầu.

Enum
SAMPLING_LEVEL_UNSPECIFIED Loại chưa chỉ định.
LOW Áp dụng mức lấy mẫu là 10 triệu cho tài sản chuẩn và 100 triệu cho tài sản Google Analytics 360.
MEDIUM Chỉ dành cho tài sản Google Analytics 360 có mức lấy mẫu là 1 tỷ.
UNSAMPLED Chỉ dành cho tài sản Google Analytics 360. Dữ liệu khám phá chưa được lấy mẫu chính xác hơn và có thể hiển thị thông tin chi tiết không có trong dữ liệu khám phá chuẩn. Để tìm hiểu thêm, hãy xem bài viết https://support.google.com/analytics/answer/10896953.

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 số mã thông báo hạn mức bị tính phí 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 mức phí mã thông báo này sẽ cố định 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 gian gọi reportTasks.create và báo cáo bắt đầu trạng thái CREATING.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
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 phạm vi báo cáo hiện có.
errorMessage

string

Chỉ có đầu ra. Thông báo lỗi sẽ xuất hiện nếu một 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 muốn truy vấn thêm các hàng dữ liệu ngoài báo cáo hiện tại, họ có thể bắt đầu một tác vụ báo cáo mới dựa trên totalRowCount.

taskRowCount biểu thị số lượng hàng liên quan cụ thể đế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, tức là báo cáo đang hiển thị dữ liệu từ 20 hàng đầu tiên. Đồng thời, totalRowCount là 30, cho biết có dữ liệu cho cả 30 hàng. Bạn có thể sử dụng taskRowCount để phân trang qua 20 hàng ban đầu. Để mở rộng báo cáo và đưa dữ liệu từ cả 30 hàng, bạn có thể tạo một tác vụ báo cáo mới bằng cách sử dụng totalRowCount để truy cập vào toàn bộ dữ liệu của 30 hàng.

Tiểu bang

Trạng thái xử lý.

Enum
STATE_UNSPECIFIED Trạng thái không 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 diễn ra ngay sau lệnh gọi CreateReport.
ACTIVE Báo cáo đã được tạo đầy đủ và sẵn sàng để truy vấn.
FAILED Không tạo được báo cáo.

Phương thức

create

 Khởi tạo việc tạo một tác 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 một tác vụ báo cáo.