Tài liệu này mô tả một số tính năng nâng cao của API Dữ liệu Google Analytics phiên bản 1. Để biết tài liệu tham khảo chi tiết về API, hãy xem Tài liệu tham khảo API.
Định nghĩa tuỳ chỉnh về trang thông tin và cách tạo báo cáo
Data API có thể tạo báo cáo trên các Phương diện tuỳ chỉnh và Chỉ số tuỳ chỉnh đã đăng ký. Bạn có thể sử dụng Phương thức API siêu dữ liệu để liệt kê tên API của các Định nghĩa tuỳ chỉnh đã đăng ký cho Thuộc tính. Ví dụ: bạn có thể sử dụng các tên API này trong Yêu cầu báo cáo cho phương thức runReport.
Các phần sau đây trình bày ví dụ cho từng loại Định nghĩa tuỳ chỉnh. Trong các ví dụ này, hãy thay thế GA4_PROPERTY_ID bằng Mã tài sản của bạn.
Phương diện tùy chỉnh trong phạm vi sự kiện
Bước 1: Truy vấn Phương thức API siêu dữ liệu bằng Mã thuộc tính của bạn.
GET https://analyticsdata.googleapis.com/v1beta/properties/GA4_PROPERTY_ID/metadata
Bước 2: Tìm Phương diện tuỳ chỉnh trong phạm vi sự kiện mà bạn muốn tạo báo cáo từ phản hồi. Nếu chưa có phương diện thì bạn cần đăng ký phương diện đó.
"dimensions": [
...
{
"apiName": "customEvent:achievement_id",
"uiName": "Achievement ID",
"description": "An event scoped custom dimension for your Analytics property."
},
...
],
Bước 3: Thêm phương diện tuỳ chỉnh vào yêu cầu báo cáo. Dưới đây là yêu cầu mẫu cho phương thức runReport.
POST https://analyticsdata.googleapis.com/v1beta/properties/GA4_PROPERTY_ID:runReport
{
"dateRanges": [{ "startDate": "2020-09-01", "endDate": "2020-09-15" }],
"dimensions": [{ "name": "customEvent:achievement_id" }],
"metrics": [{ "name": "eventCount" }]
}
Phương diện tuỳ chỉnh trong phạm vi người dùng
Bước 1: Truy vấn Phương thức API siêu dữ liệu bằng Mã thuộc tính của bạn.
GET https://analyticsdata.googleapis.com/v1beta/properties/GA4_PROPERTY_ID/metadata
Bước 2: Tìm Phương diện tuỳ chỉnh trong phạm vi người dùng mà bạn muốn tạo báo cáo từ phản hồi. Nếu chưa có phương diện thì bạn cần đăng ký phương diện đó.
"dimensions": [
...
{
"apiName": "customUser:last_level",
"uiName": "Last level",
"description": "A user property for your Analytics property."
},
...
],
Bước 3: Thêm phương diện tuỳ chỉnh vào yêu cầu báo cáo. Dưới đây là yêu cầu mẫu cho phương thức runReport.
POST https://analyticsdata.googleapis.com/v1beta/properties/GA4_PROPERTY_ID:runReport
{
"entity": { "propertyId": "GA4_PROPERTY_ID" },
"dateRanges": [{ "startDate": "7daysAgo", "endDate": "yesterday" }],
"dimensions": [{ "name": "customUser:last_level" }],
"metrics": [{ "name": "activeUsers" }]
}
Chỉ số tùy chỉnh ở phạm vi sự kiện
Bước 1: Truy vấn Phương thức API siêu dữ liệu bằng Mã thuộc tính của bạn.
GET https://analyticsdata.googleapis.com/v1beta/properties/GA4_PROPERTY_ID/metadata
Bước 2: Tìm Chỉ số tuỳ chỉnh trong phạm vi sự kiện mà bạn muốn tạo báo cáo từ phản hồi. Nếu không có chỉ số này, bạn cần đăng ký chỉ số đó.
"metrics": [
...
{
"apiName": "customEvent:credits_spent",
"uiName": "Credits Spent",
"description": "An event scoped custom metric for your Analytics property.",
"type": "TYPE_STANDARD"
},
...
],
Bước 3: Đưa chỉ số tuỳ chỉnh vào yêu cầu báo cáo. Dưới đây là yêu cầu mẫu cho phương thức runReport.
POST https://analyticsdata.googleapis.com/v1beta/properties/GA4_PROPERTY_ID:runReport
{
"dateRanges": [{ "startDate": "30daysAgo", "endDate": "yesterday" }],
"dimensions": [{ "name": "eventName" }],
"metrics": [{ "name": "customEvent:credits_spent" }]
}
Chỉ số tỷ lệ chuyển đổi cho một lượt chuyển đổi
Bước 1: Truy vấn Phương thức API siêu dữ liệu bằng Mã thuộc tính của bạn.
GET https://analyticsdata.googleapis.com/v1beta/properties/GA4_PROPERTY_ID/metadata
Bước 2: Tìm chỉ số tỷ lệ chuyển đổi cho một lượt chuyển đổi mà bạn muốn tạo báo cáo từ phản hồi. Nếu không có sự kiện chuyển đổi, bạn cần thiết lập sự kiện chuyển đổi.
"metrics": [
...
{
"apiName": "sessionConversionRate:add_to_cart",
"uiName": "Session conversion rate for add_to_cart",
"description": "The percentage of sessions in which a specific conversion event was triggered",
},
...
],
Bước 3: Đưa chỉ số tỷ lệ chuyển đổi vào yêu cầu báo cáo. Dưới đây là yêu cầu mẫu cho phương thức runReport.
POST https://analyticsdata.googleapis.com/v1beta/properties/GA4_PROPERTY_ID:runReport
{
"dateRanges": [{ "startDate": "30daysAgo", "endDate": "yesterday" }],
"dimensions": [{ "name": "eventName" }],
"metrics": [{ "name": "sessionConversionRate:add_to_cart" }]
}
Trung bình chỉ số tùy chỉnh trong phạm vi sự kiện
Bước 1: Truy vấn Phương thức API siêu dữ liệu bằng Mã thuộc tính của bạn.
GET https://analyticsdata.googleapis.com/v1beta/properties/GA4_PROPERTY_ID/metadata
Bước 2: Tìm Giá trị trung bình của chỉ số tuỳ chỉnh trong phạm vi sự kiện mà bạn muốn tạo báo cáo từ phản hồi. Nếu không có chỉ số này, bạn cần đăng ký chỉ số đó.
"metrics": [
...
{
"apiName": "averageCustomEvent:credits_spent",
"uiName": "Average Credits Spent",
"description": "The average of an event scoped custom metric for your Analytics property.",
"type": "TYPE_STANDARD"
},
...
],
Bước 3: Thêm giá trị trung bình của chỉ số tuỳ chỉnh vào một yêu cầu báo cáo. Dưới đây là yêu cầu mẫu cho phương thức runReport.
POST https://analyticsdata.googleapis.com/v1beta/properties/GA4_PROPERTY_ID:runReport
{
"dateRanges": [{ "startDate": "2020-11-01", "endDate": "2020-11-10" }],
"dimensions": [{ "name": "eventName" }],
"metrics": [{ "name": "averageCustomEvent:credits_spent" }]
}
Ví dụ về 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. Để biết tài liệu chi tiết về từng trường API, hãy xem tài liệu tham khảo REST cho nhóm thuần tập.
Tạo báo cáo nhóm thuần tập
Dưới đây là một báo cáo nhóm thuần tập mẫu, trong đó:
- Nhóm thuần tập là những người dùng có
firstSessionDatelà2020-12-01; đối tượng này được định cấu hình bởi đối tượngcohorts. Các phương diện và chỉ số trong phản hồi báo cáo sẽ chỉ dựa trên người dùng của nhóm thuần tập. - Báo cáo nhóm thuần tập sẽ hiển thị 3 cột. Cột này được định cấu hình bởi các đối tượng chỉ số và phương diện.
- Phương diện
cohortlà tên của nhóm thuần tập. - Phương diện
cohortNthDaylà số ngày kể từ ngày2020-12-01. - Chỉ số
cohortActiveUserslà số lượng người dùng vẫn đang hoạt động.
- Phương diện
- Đối tượng
cohortsRangechỉ định rằng báo cáo phải chứa dữ liệu sự kiện bắt đầu từ2020-12-01và kết thúc vào2020-12-06cho nhóm thuần tập này.- Khi sử dụng độ chi tiết của
DAILY, bạn nên sử dụng kích thướccohortNthDayđể đảm bảo tính nhất quán.
- Khi sử dụng độ chi tiết của
Yêu cầu báo cáo cho nhóm thuần tập là:
POST https://analyticsdata.googleapis.com/v1beta/properties/GA4_PROPERTY_ID:runReport
{
"dimensions": [{ "name": "cohort" }, { "name": "cohortNthDay" }],
"metrics": [{ "name": "cohortActiveUsers" }],
"cohortSpec": {
"cohorts": [
{
"dimension": "firstSessionDate",
"dateRange": { "startDate": "2020-12-01", "endDate": "2020-12-01" }
}
],
"cohortsRange": {
"endOffset": 5,
"granularity": "DAILY"
}
},
}
Đối với yêu cầu này, ví dụ về phản hồi báo cáo là:
{
"dimensionHeaders": [
{ "name": "cohort" }, { "name": "cohortNthDay" }
],
"metricHeaders": [
{ "name": "cohortActiveUsers", "type": "TYPE_INTEGER" }
],
"rows": [
{
"dimensionValues": [{ "value": "cohort_0" },{ "value": "0000" }],
"metricValues": [{ "value": "293" }]
},
{
"dimensionValues": [{ "value": "cohort_0" },{ "value": "0001" }],
"metricValues": [{ "value": "143" }]
},
{
"dimensionValues": [{ "value": "cohort_0" },{ "value": "0002" }],
"metricValues": [{ "value": "123" }]
},
{
"dimensionValues": [{ "value": "cohort_0" },{ "value": "0003" }],
"metricValues": [{ "value": "92" }]
},
{
"dimensionValues": [{ "value": "cohort_0" },{ "value": "0005" }],
"metricValues": [{ "value": "86" }]
},
{
"dimensionValues": [{ "value": "cohort_0" },{ "value": "0004" }],
"metricValues": [{ "value": "83" }]
}
],
"metadata": {},
"rowCount": 6
}
Từ câu trả lời báo cáo này, sẽ có một biểu đồ cho báo cáo Nhóm thuần tập này. Thông tin chi tiết từ báo cáo này cho thấy mức giảm lớn nhất về số người dùng đang hoạt động của nhóm thuần tập này là trong khoảng thời gian từ ngày đầu tiên đến ngày thứ hai.
Nhiều nhóm thuần tập và Tỷ lệ giữ chân người dùng
Thu nạp và giữ chân người dùng là các cách để phát triển trang web hoặc ứng dụng của bạn. Báo cáo nhóm thuần tập tập trung vào tỷ lệ giữ chân người dùng. Trong ví dụ này, báo cáo cho thấy tài sản này đã tăng tỷ lệ giữ chân người dùng thêm 4 ngày thêm 10% trong 2 tuần.
Để tạo báo cáo này, chúng tôi chỉ định 3 nhóm thuần tập: nhóm đầu tiên có
firstSessionDate là 2020-11-02, nhóm thứ hai có firstSessionDate là
2020-11-09 và nhóm thứ ba có firstSessionDate là 2020-11-16. Vì số lượng người dùng trên tài sản của bạn sẽ thay đổi trong 3 ngày này, nên chúng tôi so sánh chỉ số tỷ lệ giữ chân người dùng của nhóm thuần tập là cohortActiveUsers/cohortTotalUsers thay vì sử dụng chỉ số trực tiếp của cohortActiveUsers.
Yêu cầu báo cáo cho các nhóm thuần tập này là:
POST https://analyticsdata.googleapis.com/v1beta/properties/GA4_PROPERTY_ID:runReport
{
"dimensions": [{ "name": "cohort" },{ "name": "cohortNthDay" }],
"metrics": [
{
"name": "cohortRetentionFraction",
"expression": "cohortActiveUsers/cohortTotalUsers"
}
],
"cohortSpec": {
"cohorts": [
{
"dimension": "firstSessionDate",
"dateRange": { "startDate": "2020-11-02", "endDate": "2020-11-02" }
},
{
"dimension": "firstSessionDate",
"dateRange": { "startDate": "2020-11-09", "endDate": "2020-11-09" }
},
{
"dimension": "firstSessionDate",
"dateRange": { "startDate": "2020-11-16", "endDate": "2020-11-16" }
}
],
"cohortsRange": {
"endOffset": 4,
"granularity": "DAILY"
}
},
}
Đối với yêu cầu này, ví dụ về phản hồi báo cáo là:
{
"dimensionHeaders": [{ "name": "cohort" },{ "name": "cohortNthDay" }],
"metricHeaders": [{
"name": "cohortRetentionFraction",
"type": "TYPE_FLOAT"
}
],
"rows": [
{
"dimensionValues": [{ "value": "cohort_0" },{ "value": "0000" }],
"metricValues": [{ "value": "1" }]
},
{
"dimensionValues": [{ "value": "cohort_1" },{ "value": "0000" }],
"metricValues": [{ "value": "1" }]
},
{
"dimensionValues": [{ "value": "cohort_2" },{ "value": "0000" }],
"metricValues": [{ "value": "1" }]
},
{
"dimensionValues": [{ "value": "cohort_2" },{ "value": "0001" }],
"metricValues": [{ "value": "0.308" }]
},
{
"dimensionValues": [{ "value": "cohort_1" },{ "value": "0001" }],
"metricValues": [{ "value": "0.272" }]
},
{
"dimensionValues": [{ "value": "cohort_2" },{ "value": "0002" }],
"metricValues": [{ "value": "0.257" }]
},
{
"dimensionValues": [{ "value": "cohort_0" },{ "value": "0001" }],
"metricValues": [{ "value": "0.248" }]
},
{
"dimensionValues": [{ "value": "cohort_2" },{ "value": "0003" }],
"metricValues": [{ "value": "0.235" }]
},
{
"dimensionValues": [{ "value": "cohort_2" },{ "value": "0004" }],
"metricValues": [{ "value": "0.211" }]
},
{
"dimensionValues": [{ "value": "cohort_1" },{ "value": "0002" }],
"metricValues": [{ "value": "0.198" }]
},
{
"dimensionValues": [{ "value": "cohort_0" },{ "value": "0002" }],
"metricValues": [{ "value": "0.172" }]
},
{
"dimensionValues": [{ "value": "cohort_1" },{ "value": "0003" }],
"metricValues": [{ "value": "0.167" }]
},
{
"dimensionValues": [{ "value": "cohort_1" },{ "value": "0004" }],
"metricValues": [{ "value": "0.155" }]
},
{
"dimensionValues": [{ "value": "cohort_0" },{ "value": "0003" }],
"metricValues": [{ "value": "0.141" }]
},
{
"dimensionValues": [{ "value": "cohort_0" },{ "value": "0004" }],
"metricValues": [{ "value": "0.118" }]
}
],
"metadata": {},
"rowCount": 15
}
Từ câu trả lời báo cáo này, sẽ có một biểu đồ cho báo cáo Nhóm thuần tập này. Thông tin chi tiết từ báo cáo này cho thấy tỷ lệ giữ chân người dùng trong 4 ngày đã tăng 10% trong 2 tuần. Nhóm thuần tập sau này có firstSessionDate/2020-11-16 đã vượt quá tỷ lệ giữ chân của nhóm thuần tập trước đó với firstSessionDate là 2020-11-02.
Nhóm thuần tập hằng tuần và Sử dụng nhóm thuần tập với các tính năng API khác
Để loại bỏ sự chênh lệch hằng ngày trong hành vi của người dùng, hãy sử dụng nhóm thuần tập hằng tuần. Trong báo cáo nhóm thuần tập hằng tuần, tất cả người dùng có firstSessionDate trong cùng một tuần sẽ tạo thành nhóm thuần tập. Tuần bắt đầu vào Chủ Nhật và kết thúc vào thứ Bảy. Ngoài ra, trong báo cáo này, chúng tôi sẽ chia nhỏ nhóm thuần tập để so sánh người dùng có hoạt động ở Nga với người dùng có hoạt động ở Mexico. Việc cắt lát này sử dụng chiều country và dimensionFilter để chỉ xem xét 2 quốc gia.
Yêu cầu báo cáo cho các nhóm thuần tập này là:
POST https://analyticsdata.googleapis.com/v1beta/properties/GA4_PROPERTY_ID:runReport
{
"dimensions": [
{ "name": "cohort" },
{ "name": "cohortNthWeek" },
{ "name": "country" }
],
"metrics": [{ "name": "cohortActiveUsers" }],
"dimensionFilter": {
"filter": {
"fieldName": "country",
"inListFilter": {
"values": [ "Russia", "Mexico" ]
}
}
},
"cohortSpec": {
"cohorts": [
{
"dimension": "firstSessionDate",
"dateRange": {
"startDate": "2020-10-04",
"endDate": "2020-10-10"
}
}
],
"cohortsRange": {
"endOffset": 5,
"granularity": "WEEKLY"
}
},
}
Đối với yêu cầu này, ví dụ về phản hồi báo cáo là:
{
"dimensionHeaders": [
{ "name": "cohort" },
{ "name": "cohortNthWeek" },
{ "name": "country" }
],
"metricHeaders": [
{ "name": "cohortActiveUsers", "type": "TYPE_INTEGER" }
],
"rows": [
{
"dimensionValues": [
{ "value": "cohort_0" },{ "value": "0000" },{ "value": "Russia" }
],
"metricValues": [{ "value": "105" }]
},
{
"dimensionValues": [
{ "value": "cohort_0" },{ "value": "0000" },{ "value": "Mexico" }
],
"metricValues": [{ "value": "98" }]
},
{
"dimensionValues": [
{ "value": "cohort_0" },{ "value": "0001" },{ "value": "Mexico" }
],
"metricValues": [{ "value": "35" }]
},
{
"dimensionValues": [
{ "value": "cohort_0" },{ "value": "0002" },{ "value": "Mexico" }
],
"metricValues": [{ "value": "24" }]
},
{
"dimensionValues": [
{ "value": "cohort_0" },{ "value": "0001" },{ "value": "Russia" }
],
"metricValues": [{ "value": "23" }]
},
{
"dimensionValues": [
{ "value": "cohort_0" },{ "value": "0004" },{ "value": "Mexico" }
],
"metricValues": [{ "value": "17" }]
},
{
"dimensionValues": [
{ "value": "cohort_0" },{ "value": "0003" },{ "value": "Mexico" }
],
"metricValues": [{ "value": "15" }]
},
{
"dimensionValues": [
{ "value": "cohort_0" },{ "value": "0005" },{ "value": "Mexico" }
],
"metricValues": [{ "value": "15" }]
},
{
"dimensionValues": [
{ "value": "cohort_0" },{ "value": "0002" },{ "value": "Russia" }
],
"metricValues": [{ "value": "3" }]
},
{
"dimensionValues": [
{ "value": "cohort_0" },{ "value": "0003" },{ "value": "Russia" }
],
"metricValues": [{ "value": "1" }]
},
{
"dimensionValues": [
{ "value": "cohort_0" },{ "value": "0004" },{ "value": "Russia" }
],
"metricValues": [{ "value": "1" }]
}
],
"metadata": {},
"rowCount": 11
}
Từ câu trả lời báo cáo này, sẽ có một biểu đồ của báo cáo Nhóm thuần tập này. Dựa trên báo cáo này, tài sản này giữ chân người dùng có hoạt động ở Mexico tốt hơn so với người dùng có hoạt động ở Nga.
