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 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. Tiêu chí này thường 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 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.

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. Cá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 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 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 về nhóm thuần tập, 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 Kiến thứ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 đề 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 từ 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 thông số offset và limit sẽ xác định tập hợp con các hàng dữ liệu từ bộ nhớ 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 hạn mức là 10.000 và độ dời 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à độ dời 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 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. 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 được nhiều 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ố tổng hợp sẽ xuất hiện trong các 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 thuần tập được liên kết với yêu cầu này. Nếu có 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 giá trị là false hoặc không xác định, thì hệ thống sẽ không trả về mỗi hàng có tất cả chỉ số bằng 0. Nếu đúng, các hàng này sẽ được trả về nếu không bị một 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ể hiển thị 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 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ố có người dùng đã kích hoạt sự kiệ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ần 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ần 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ần Phương diện 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, name có thể là bất kỳ chuỗi nào bạn muốn trong tập 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_]$.

Phương diện được tham chiếu bằng name 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 một công thức có 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 hợp hợp nhất 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 giá trị sau:
lowerCase

object (CaseExpression)

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

object (CaseExpression)

Dùng để chuyển đổi 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

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

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. Tên phải tham chiếu lại 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ự 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".

Chỉ số

Số liệu định lượng của một báo cáo. Ví dụ: chỉ số eventCount là tổng số sự kiện. Mỗi yêu cầu được phép 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ố mà các phương thức báo cáo chính hỗ trợ, 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ợ. Hãy xem phần Chỉ số 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, name có thể là bất kỳ chuỗi nào bạn muốn trong tập 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ố đó 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 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ó hiển thị trong phản hồi báo cáo hay không. Nếu không hiển thị, chỉ số sẽ không tạo cột trong phản hồi, nhưng có thể được sử dụng trong metricFilter, orderBys hoặc chỉ số expression.

DateRange

Một tập hợp các ngày liền kề: startDate, startDate + 1, ..., endDate. Mỗi yêu cầu được phép 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 cả ngày bắt đầu của 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 luận dựa trên múi giờ báo cáo của cơ sở lưu trú.
endDate

string

Ngày kết thúc bao gồm cả ngày bắt đầu 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 được suy luận dựa trên múi giờ báo cáo của cơ sở lưu trú.
name

string

Chỉ định tên cho phạm vi ngày này. Phương diện dateRange được gán giá trị cho 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 hợp hợp nhất 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 giá trị sau:
andGroup

object (FilterExpressionList)

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

object (FilterExpressionList)

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

object (FilterExpression)

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

object (Filter)

Bộ lọc gốc. 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 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 biểu thức bộ lọc.

Lọc

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 hợp hợp nhất one_filter. Chỉ định một loại bộ lọc cho Filter. one_filter chỉ có thể là một trong những giá trị 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 giá trị số hoặc 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 như "(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 chuỗi

Enum
MATCH_TYPE_UNSPECIFIED Không xác định
EXACT Khớp chính xác với 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 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ả cần phải ở dạng 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 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 áp dụng cho bộ lọc dạng 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 hợp hợp nhất 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ị số 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ố (bao gồm 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 Toán tử 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

Thứ tự sắp xếp 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ố sự kiện giảm dần là một thứ tự và sắp xếp 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 hợp nhất one_order_by. Chỉ định một loại thứ tự cho OrderBy. one_order_by chỉ có thể là một trong những giá trị 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 theo.

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 kiểu chữ số và chữ cái không phân biệt chữ hoa chữ thường theo điểm mã Unicode viết thường. Ví dụ: "2" < "A" < "b" < "X" < "z".
NUMERIC Giá trị phương diện được chuyển đổi thành số trước khi sắp xếp. Ví dụ: trong cách sắp xếp SỐ, "25" < "100" và trong cách sắp xếp ALPHANUMERIC, "100" < "25". Tất cả giá trị phương diện không phải số đều có giá trị thứ tự bằng nhau bên dưới tất 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 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 người dùng đó trong 6 tuần tiếp theo. Việc chọn những người dùng thu nạp được trong nhóm thuần tập 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 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 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 một chuỗi thời gian hằng tuần, trong đó ứng dụng của bạn đã giữ chân 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 toán 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. Nếu bạn chỉ định nhiều nhóm thuần tập, thì bạn có thể nhận ra từng nhóm thuần tập 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 khoảng thời gian chênh lệch để 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 thuần tập này. Phương diện cohort được gán giá trị cho 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 này sẽ chọn những người dùng có ngày tiếp xúc đầu tiên nằm trong khoảng ngày bắt đầu và 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 báo cáo nhóm thuần tập, dateRange này được mở rộng theo mức độ 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 sẽ xuất hiện trong báo cáo nhóm thuần tập.

Trong yêu cầu về nhóm thuần tập, 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 thuần tập. Nếu CohortsRange sử dụng mức độ chi tiết hằng ngày, thì dateRange này có thể là một ngày. Nếu CohortsRange sử dụng mức độ chi tiết hằng 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 mức độ chi tiết hằng tháng, thì dateRange này có thể được điều chỉnh cho phù hợp với 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

Đị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ù để 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 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 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à bất kỳ số nguyên dương nào nhưng thường được đặt thành 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

Mứ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.

Enum
GRANULARITY_UNSPECIFIED Không bao giờ được chỉ định.
DAILY Độ chi tiết hằng ngày. Thường được 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 có thời lượng là 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 Mức độ chi tiết hằng tháng. Thường được dùng nếu dateRange của nhóm thuần tập có thời lượng 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 tiếp xúc đầu tiên đến ngày kết thúc. Không được hỗ trợ trong RunReportRequest.

SamplingLevel

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

Enum
SAMPLING_LEVEL_UNSPECIFIED Loại không xác đị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 những tài sản Google Analytics 360 có cấp 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 được 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 từ trạng thái CREATING, nên mức phí mã thông báo này sẽ được cố định sau 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 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, có độ phân giải nano giây và tối đa 9 chữ số thập phân. 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 phạm vi 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 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ớ của Google Analytics. Nếu bạn muốn truy vấn các hàng dữ liệu bổ sung 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ố lượng hàng liên quan cụ thể đến báo cáo hiện tại, còn 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 có dữ liệu cho tất 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 vào, 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ộ tập hợp dữ liệu gồm 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 sẽ 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

 Bắt đầu tạo 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 nhiệm 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.