Method: properties.audienceLists.exportSheet

Xuất danh sách đối tượng gồm những người dùng sang Google Trang tính. Sau khi tạo đối tượng, người dùng không thể xuất hiện ngay lập tức để đăng trang thông tin. Trước tiên, bạn cần gửi yêu cầu đến audienceLists.create để tạo danh sách đối tượng gồm những người dùng. Sau đó, thứ hai, phương thức này được dùng để xuất những người dùng đó trong danh sách đối tượng sang Google Trang tính.

Xem bài viết Tạo Danh sách đối tượng để biết giới thiệu về Danh sách đối tượng kèm theo các 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.

Phương thức này được ra mắt với độ ổn định alpha, nhằm mục đích thu thập thông tin phản hồi về cú pháp và chức năng trước khi chuyển sang giai đoạn thử nghiệm beta. Để 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/*}:exportSheet

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ố 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

Google Trang tính đã tạo có 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 
{
  "spreadsheetUri": string,
  "spreadsheetId": string,
  "rowCount": integer,
  "audienceList": {
    object (AudienceList)
  }
}
Trường
spreadsheetUri

string

URI cho bạn truy cập trong trình duyệt để xem Google Trang tính.
spreadsheetId

string

Mã nhận dạng xác định tài nguyên Google Trang tính đã tạo.
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/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.
audienceList

object (AudienceList)

Dữ liệu cấu hình về AudienceList đang được xuất. Quay lại để giúp diễn giải Danh sách đối tượng trong Google Trang tính của phản hồi này.

Ví dụ: AudienceList có thể có nhiều hàng hơn so với số hàng trong Google Trang tính. Trong trường hợp đó, bạn nên gửi thêm một yêu cầu xuất trang tính có giá trị offset khác để truy xuất trang tiếp theo của các hàng trong một tệp Google Trang tính bổ sung.

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
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets