- Yêu cầu HTTP
- Tham số đường dẫn
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi uỷ quyền
- AudienceRow
- AudienceDimensionValue
- Hãy làm thử!
Truy xuất danh sách đối tượng gồm người dùng. Sau khi bạn tạo đối tượng, hệ thống sẽ không thể liệt kê người dùng ngay lập tức. Đầu tiên, bạn cần gửi yêu cầu đến audienceLists.create
để tạo danh sách đối tượng người dùng. Thứ hai, phương thức này được dùng để truy xuất người dùng trong danh sách đối tượng.
Hãy xem bài viết Tạo danh sách đối tượng để tìm hiểu giới thiệu về Danh sách đối tượng kèm theo ví dụ.
Các đối tượng trong Google Analytics 4 cho phép bạn tạo phân khúc người dùng theo những cách có ý nghĩa đối với công việc kinh doanh của bạn. Để tìm hiểu thêm, hãy xem https://support.google.com/analytics/answer/9267572.
Phương pháp này có sẵn ở độ ổn định beta tại audienceExports.query. Để đưa ra ý kiến phản hồi về API này, hãy hoàn thành biểu mẫu Phản hồi về API Xuất đối tượng của Google Analytics.
Yêu cầu HTTP
POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:query
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số đường dẫn
Tham số | |
---|---|
name |
Bắt buộc. Tên của danh sách đối tượng để truy xuất người dùng. Định dạng |
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 |
---|
{ "offset": string, "limit": string } |
Trường | |
---|---|
offset |
Không bắt buộc. Số lượng hàng của hàng bắt đầu. Hàng đầu tiên được tính là hàng 0. Khi phân trang, yêu cầu đầu tiên không chỉ định độ lệch; hoặc tương đương, đặt giá trị bù trừ bằng 0; yêu cầu đầu tiên sẽ trả về Để tìm hiểu thêm về thông số phân trang này, hãy xem nội dung Phân trang. |
limit |
Không bắt buộc. Số hàng cần trả về. Nếu bạn không chỉ định thì 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. API cũng có thể trả về ít hàng hơn so với Để tìm hiểu thêm về thông số phân trang này, hãy xem nội dung Phân trang. |
Nội dung phản hồi
Danh sách người dùng trong một danh sách đối tượng.
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:
Biểu diễn dưới dạng JSON |
---|
{ "audienceRows": [ { object ( |
Trường | |
---|---|
audienceRows[] |
Hàng cho từng người dùng trong danh sách đối tượng. Số lượng hàng trong phản hồi này sẽ nhỏ hơn hoặc bằng kích thước trang của yêu cầu. |
audienceList |
Dữ liệu cấu hình về AudienceList đang được truy vấn. Được trả về để giúp diễn giải các hàng về đối tượng trong câu trả lời này. Ví dụ: các phương diện trong AudienceList này tương ứng với các cột trong AudienceRows. |
rowCount |
Tổng số hàng trong kết quả AudienceList. Để tìm hiểu thêm về thông số phân trang này, hãy xem nội dung Phân trang. |
Phạm vi uỷ quyền
Yêu cầu một trong các phạm vi OAuth sau:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
AudienceRow
Thuộc tính giá trị phương diện cho hàng người dùng của đối tượng.
Biểu diễn dưới dạng JSON |
---|
{
"dimensionValues": [
{
object ( |
Trường | |
---|---|
dimensionValues[] |
Mỗi thuộc tính giá trị phương diện cho một người dùng thuộc đối tượng. Một giá trị phương diện sẽ được thêm vào cho mỗi cột phương diện được yêu cầu. |
AudienceDimensionValue
Giá trị của một phương diện.
Biểu diễn dưới dạng JSON |
---|
{ // Union field |
Trường | |
---|---|
Trường kết hợp one_value . Một loại giá trị phương diện. one_value chỉ có thể là một trong những trạng thái sau đây: |
|
value |
Giá trị dưới dạng chuỗi nếu loại phương diện là chuỗi. |