Method: properties.audienceExports.query

Truy xuất dữ liệu xuất đối tượng của người dùng. Sau khi tạo đối tượng, người dùng không thể xuất đối tượng ngay lập tức. Trước tiên, bạn cần gửi yêu cầu đến audienceExports.create để tạo tệp xuất đối tượng người dùng. Sau đó, thứ hai, phương thức này được dùng để truy xuất người dùng trong tệp xuất đối tượng.

Hãy xem bài viết Tạo tệp xuất đối tượng để tìm hiểu về tính năng Xuất đối tượng kèm theo ví dụ.

Đối tượng trong Google Analytics 4 cho phép bạn phân chia người dùng thành những phân khúc 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 https://support.google.com/analytics/answer/9267572.

Audience Export API có một số phương thức ở mức alpha và các phương pháp khác ở mức ổn định trong giai đoạn beta. Mục đích là để nâng cao độ ổn định của phiên bản beta sau khi nhận được một số ý kiến phản hồi và áp dụng. Để 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/v1beta/{name=properties/*/audienceExports/*}: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 dữ liệu xuất đối tượng để truy xuất người dùng. Định dạng properties/{property}/audienceExports/{audienceExport}

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ố 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 độ lệch bằng 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 độ lệch với 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ố hàng cần trả về. Nếu không chỉ định, hàm sẽ trả về 10.000 hàng. API 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 dữ liệu xuất đố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)
    }
  ],
  "audienceExport": {
    object (AudienceExport)
  },
  "rowCount": integer
}
Trường
audienceRows[]

object (AudienceRow)

Các hàng cho từng người dùng trong một lượt xuất đố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.
audienceExport

object (AudienceExport)

Dữ liệu cấu hình về AudienceExport đ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 AudienceExport này tương ứng với các cột trong AudienceRows.
rowCount

integer

Tổng số hàng trong kết quả AudienceExport. 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/50 trong yêu cầu API, thì phản hồi sẽ chứa rowCount trong số 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 đây:

  • 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 là đố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 là đố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 
{

  // 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 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:
value

string

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