- Yêu cầu HTTP
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi cấp phép
- ReportRequest (Yêu cầu báo cáo)
- Lấy mẫu
- Phương diện
- DimensionFilterClause
- FilterLogicalOperator
- DimensionFilter
- Toán tử
- Chỉ số
- MetricType
- MetricFilterClause
- MetricFilter
- Toán tử
- OrderBy
- OrderType
- SortOrder
- Phân đoạn
- DynamicSegment
- SegmentDefinition
- SegmentFilter
- SimpleSegment
- OrFiltersForSegment
- SegmentFilterClause
- SegmentDimensionFilter
- Toán tử
- SegmentMetricFilter
- Phạm vi
- Toán tử
- SequenceSegment
- SegmentSequenceStep
- MatchType
- Tổng hợp
- CohortGroup
- Nhóm thuần tập
- Loại
- Báo cáo
- ColumnHeader
- MetricHeader
- MetricHeaderEntry
- PivotHeader
- PivotHeaderEntry
- ReportData (Báo cáo dữ liệu)
- ReportRow (Báo cáo hàng)
- DateRangeValues
- PivotValueRegion (Khu vực)
- ResourceQuotasRemaining
- Hãy làm thử!
Trả về dữ liệu Analytics.
Yêu cầu HTTP
POST https://analyticsreporting.googleapis.com/v4/reports:batchGet
URL sử dụng cú pháp Chuyển mã gRPC.
Nội dung yêu cầu
Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:
Biểu diễn dưới dạng JSON | |
---|---|
{
"reportRequests": [
{
object( |
Trường | |
---|---|
reportRequests[] |
Đối với các yêu cầu, mỗi yêu cầu sẽ có một phản hồi riêng. Bạn có thể tạo tối đa 5 yêu cầu. Tất cả các yêu cầu phải có cùng |
useResourceQuotas |
Bật hạn mức dựa trên tài nguyên, (mặc định là |
Nội dung phản hồi
Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:
Lớp phản hồi chính lưu giữ các báo cáo của lệnh gọi API Báo cáo batchGet
.
Biểu diễn dưới dạng JSON | |
---|---|
{ "reports": [ { object( |
Trường | |
---|---|
reports[] |
Phản hồi tương ứng với từng yêu cầu. |
queryCost |
Lượng mã thông báo hạn mức tài nguyên đã bị khấu trừ để thực thi truy vấn. Bao gồm mọi câu trả lời. |
resourceQuotasRemaining |
Lượng hạn mức tài nguyên còn lại cho thuộc tính. |
Phạm vi uỷ quyền
Yêu cầu một trong các phạm vi OAuth sau đây:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
ReportRequest
Lớp yêu cầu chính chỉ định yêu cầu API Báo cáo.
Biểu diễn dưới dạng JSON | |
---|---|
{ "viewId": string, "dateRanges": [ { object( |
Trường | |
---|---|
viewId |
Mã chế độ xem Analytics để truy xuất dữ liệu. Mọi ReportRequest trong phương thức |
dateRanges[] |
Phạm vi ngày trong yêu cầu. Yêu cầu có thể có tối đa 2 phạm vi ngày. Phản hồi sẽ chứa một tập hợp các giá trị chỉ số cho từng tổ hợp phương diện thuộc từng phạm vi ngày trong yêu cầu. Vì vậy, nếu có hai phạm vi ngày, sẽ có hai tập hợp giá trị chỉ số, một cho phạm vi ngày ban đầu và một cho phạm vi ngày thứ hai. Không được chỉ định trường |
samplingLevel |
Kích thước mẫu báo cáo mong muốn. Nếu bạn chưa chỉ định trường |
dimensions[] |
Các phương diện được yêu cầu. Yêu cầu có thể có tổng cộng 9 phương diện. |
dimensionFilterClauses[] |
Các mệnh đề về bộ lọc phương diện để lọc các Giá trị phương diện. Các thành phần này được kết hợp một cách logic với toán tử |
metrics[] |
Các chỉ số đã yêu cầu. Yêu cầu phải chỉ định ít nhất một chỉ số. Các yêu cầu có thể có tổng cộng 10 chỉ số. |
metricFilterClauses[] |
Các mệnh đề của bộ lọc chỉ số. Các thành phần này được kết hợp một cách logic với toán tử |
filtersExpression |
Bộ lọc phương diện hoặc chỉ số hạn chế dữ liệu được trả về cho yêu cầu của bạn. Để sử dụng |
orderBys[] |
Thứ tự sắp xếp trên các hàng đầu ra. Để so sánh hai hàng, các phần tử sau đây được áp dụng theo thứ tự cho đến khi tìm thấy sự khác biệt. Tất cả phạm vi ngày trong kết quả đều có cùng thứ tự hàng. |
segments[] |
Phân đoạn dữ liệu được trả về cho yêu cầu. Định nghĩa phân đoạn giúp xem xét một tập hợp con của yêu cầu phân đoạn. Một yêu cầu có thể chứa tối đa 4 phân đoạn. Mỗi ReportRequest trong phương thức |
pivots[] |
Định nghĩa về bảng tổng hợp. Yêu cầu có thể có tối đa 2 tổng hợp. |
cohortGroup |
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 |
pageToken |
Mã thông báo tiếp tục để xem trang tiếp theo của kết quả. Việc thêm mã này vào yêu cầu sẽ trả về các hàng sau pageToken. pageToken phải là giá trị được trả về trong tham số nextPageToken trong phản hồi cho yêu cầu Reports.batchGet. |
pageSize |
Kích thước trang là để phân trang và chỉ định số lượng tối đa các hàng được trả về. Kích thước trang phải lớn hơn 0. Truy vấn trả về giá trị mặc định là 1.000 hàng. API báo cáo chính của Analytics sẽ trả về tối đa 100.000 hàng cho mỗi yêu cầu, bất kể số lượng hàng bạn yêu cầu. Phương diện này cũng có thể trả về ít hàng hơn so với yêu cầu nếu không có nhiều phân khúc phương diện như bạn mong đợi. Ví dụ: có thể có ít hơn 300 giá trị cho |
includeEmptyRows |
Nếu bạn đặt thành false, thì phản hồi sẽ không bao gồm các hàng nếu tất cả chỉ số được truy xuất bằng 0. Giá trị mặc định là false sẽ loại trừ các hàng này. |
hideTotals |
Nếu bạn đặt chính sách này thành true, thì tổng tất cả chỉ số cho tất cả các hàng phù hợp sẽ bị ẩn cho mọi phạm vi ngày. Giá trị mặc định là false và sẽ trả về tổng số. |
hideValueRanges |
Nếu bạn đặt chính sách này thành true, thì giá trị tối thiểu và tối đa sẽ ẩn trên tất cả các hàng phù hợp. Giá trị mặc định là false và dải giá trị được trả về. |
Lấy mẫu
Giá trị cho cấp độ lấy mẫu.
Enum | |
---|---|
SAMPLING_UNSPECIFIED |
Nếu bạn chưa chỉ định trường samplingLevel , thì cấp độ lấy mẫu DEFAULT sẽ được sử dụng. |
DEFAULT |
Trả về câu trả lời có kích thước mẫu cân bằng giữa tốc độ và độ chính xác. |
SMALL |
Phương thức này trả về phản hồi nhanh với kích thước lấy mẫu nhỏ hơn. |
LARGE |
Trả về phản hồi chính xác hơn bằng cách sử dụng một kích thước lấy mẫu lớn. Tuy nhiên, việc này có thể khiến phản hồi chậm hơn. |
Phương diện
Phương diện là các thuộc tính của dữ liệu. Ví dụ: phương diện ga:city
cho biết thành phố bắt nguồn phiên hoạt động, ví dụ: "Paris" hoặc "New York".
Biểu diễn dưới dạng JSON | |
---|---|
{ "name": string, "histogramBuckets": [ string ] } |
Trường | |
---|---|
name |
Tên của phương diện cần tìm nạp, ví dụ: |
histogramBuckets[] |
Nếu không để trống, chúng ta sẽ đặt giá trị kích thước vào các nhóm sau chuỗi tới int64. Các giá trị kích thước không phải là chuỗi đại diện của một giá trị tích phân sẽ được chuyển về 0. Các giá trị của nhóm phải theo thứ tự tăng dần. Mỗi bộ chứa được đóng ở đầu dưới và mở ở đầu trên. Nhóm "đầu tiên" bao gồm tất cả các giá trị nhỏ hơn ranh giới đầu tiên, nhóm "cuối cùng" bao gồm tất cả các giá trị cho đến vô hạn. Các giá trị phương diện nằm trong một nhóm sẽ được chuyển đổi thành một giá trị phương diện mới. Ví dụ: nếu một người đưa ra danh sách "0, 1, 3, 4, 7", thì chúng ta sẽ trả về các bộ chứa sau:
LƯU Ý: Nếu bạn đang áp dụng kiểu sắp xếp đột biến biểu đồ trên bất kỳ phương diện nào và sử dụng phương diện đó trong quá trình sắp xếp, thì bạn nên sử dụng loại sắp xếp "<50", "1001 trở lên", "121 – 1000", "50 – 120" Và thứ tự "<50", "50 – 120", "121 – 1000", "1001 trở lên" Ứng dụng phải yêu cầu |
DimensionFilterClause
Một nhóm bộ lọc phương diện. Đặt giá trị toán tử để chỉ định cách kết hợp các bộ lọc một cách hợp lý.
Biểu diễn dưới dạng JSON | |
---|---|
{ "operator": enum( |
Trường | |
---|---|
operator |
Toán tử để kết hợp nhiều bộ lọc phương diện. Nếu không chỉ định thì đó sẽ được coi là |
filters[] |
Tập hợp các bộ lọc lặp lại. Các toán tử này được kết hợp một cách logic dựa trên toán tử được chỉ định. |
FilterLogicalOperator
Cách kết hợp các bộ lọc một cách hợp lý.
Enum | |
---|---|
OPERATOR_UNSPECIFIED |
Toán tử chưa được chỉ định. Đây được coi là một OR . |
OR |
Toán tử logic OR . |
AND |
Toán tử logic AND . |
DimensionFilter
Bộ lọc phương diện chỉ định các lựa chọn lọc phương diện.
Biểu diễn dưới dạng JSON | |
---|---|
{
"dimensionName": string,
"not": boolean,
"operator": enum( |
Trường | |
---|---|
dimensionName |
Phương diện bạn muốn lọc. Bộ lọc thứ nguyên phải chứa thứ nguyên. |
not |
Toán tử logic |
operator |
Cách đối sánh phương diện với biểu thức. Giá trị mặc định là REGEXP. |
expressions[] |
Chuỗi hoặc biểu thức chính quy để so khớp. Chỉ dùng giá trị đầu tiên của danh sách để so sánh trừ phi toán tử là |
caseSensitive |
Kết quả trùng khớp có phân biệt chữ hoa chữ thường không? Mặc định là sai. |
Đơn vị tổ chức
Hỗ trợ nhiều kiểu khớp.
Enum | |
---|---|
OPERATOR_UNSPECIFIED |
Nếu không chỉ định được kiểu khớp, kiểu khớp đó sẽ được coi là REGEXP . |
REGEXP |
Biểu thức khớp này được coi là biểu thức chính quy. Tất cả kiểu khớp không được coi là biểu thức chính quy. |
BEGINS_WITH |
Khớp với giá trị bắt đầu bằng biểu thức so khớp được cung cấp. |
ENDS_WITH |
Khớp với các giá trị kết thúc bằng biểu thức so khớp đã cho. |
PARTIAL |
So khớp chuỗi con. |
EXACT |
Giá trị phải hoàn toàn khớp với biểu thức so khớp. |
NUMERIC_EQUAL |
Bộ lọc so sánh số nguyên. Có phân biệt chữ hoa chữ thường đối với các bộ lọc này và biểu thức được giả định là một chuỗi đại diện cho một số nguyên. Điều kiện xảy ra lỗi:
|
NUMERIC_GREATER_THAN |
Kiểm tra xem phương diện có lớn hơn về mặt số lượng so với biểu thức so khớp hay không. Hãy đọc nội dung mô tả về NUMERIC_EQUALS để biết các quy định hạn chế. |
NUMERIC_LESS_THAN |
Kiểm tra xem phương diện có ít hơn về số lượng so với biểu thức so khớp hay không. Hãy đọc nội dung mô tả về NUMERIC_EQUALS để biết các quy định hạn chế. |
IN_LIST |
Lựa chọn này dùng để chỉ định bộ lọc phương diện mà biểu thức có thể nhận bất kỳ giá trị nào trong danh sách giá trị đã chọn. Điều này giúp tránh đánh giá nhiều bộ lọc phương diện khớp chính xác có hành vi OR cho mỗi hàng phản hồi. Ví dụ:
Bất kỳ hàng phản hồi nào có phương diện chứa giá trị này đều có giá trị là A, B hoặc C, đều khớp với DataFilter này. |
Chỉ số
Chỉ số là thông tin đo lường định lượng. Ví dụ: chỉ số ga:users
cho biết tổng số người dùng trong khoảng thời gian được yêu cầu.
Biểu diễn dưới dạng JSON | |
---|---|
{
"expression": string,
"alias": string,
"formattingType": enum( |
Trường | |
---|---|
expression |
Biểu thức chỉ số trong yêu cầu. Biểu thức được tạo từ một hoặc nhiều chỉ số và số. Các toán tử được chấp nhận bao gồm: Cộng (+), Trừ (-), Phủ (Unary -), Chia cho (/), Nhân (*), Dấu ngoặc đơn, Số thập phân dương (0-9), có thể bao gồm số thập phân và được giới hạn trong 1024 ký tự. Ví dụ |
alias |
Bí danh của biểu thức chỉ số là tên thay thế cho biểu thức. Bạn có thể dùng bí danh để lọc và sắp xếp. Trường này là không bắt buộc và hữu ích nếu biểu thức không phải là một chỉ số đơn lẻ mà là một biểu thức phức tạp không thể dùng được trong quá trình lọc và sắp xếp. Bí danh cũng được dùng trong tiêu đề cột phản hồi. |
formattingType |
Chỉ định cách định dạng biểu thức chỉ số, ví dụ: |
MetricType
Các loại chỉ số.
Enum | |
---|---|
METRIC_TYPE_UNSPECIFIED |
Loại chỉ số chưa được chỉ định. |
INTEGER |
Chỉ số số nguyên. |
FLOAT |
Chỉ số nổi. |
CURRENCY |
Chỉ số về đơn vị tiền tệ. |
PERCENT |
Chỉ số phần trăm. |
TIME |
Chỉ số thời gian ở định dạng HH:MM:SS . |
MetricFilterClause
Đại diện cho một nhóm các bộ lọc chỉ số. Đặt giá trị toán tử để chỉ định cách kết hợp các bộ lọc một cách hợp lý.
Biểu diễn dưới dạng JSON | |
---|---|
{ "operator": enum( |
Trường | |
---|---|
operator |
Toán tử để kết hợp nhiều bộ lọc chỉ số. Nếu không chỉ định thì đó sẽ được coi là |
filters[] |
Tập hợp các bộ lọc lặp lại. Các toán tử này được kết hợp một cách logic dựa trên toán tử được chỉ định. |
MetricFilter
Bộ lọc chỉ số chỉ định bộ lọc cho một chỉ số.
Biểu diễn dưới dạng JSON | |
---|---|
{
"metricName": string,
"not": boolean,
"operator": enum( |
Trường | |
---|---|
metricName |
Chỉ số sẽ được lọc. Bộ lọc chỉ số phải chứa tên chỉ số. Tên chỉ số có thể là bí danh được xác định trước đó là một chỉ số hoặc cũng có thể là một biểu thức chỉ số. |
not |
Toán tử logic |
operator |
Chỉ số |
comparisonValue |
Giá trị để so sánh. |
Đơn vị tổ chức
Loại thông tin so sánh khác nhau.
Enum | |
---|---|
OPERATOR_UNSPECIFIED |
Nếu bạn không chỉ định toán tử, thì toán tử đó sẽ được coi là EQUAL . |
EQUAL |
Giá trị của chỉ số phải hoàn toàn bằng với giá trị so sánh. |
LESS_THAN |
Giá trị của chỉ số phải nhỏ hơn giá trị so sánh. |
GREATER_THAN |
Phải nên giá trị của chỉ số lớn hơn giá trị so sánh. |
IS_MISSING |
Xác thực xem có chỉ số bị thiếu hay không. Không tính đến ComparisonValue. |
OrderBy
Chỉ định các cách sắp xếp.
Biểu diễn dưới dạng JSON | |
---|---|
{ "fieldName": string, "orderType": enum( |
Trường | |
---|---|
fieldName |
Trường cần sắp xếp. Thứ tự sắp xếp mặc định là tăng dần. Ví dụ: |
orderType |
Loại đơn đặt hàng. OrderType mặc định là |
sortOrder |
Thứ tự sắp xếp cho trường. |
OrderType
OrderType kiểm soát cách xác định thứ tự sắp xếp.
Enum | |
---|---|
ORDER_TYPE_UNSPECIFIED |
Loại thứ tự chưa chỉ định sẽ được coi là sắp xếp dựa trên giá trị. |
VALUE |
Thứ tự sắp xếp dựa trên giá trị của cột được chọn; chỉ xem xét phạm vi ngày đầu tiên. |
DELTA |
Thứ tự sắp xếp dựa trên sự chênh lệch giá trị của cột đã chọn giữa hai phạm vi ngày đầu tiên. Chỉ sử dụng được nếu có chính xác hai phạm vi ngày. |
SMART |
Thứ tự sắp xếp dựa trên giá trị trọng số của cột đã chọn. Nếu cột có định dạng n/d, thì giá trị có trọng số của tỷ lệ này sẽ là (n + totals.n)/(d + totals.d) Chỉ dùng được cho các chỉ số thể hiện tỷ lệ. |
HISTOGRAM_BUCKET |
Loại thứ tự biểu đồ chỉ áp dụng cho các cột phương diện có bộ biểu đồ không trống. |
DIMENSION_AS_INTEGER |
Nếu kích thước là số có độ dài cố định, thì chế độ sắp xếp thông thường sẽ phù hợp. Có thể sử dụng DIMENSION_AS_INTEGER nếu kích thước là các số có độ dài thay đổi. |
SortOrder
Thứ tự sắp xếp.
Enum | |
---|---|
SORT_ORDER_UNSPECIFIED |
Nếu bạn chưa chỉ định thứ tự sắp xếp, thì giá trị mặc định là tăng dần. |
ASCENDING |
Sắp xếp tăng dần. Trường này sẽ được sắp xếp theo thứ tự tăng dần. |
DESCENDING |
Sắp xếp giảm dần. Trường này sẽ được sắp xếp theo thứ tự giảm dần. |
Phân khúc
Định nghĩa phân đoạn, nếu cần phân đoạn báo cáo. Phân đoạn là một tập hợp con dữ liệu Analytics. Ví dụ: trong toàn bộ tập hợp người dùng, một Phân khúc có thể là những người dùng từ một quốc gia hoặc thành phố cụ thể.
Biểu diễn dưới dạng JSON | |
---|---|
{ // Union field |
Trường | ||
---|---|---|
Trường hợp dynamicOrById . Bạn có thể xác định phân khúc một cách linh động bằng Phân đoạn động hoặc bằng cách sử dụng mã của một phân khúc tích hợp sẵn hay phân khúc tuỳ chỉnh. dynamicOrById chỉ có thể là một trong những trạng thái sau: |
||
dynamicSegment |
Định nghĩa phân đoạn động trong yêu cầu. |
|
segmentId |
Mã phân khúc của một phân khúc tích hợp sẵn hoặc phân khúc tuỳ chỉnh, ví dụ: |
DynamicSegment
Định nghĩa phân đoạn động để xác định phân đoạn trong yêu cầu. Một phân đoạn có thể chọn người dùng, phiên hoạt động hoặc cả hai.
Biểu diễn dưới dạng JSON | |
---|---|
{ "name": string, "userSegment": { object( |
Trường | |
---|---|
name |
Tên của phân đoạn động. |
userSegment |
Phân khúc người dùng để chọn người dùng cần đưa vào phân khúc. |
sessionSegment |
Phân đoạn phiên để chọn các phiên cần đưa vào phân đoạn. |
SegmentDefinition
Phân đoạn xác định phân đoạn là một tập hợp các bộ lọc phân đoạn được kết hợp với nhau bằng toán tử logic AND
.
Biểu diễn dưới dạng JSON | |
---|---|
{
"segmentFilters": [
{
object( |
Trường | |
---|---|
segmentFilters[] |
Một phân đoạn được xác định bằng một nhóm các bộ lọc phân đoạn kết hợp với nhau bằng toán tử logic |
SegmentFilter
Đoạn bộ lọc xác định phân đoạn là một phân đoạn đơn giản hoặc một phân đoạn trình tự. Điều kiện phân đoạn đơn giản chứa các điều kiện về phương diện và chỉ số để chọn phiên hoạt động hoặc người dùng. Bạn có thể sử dụng điều kiện phân đoạn trình tự để chọn người dùng hoặc phiên dựa trên các điều kiện tuần tự.
Biểu diễn dưới dạng JSON | |
---|---|
{ "not": boolean, // Union field |
Trường | ||
---|---|---|
not |
Nếu đúng, hãy khớp phần bổ sung của phân đoạn đơn giản hoặc phân đoạn trình tự. Ví dụ: để khớp với tất cả lượt truy cập không phải từ "New York", chúng tôi có thể xác định phân đoạn như sau:
|
|
Trường hợp simpleOrSequence . Đó là một phân đoạn đơn giản hay định nghĩa phân đoạn trình tự. simpleOrSequence chỉ có thể là một trong những trạng thái sau: |
||
simpleSegment |
Điều kiện phân đoạn đơn giản bao gồm một hoặc nhiều điều kiện phương diện/chỉ số có thể kết hợp được |
|
sequenceSegment |
Điều kiện trình tự bao gồm một hoặc nhiều bước, trong đó mỗi bước được xác định bởi một hoặc nhiều điều kiện phương diện/chỉ số. Bạn có thể kết hợp nhiều bước với các toán tử trình tự đặc biệt. |
SimpleSegment
Điều kiện phân đoạn đơn giản bao gồm một hoặc nhiều điều kiện phương diện/chỉ số có thể kết hợp với nhau.
Biểu diễn dưới dạng JSON | |
---|---|
{
"orFiltersForSegment": [
{
object( |
Trường | |
---|---|
orFiltersForSegment[] |
Danh sách các nhóm bộ lọc phân đoạn được kết hợp với toán tử logic |
OrFiltersForSegment
Danh sách các bộ lọc phân đoạn trong nhóm OR
được kết hợp với toán tử logic OR.
Biểu diễn dưới dạng JSON | |
---|---|
{
"segmentFilterClauses": [
{
object( |
Trường | |
---|---|
segmentFilterClauses[] |
Danh sách các bộ lọc phân đoạn cần kết hợp với toán tử |
SegmentFilterClause
Mệnh đề bộ lọc được sử dụng trong định nghĩa phân đoạn, có thể bao gồm chỉ số hoặc bộ lọc phương diện.
Biểu diễn dưới dạng JSON | |
---|---|
{ "not": boolean, // Union field |
Trường | ||
---|---|---|
not |
Khớp với phần bổ sung ( |
|
Trường hợp dimensionOrMetricFilter . Bộ lọc phương diện hoặc chỉ số. dimensionOrMetricFilter chỉ có thể là một trong những trạng thái sau: |
||
dimensionFilter |
Bộ lọc phương diện cho định nghĩa phân khúc. |
|
metricFilter |
Bộ lọc chỉ số cho định nghĩa phân khúc. |
SegmentDimensionFilter
Bộ lọc phương diện chỉ định các lựa chọn lọc phương diện.
Biểu diễn dưới dạng JSON | |
---|---|
{
"dimensionName": string,
"operator": enum( |
Trường | |
---|---|
dimensionName |
Tên của phương diện mà bộ lọc đang được áp dụng. |
operator |
Toán tử cần sử dụng để so khớp phương diện với các biểu thức. |
caseSensitive |
Kết quả trùng khớp có phân biệt chữ hoa chữ thường và bị bỏ qua đối với toán tử |
expressions[] |
Danh sách biểu thức, chỉ phần tử đầu tiên được dùng cho tất cả các toán tử |
minComparisonValue |
Giá trị so sánh tối thiểu cho kiểu khớp |
maxComparisonValue |
Giá trị so sánh tối đa cho kiểu khớp |
Đơn vị tổ chức
Hỗ trợ nhiều kiểu khớp.
Enum | |
---|---|
OPERATOR_UNSPECIFIED |
Nếu không chỉ định kiểu khớp, thì hệ thống sẽ coi kiểu khớp là REGEXP. |
REGEXP |
Biểu thức khớp này được coi là biểu thức chính quy. Tất cả các kiểu khớp khác không được coi là biểu thức chính quy. |
BEGINS_WITH |
Khớp với các giá trị bắt đầu bằng biểu thức so khớp đã cho. |
ENDS_WITH |
Khớp với các giá trị kết thúc bằng biểu thức so khớp đã cho. |
PARTIAL |
So khớp chuỗi con. |
EXACT |
Giá trị phải hoàn toàn khớp với biểu thức so khớp. |
IN_LIST |
Lựa chọn này dùng để chỉ định bộ lọc phương diện mà biểu thức có thể nhận bất kỳ giá trị nào trong danh sách giá trị đã chọn. Điều này giúp tránh đánh giá nhiều bộ lọc phương diện khớp chính xác có hành vi OR cho mỗi hàng phản hồi. Ví dụ:
Bất kỳ hàng phản hồi nào có phương diện chứa giá trị này đều có giá trị là A, B hoặc C, đều khớp với DataFilter này. |
NUMERIC_LESS_THAN |
Bộ lọc so sánh số nguyên. Có phân biệt chữ hoa chữ thường đối với các bộ lọc này và biểu thức được giả định là một chuỗi đại diện cho một số nguyên. Điều kiện xảy ra lỗi:
Kiểm tra xem phương diện có ít hơn về số lượng so với biểu thức so khớp hay không. |
NUMERIC_GREATER_THAN |
Kiểm tra xem phương diện có lớn hơn về mặt số lượng so với biểu thức so khớp hay không. |
NUMERIC_BETWEEN |
Kiểm tra xem kích thước có nằm trong khoảng từ giá trị tối thiểu đến tối đa của biểu thức so khớp bằng số hay không, các ranh giới bị loại trừ. |
SegmentMetricFilter
Bộ lọc chỉ số được sử dụng trong mệnh đề bộ lọc phân đoạn.
Biểu diễn dưới dạng JSON | |
---|---|
{ "scope": enum( |
Trường | |
---|---|
scope |
Phạm vi của một chỉ số xác định cấp mà chỉ số đó được xác định. Phạm vi chỉ số mà bạn chỉ định phải bằng hoặc lớn hơn phạm vi chính như được xác định trong mô hình dữ liệu. Phạm vi chính được xác định dựa trên việc phân đoạn đang chọn người dùng hay phiên hoạt động. |
metricName |
Chỉ số sẽ được lọc. |
operator |
Chỉ định là thao tác cần thực hiện để so sánh chỉ số. Mặc định là |
comparisonValue |
Giá trị để so sánh. Nếu toán tử là |
maxComparisonValue |
Giá trị so sánh tối đa chỉ được dùng cho toán tử |
Phạm vi
Phạm vi của một chỉ số xác định cấp mà chỉ số đó được xác định – PRODUCT
, HIT
, SESSION
hoặc USER
. Hệ thống cũng có thể báo cáo giá trị chỉ số ở các phạm vi lớn hơn phạm vi chính của chỉ số. Ví dụ: Bạn có thể báo cáo ga:pageviews
và ga:transactions
ở cấp SESSION
và USER
bằng cách thêm chúng cho mỗi lượt truy cập xảy ra trong các phiên đó hoặc cho những người dùng đó.
Enum | |
---|---|
UNSPECIFIED_SCOPE |
Nếu bạn không chỉ định phạm vi, thì phạm vi mặc định sẽ là phạm vi điều kiện, USER hoặc SESSION , tuỳ thuộc vào việc phân đoạn đang cố gắng chọn người dùng hay phiên. |
PRODUCT |
Phạm vi sản phẩm. |
HIT |
Phạm vi lượt truy cập. |
SESSION |
Phạm vi phiên. |
USER |
Phạm vi người dùng. |
Đơn vị tổ chức
Loại thông tin so sánh khác nhau.
Enum | |
---|---|
UNSPECIFIED_OPERATOR |
Toán tử không xác định được coi là toán tử LESS_THAN . |
LESS_THAN |
Kiểm tra xem giá trị chỉ số có nhỏ hơn giá trị so sánh hay không. |
GREATER_THAN |
Kiểm tra xem giá trị chỉ số có lớn hơn giá trị so sánh hay không. |
EQUAL |
Toán tử Bằng. |
BETWEEN |
Đối với giữa các toán tử, cả giá trị tối thiểu và tối đa đều không bao gồm. Chúng ta sẽ sử dụng LT và GT để so sánh. |
SequenceSegment
Điều kiện trình tự bao gồm một hoặc nhiều bước, trong đó mỗi bước được xác định bởi một hoặc nhiều điều kiện phương diện/chỉ số. Bạn có thể kết hợp nhiều bước với các toán tử trình tự đặc biệt.
Biểu diễn dưới dạng JSON | |
---|---|
{
"segmentSequenceSteps": [
{
object( |
Trường | |
---|---|
segmentSequenceSteps[] |
Danh sách các bước trong trình tự. |
firstStepShouldMatchFirstHit |
Nếu được đặt, điều kiện bước đầu tiên phải khớp với lượt truy cập đầu tiên của khách truy cập (trong phạm vi ngày). |
SegmentSequenceStep
Định nghĩa trình tự phân đoạn.
Biểu diễn dưới dạng JSON | |
---|---|
{ "orFiltersForSegment": [ { object( |
Trường | |
---|---|
orFiltersForSegment[] |
Trình tự được chỉ định bằng một danh sách các bộ lọc được nhóm "Hoặc" theo nhóm được kết hợp với toán tử |
matchType |
Chỉ định xem bước đó có đứng ngay trước hay có thể là bất kỳ lúc nào trước bước tiếp theo. |
MatchType
Kiểu khớp cho trình tự.
Enum | |
---|---|
UNSPECIFIED_MATCH_TYPE |
Kiểu khớp không xác định được coi là trước. |
PRECEDES |
Toán tử cho biết bước trước đó trước bước tiếp theo. |
IMMEDIATELY_PRECEDES |
Toán tử cho biết bước trước đó ngay trước bước tiếp theo. |
Xoay vòng
Bảng tổng hợp mô tả phần tổng hợp trong yêu cầu. Bảng tổng hợp giúp sắp xếp lại thông tin trong bảng cho một số báo cáo nhất định bằng cách tổng hợp dữ liệu của bạn trên phương diện thứ hai.
Biểu diễn dưới dạng JSON | |
---|---|
{ "dimensions": [ { object( |
Trường | |
---|---|
dimensions[] |
Danh sách phương diện có thể hiển thị dưới dạng cột tổng hợp. Một Bảng tổng hợp có thể có tối đa 4 phương diện. Phương diện tổng hợp là một phần của quy định hạn chế về tổng số phương diện được phép trong yêu cầu. |
dimensionFilterClauses[] |
chiềuFilterClauses được kết hợp một cách hợp lý với một toán tử |
metrics[] |
Các chỉ số tổng hợp. Chỉ số tổng hợp là một phần của quy định hạn chế về tổng số chỉ số được phép trong yêu cầu. |
startGroup |
Nếu có k chỉ số được yêu cầu, thì phản hồi sẽ chứa một số bội số của k cột phụ thuộc vào dữ liệu trong báo cáo. Ví dụ: nếu bạn chuyển hướng theo phương diện Phần sau đây cho phép bạn chọn nhóm k cột nào được đưa vào câu trả lời. |
maxGroupCount |
Chỉ định số lượng nhóm tối đa cần trả về. Giá trị mặc định là 10, cũng giá trị tối đa là 1.000. |
CohortGroup
Xác định một nhóm thuần tập. Ví dụ:
"cohortGroup": {
"cohorts": [{
"name": "cohort 1",
"type": "FIRST_VISIT_DATE",
"dateRange": { "startDate": "2015-08-01", "endDate": "2015-08-01" }
},{
"name": "cohort 2"
"type": "FIRST_VISIT_DATE"
"dateRange": { "startDate": "2015-07-01", "endDate": "2015-07-01" }
}]
}
Biểu diễn dưới dạng JSON | |
---|---|
{
"cohorts": [
{
object( |
Trường | |
---|---|
cohorts[] |
Định nghĩa về nhóm thuần tập. |
lifetimeValue |
Bật Giá trị vòng đời (LTV). Giá trị vòng đời đo lường giá trị vòng đời cho những người dùng thu nạp được thông qua các kênh khác nhau. Vui lòng xem: Phân tích theo nhóm và Giá trị vòng đời Nếu giá trị của giá trị lâu dài là false:
Khi giá trị lâu dài là true:
|
Nhóm thuần tập
Xác định một 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ụ: tất cả người dùng có cùng ngày thu nạp đều thuộc cùng một nhóm thuần tập.
Biểu diễn dưới dạng JSON | |
---|---|
{ "name": string, "type": enum( |
Trường | |
---|---|
name |
Tên duy nhất cho nhóm thuần tập. Nếu không xác định, tên sẽ được tạo tự động với các giá trị nhóm_[1234...]. |
type |
Loại nhóm thuần tập. Loại tệp duy nhất được hỗ trợ hiện tại là |
dateRange |
Đối tượng này được dùng cho nhóm thuần tập |
Loại
Loại nhóm thuần tập.
Enum | |
---|---|
UNSPECIFIED_COHORT_TYPE |
Nếu bạn không chỉ định, thì mô-đun này sẽ được coi là FIRST_VISIT_DATE . |
FIRST_VISIT_DATE |
Nhóm thuần tập được chọn dựa trên ngày truy cập lần đầu tiên. |
Báo cáo
Phản hồi dữ liệu tương ứng với yêu cầu.
Biểu diễn dưới dạng JSON | |
---|---|
{ "columnHeader": { object( |
Trường | |
---|---|
columnHeader |
Tiêu đề cột. |
data |
Dữ liệu về phản hồi. |
nextPageToken |
Mã thông báo trang để truy xuất trang tiếp theo của kết quả trong danh sách. |
ColumnHeader
Tiêu đề cột.
Biểu diễn dưới dạng JSON | |
---|---|
{
"dimensions": [
string
],
"metricHeader": {
object( |
Trường | |
---|---|
dimensions[] |
Tên phương diện trong phản hồi. |
metricHeader |
Tiêu đề chỉ số cho các chỉ số trong nội dung phản hồi. |
MetricHeader
Tiêu đề cho các chỉ số.
Biểu diễn dưới dạng JSON | |
---|---|
{ "metricHeaderEntries": [ { object( |
Trường | |
---|---|
metricHeaderEntries[] |
Tiêu đề cho các chỉ số trong phản hồi. |
pivotHeaders[] |
Tiêu đề cho các trục xoay trong phản hồi. |
MetricHeaderEntry
Tiêu đề cho các chỉ số.
Biểu diễn dưới dạng JSON | |
---|---|
{
"name": string,
"type": enum( |
Trường | |
---|---|
name |
Tên của tiêu đề. |
type |
Loại chỉ số, ví dụ: |
PivotHeader
Tiêu đề cho mỗi phần tổng hợp được xác định trong yêu cầu.
Biểu diễn dưới dạng JSON | |
---|---|
{
"pivotHeaderEntries": [
{
object( |
Trường | |
---|---|
pivotHeaderEntries[] |
Một tiêu đề mục tổng hợp. |
totalPivotGroupsCount |
Tổng số nhóm trên bảng tổng hợp này. |
PivotHeaderEntry
Tiêu đề cho từng cột chỉ số tương ứng với các chỉ số được yêu cầu trong phần tổng hợp của nội dung phản hồi.
Biểu diễn dưới dạng JSON | |
---|---|
{
"dimensionNames": [
string
],
"dimensionValues": [
string
],
"metric": {
object( |
Trường | |
---|---|
dimensionNames[] |
Tên của các phương diện trong phản hồi tổng hợp. |
dimensionValues[] |
Giá trị cho các phương diện trong bảng tổng hợp. |
metric |
Tiêu đề chỉ số cho chỉ số trong bảng tổng hợp. |
ReportData
Phần dữ liệu của báo cáo.
Biểu diễn dưới dạng JSON | |
---|---|
{ "rows": [ { object( |
Trường | |
---|---|
rows[] |
Mỗi tổ hợp phương diện riêng biệt đều có một ReportRow. |
totals[] |
Đối với mỗi phạm vi ngày được yêu cầu, đối với tập hợp tất cả các hàng khớp với truy vấn, mọi định dạng giá trị được yêu cầu sẽ nhận được tổng số. Tổng cho một định dạng giá trị được tính bằng cách trước tiên tính tổng các chỉ số được đề cập trong định dạng giá trị, sau đó đánh giá định dạng giá trị dưới dạng biểu thức vô hướng. Ví dụ: "Các tổng" cho |
rowCount |
Tổng số hàng phù hợp cho truy vấn này. |
minimums[] |
Giá trị tối thiểu và tối đa nhìn thấy trên tất cả các hàng phù hợp. Cả hai giá trị này đều trống khi |
maximums[] |
Giá trị tối thiểu và tối đa nhìn thấy trên tất cả các hàng phù hợp. Cả hai giá trị này đều trống khi |
samplesReadCounts[] |
Nếu kết quả được lấy mẫu, thì hàm này sẽ trả về tổng số mẫu đã đọc, một mục nhập cho mỗi phạm vi ngày. Nếu kết quả không được lấy mẫu, trường này sẽ không được xác định. Xem hướng dẫn cho nhà phát triển để biết thông tin chi tiết. |
samplingSpaceSizes[] |
Nếu kết quả được lấy mẫu, thì hàm này sẽ trả về tổng số mẫu hiện có, một mục nhập cho mỗi phạm vi ngày. Nếu kết quả không được lấy mẫu, trường này sẽ không được xác định. Xem hướng dẫn cho nhà phát triển để biết thông tin chi tiết. |
isDataGolden |
Cho biết liệu phản hồi cho yêu cầu này có phải là phản hồi vàng hay không. Dữ liệu là giá trị vàng khi chính yêu cầu đó sẽ không tạo ra kết quả mới nào nếu sau này được hỏi. |
dataLastRefreshed |
Lần làm mới dữ liệu trong báo cáo gần đây nhất. Tất cả các lượt truy cập nhận được trước dấu thời gian này đều được đưa vào tính toán của báo cáo. Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, chính xác đến nano giây. Ví dụ: |
ReportRow
Một hàng trong báo cáo.
Biểu diễn dưới dạng JSON | |
---|---|
{
"dimensions": [
string
],
"metrics": [
{
object( |
Trường | |
---|---|
dimensions[] |
Danh sách các phương diện được yêu cầu. |
metrics[] |
Danh sách chỉ số cho từng DateRange được yêu cầu. |
DateRangeValues
Dùng để trả về danh sách chỉ số cho một tổ hợp phương diện / phạm vi ngày
Biểu diễn dưới dạng JSON | |
---|---|
{
"values": [
string
],
"pivotValueRegions": [
{
object( |
Trường | |
---|---|
values[] |
Mỗi giá trị tương ứng với mỗi Chỉ số trong yêu cầu. |
pivotValueRegions[] |
Giá trị của từng vùng xoay vòng. |
PivotValueRegion
Các giá trị chỉ số trong vùng xoay vòng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "values": [ string ] } |
Trường | |
---|---|
values[] |
Giá trị của các chỉ số trong mỗi vùng tổng hợp. |
ResourceQuotasRemaining
Mã thông báo hạn mức tài nguyên còn lại cho tài sản sau khi yêu cầu hoàn tất.
Biểu diễn dưới dạng JSON | |
---|---|
{ "dailyQuotaTokensRemaining": number, "hourlyQuotaTokensRemaining": number } |
Trường | |
---|---|
dailyQuotaTokensRemaining |
Hạn mức tài nguyên còn lại hằng ngày. |
hourlyQuotaTokensRemaining |
Số mã thông báo hạn mức tài nguyên còn lại hằng giờ. |