- Tài nguyên: ReportTask
- ReportDefinition (Định nghĩa báo cáo)
- Phương diện
- DimensionExpression
- CaseExpression
- ConcatenateExpression
- Chỉ số
- DateRange
- FilterExpression
- FilterExpressionList
- Bộ lọc
- StringFilter (Bộ lọc chuỗi)
- MatchType
- InListFilter
- NumericFilter
- Vận hành
- NumericValue
- BetweenFilter (Bộ lọc giữa)
- MetricAggregation
- OrderBy
- MetricOrderBy
- DimensionOrderBy
- OrderType
- CohortSpec
- Nhóm thuần tập
- CohortsRange
- Độ chi tiết
- CohortReportSettings
- ReportMetadata (Báo cáo siêu dữ liệu)
- Trạng thái
- Phương thức
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 ( |
Trường | |
---|---|
name |
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 |
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 |
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 ( |
Trường | |
---|---|
dimensions[] |
Không bắt buộc. Các phương diện đã yêu cầu và được hiển thị. |
metrics[] |
Không bắt buộc. Các chỉ số được yêu cầu và hiển thị. |
dateRanges[] |
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 |
dimensionFilter |
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 |
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 |
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ố |
limit |
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. API cũng có thể trả về ít hàng hơn |
metricAggregations[] |
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[] |
Không bắt buộc. Chỉ định cách sắp xếp các hàng trong phản hồi. |
currencyCode |
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 |
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 |
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 Ví dụ: nếu một tài sản không ghi nhận sự kiện |
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 ( |
Trường | |
---|---|
name |
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ư Nếu bạn chỉ định Các phương diện được |
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 |
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 |
Được dùng để chuyển đổi giá trị thứ nguyên thành chữ thường. |
upperCase |
Được dùng để chuyển đổi giá trị thứ nguyên thành chữ hoa. |
concatenate |
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 |
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[] |
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 |
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 |
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ư Nếu bạn chỉ định Các chỉ số được |
expression |
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à |
invisible |
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 |
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 |
Ngày bắt đầu bao gồm cho truy vấn ở định dạng |
endDate |
Ngày kết thúc bao gồm cho truy vấn ở định dạng |
name |
Gán tên cho phạm vi ngày này. Phương diện |
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 |
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 |
FilterExpressions trong andGroup có mối quan hệ AND. |
orGroup |
FilterExpression trong orGroup có mối quan hệ OR. |
notExpression |
FilterExpression KHÔNG phải là của notExpression. |
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 ( |
Trường | |
---|---|
expressions[] |
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 |
Trường | |
---|---|
fieldName |
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 |
Bộ lọc liên quan đến chuỗi. |
inListFilter |
Bộ lọc cho các giá trị trong danh sách. |
numericFilter |
Bộ lọc cho các giá trị số hoặc ngày. |
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 ( |
Trường | |
---|---|
matchType |
Kiểu khớp cho bộ lọc này. |
value |
Giá trị chuỗi được dùng để so khớp. |
caseSensitive |
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[] |
Danh sách các giá trị chuỗi. Không được để trống. |
caseSensitive |
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 ( |
Trường | |
---|---|
operation |
Loại toán tử cho bộ lọc này. |
value |
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 |
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 |
Giá trị số nguyên |
doubleValue |
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 ( |
Trường | |
---|---|
fromValue |
Bắt đầu bằng số này. |
toValue |
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 |
Trường | |
---|---|
desc |
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 |
Sắp xếp kết quả theo giá trị của một chỉ số. |
dimension |
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 |
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 ( |
Trường | |
---|---|
dimensionName |
Tên phương diện trong yêu cầu sắp xếp. |
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 ( |
Trường | |
---|---|
cohorts[] |
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 |
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 |
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 ( |
Trường | |
---|---|
name |
Chỉ định tên cho nhóm thuần tập này. Phương diện |
dimension |
Phương diện mà nhóm thuần tập sử dụng. Bắt buộc và chỉ hỗ trợ |
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 Trong yêu cầu nhóm thuần tập,
|
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 ( |
Trường | |
---|---|
granularity |
Bắt buộc. Độ chi tiết dùng để diễn giải |
startOffset |
Nếu Nếu Nếu |
endOffset |
Bắt buộc. Nếu Nếu Nếu |
Độ 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 |
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 |
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 ( |
Trường | |
---|---|
creationQuotaTokensCharged |
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 |
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 |
Chỉ có đầu ra. Thời điểm 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ụ: |
taskRowCount |
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 |
errorMessage |
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 |
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
Ví dụ: giả sử |
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 |
|
---|---|
|
Bắt đầu tạo một nhiệm vụ báo cáo. |
|
Lấy siêu dữ liệu báo cáo về một tác vụ báo cáo cụ thể. |
|
Liệt kê tất cả các tác vụ báo cáo cho một tài sản. |
|
Truy xuất nội dung của tác vụ báo cáo. |