REST Resource: properties.audienceExports

Tài nguyên: AudienceExport

Xuất đối tượng là danh sách người dùng thuộc một đối tượng tại thời điểm tạo danh sách. Một đối tượng có thể có nhiều tệp xuất đối tượng cho các ngày khác nhau.

Biểu diễn dưới dạng JSON
{
  "name": string,
  "audience": string,
  "audienceDisplayName": string,
  "dimensions": [
    {
      object (AudienceDimension)
    }
  ],
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "rowCount": integer,
  "errorMessage": string,
  "percentageCompleted": number
}
Trường
name

string

Chỉ có đầu ra. Giá trị nhận dạng. Tên tài nguyên xuất đối tượng được chỉ định trong quá trình tạo. Tên tài nguyên này xác định AudienceExport này.

Định dạng properties/{property}/audienceExports/{audienceExport}

audience

string

Bắt buộc. Tên tài nguyên cho đối tượng. Tên tài nguyên này xác định đối tượng đang được liệt kê và được chia sẻ giữa Dữ liệu Analytics và API Quản trị.

Định dạng properties/{property}/audiences/{audience}

audienceDisplayName

string

Chỉ có đầu ra. Tên hiển thị mang tính mô tả cho đối tượng này. Ví dụ: "Người mua".

dimensions[]

object (AudienceDimension)

Bắt buộc. Các phương diện được yêu cầu và xuất hiện trong phản hồi truy vấn.

creationQuotaTokensCharged

integer

Chỉ có đầu ra. Tổng mã thông báo hạn mức được tính trong quá trình tạo AudienceExport. Vì số lượng mã thông báo này dựa trên hoạt động từ trạng thái CREATING, nên mã thông báo bị tính phí này sẽ được cố định sau khi AudienceExport chuyển sang trạng thái ACTIVE hoặc FAILED.

state

enum (State)

Chỉ có đầu ra. Trạng thái hiện tại của AudienceExport này.

beginCreatingTime

string (Timestamp format)

Chỉ có đầu ra. Thời điểm audienceExports.create được gọi và AudienceExport bắt đầu trạng thái CREATING.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z".

rowCount

integer

Chỉ có đầu ra. Tổng số hàng trong kết quả AudienceExport.

errorMessage

string

Chỉ có đầu ra. Hệ thống sẽ điền thông báo lỗi khi không xuất được đối tượng trong quá trình tạo. Nguyên nhân phổ biến dẫn đến lỗi này là tình trạng hết hạn mức.

percentageCompleted

number

Chỉ có đầu ra. Tỷ lệ phần trăm hoàn tất cho việc xuất đối tượng này nằm trong khoảng từ 0 đến 100.

AudienceDimension

Phương diện đối tượng là một thuộc tính người dùng. Hệ thống sẽ yêu cầu người dùng cụ thể phân bổ giá trị đóng góp, sau đó được trả về trong QueryAudienceExportResponse.

Biểu diễn dưới dạng JSON
{
  "dimensionName": string
}
Trường
dimensionName

string

Không bắt buộc. Tên API của phương diện. Xem Phương diện API để biết danh sách tên phương diện.

Tiểu bang

AudienceExport hiện tồn tại ở trạng thái này.

Enum
STATE_UNSPECIFIED Trạng thái không xác định sẽ không bao giờ được sử dụng.
CREATING Đối tượng xuất hiện đang được tạo và sẽ có trong tương lai. Việc tạo sẽ diễn ra ngay sau lệnh gọi audienceExports.create.
ACTIVE AudienceExport đã được tạo hoàn chỉnh và sẵn sàng để truy vấn. AudienceExport được cập nhật thành hoạt động không đồng bộ từ một yêu cầu; quá trình này diễn ra trong khoảng thời gian nào đó (ví dụ: 15 phút) sau lệnh gọi tạo ban đầu.
FAILED Không tạo được AudienceExport. Có thể việc yêu cầu lại lệnh xuất đối tượng này sẽ thành công.

Phương thức

create

Tạo tệp xuất đối tượng để truy xuất sau.

get

Lấy siêu dữ liệu cấu hình về một tệp xuất đối tượng cụ thể.

list

Liệt kê tất cả dữ liệu xuất đối tượng của một tài sản.

query

Truy xuất dữ liệu xuất về đối tượng gồm những người dùng.