Method: properties.audienceLists.query

Truy xuất danh sách đối tượng gồm những người dùng. Sau khi bạn tạo đối tượng, người dùng sẽ không được thêm vào danh sách ngay lập tức. Trước tiên, bạn cần có một yêu cầu đến audienceLists.create để tạo danh sách đối tượng người dùng, sau đó, 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 về Danh sách đối tượng cùng với ví dụ.

Đối tượng trong Google Analytics 4 giúp bạn phân đoạn người dùng theo những cách quan trọng đối với công việc kinh doanh của bạn. Để tìm hiểu thêm, hãy xem bài viết https://support.google.com/analytics/answer/9267572.

Phương thức này có sẵn ở trạng thái ổn định beta tại audienceExports.query. Để gửi ý kiến phản hồi về API này, hãy hoàn tất biểu mẫu Phản hồi về Audience Export API 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

string

Bắt buộc. Tên của danh sách đối tượng để truy xuất người dùng. Định dạng properties/{property}/audienceLists/{audienceList}

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

string (int64 format)

Không bắt buộc. Số 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 độ dời; hoặc tương đương, đặt độ dời thành 0; yêu cầu đầu tiên trả về limit đầu tiên của các hàng. Yêu cầu thứ hai đặt độ dời thành limit của yêu cầu đầu tiên; yêu cầu thứ hai trả về limit thứ hai của các hàng.

Để tìm hiểu thêm về thông số phân trang này, hãy xem phần Phân trang.
limit

string (int64 format)

Không bắt buộc. Số lượng hàng sẽ trả về. 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.

Để tìm hiểu thêm về thông số phân trang này, hãy xem phần 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 (AudienceRow)
    }
  ],
  "audienceList": {
    object (AudienceList)
  },
  "rowCount": integer
}
Trường
audienceRows[]

object (AudienceRow)

Các hàng cho mỗi người dùng trong danh sách đối tượng. Số 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

object (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 đối tượng trong phản hồ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

integer

Tổng số hàng trong kết quả AudienceList. rowCount độc lập với số hàng được trả về trong phản hồi, tham số yêu cầu limit và tham số yêu cầu offset. Ví dụ: nếu một truy vấn trả về 175 hàng và bao gồm limit gồm 50 hàng trong yêu cầu API, thì phản hồi sẽ chứa rowCount gồm 175 hàng nhưng chỉ có 50 hàng.

Để tìm hiểu thêm về thông số phân trang này, hãy xem phần 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 trong đối tượng.

Biểu diễn dưới dạng JSON 
{
  "dimensionValues": [
    {
      object (AudienceDimensionValue)
    }
  ]
}
Trường
dimensionValues[]

object (AudienceDimensionValue)

Mỗi thuộc tính giá trị phương diện cho một người dùng trong đối tượng. Hệ thống sẽ thêm một giá trị phương diện 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 one_value can be only one of the following:
  "value": string
  // 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 loại giá trị phương diện. one_value chỉ có thể là một trong những giá trị sau:
value

string

Giá trị dưới dạng chuỗi nếu loại phương diện là chuỗi.