Method: properties.audienceLists.query

Truy xuất danh sách đối tượng người dùng. Sau khi bạn tạo đối tượng, người dùng sẽ không xuất hiện ngay trong danh sách. Trước tiên, bạn cần gửi một yêu cầu đến audienceLists.create để tạo danh sách đối tượng người dùng, sau đó, bạn có thể sử dụng phương thức này để truy xuất người dùng trong danh sách đối tượng.

Hãy xem phần Tạo danh sách đối tượng để biết thông tin giới thiệu về Danh sách đối tượng kèm theo ví dụ.

Đối tượng trong Google Analytics 4 giúp bạn phân đoạn người dùng theo những khía cạnh quan trọng đối với hoạt động kinh doanh của mình. Để 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ó độ ổ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 Ý kiến phản hồi về Google Analytics Audience Export API.

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 cần 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 với 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 độ lệch; hoặc tương đương với việc đặt độ lệch thành 0; yêu cầu đầu tiên trả về limit hàng đầu tiên. Yêu cầu thứ hai đặt độ lệch 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ề tham 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ố hàng sẽ trả về. Nếu bạn không chỉ định, thì 10.000 hàng sẽ được trả về. API này 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ề tham 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)

Hàng cho mỗi người dùng trong một 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

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 không phụ thuộc vào 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 là 50 trong yêu cầu API, thì phản hồi sẽ chứa rowCount là 175 nhưng chỉ có 50 hàng.

Để tìm hiểu thêm về tham 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 của đố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. Một giá trị phương diện sẽ được thêm 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 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "value": string
  // End of mutually exclusive fields.
}
Trường
Một loại giá trị phương diện. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
value

string

Giá trị dưới dạng chuỗi nếu loại phương diện là chuỗi.
Kết thúc các trường xung khắc.