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 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 pháp 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.

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 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. Để đư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/*}: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 giá trị bù trừ bằng 0; yêu cầu đầu tiên sẽ trả về limit hàng đầu tiên. Yêu cầu thứ hai thiết lập độ lệch thành limit của yêu cầu đầu tiên; yêu cầu thứ hai sẽ trả về limit thứ hai của hàng.

Để 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

string (int64 format)

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. limit phải là số dương.

API cũng có thể trả về ít hàng hơn so với 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 nội dung Phân trang.

Nội dung phản hồi

Tệp 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 để bạn truy cập trong trình duyệt để xem Google Trang tính.
spreadsheetId

string

Mã nhận dạng giúp 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 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 hàng 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ề thông số phân trang này, hãy xem nội dung Phân trang.
audienceList

object (AudienceList)

Dữ liệu cấu hình về AudienceList đang được xuất. Được trả lại để giúp diễn giải AudienceList trong Google Trang tính của câu trả lời này.

Ví dụ: Danh sách đối tượng có thể có nhiều hàng hơn số hàng trong Google Trang tính. Trong trường hợp đó, bạn có thể cần gửi thêm 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:

  • 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