REST Resource: properties.audienceExports

Tài nguyên: AudienceExport

Tệp xuất đối tượng là danh sách người dùng trong 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 được tạo 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 đố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 API Quản trị và API Dữ liệu Analytics.

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

audienceDisplayName

string

Chỉ có đầu ra. Tên hiển thị 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à hiển thị trong phản hồi truy vấn.

creationQuotaTokensCharged

integer

Chỉ có đầu ra. Tổng số mã thông báo hạn mức được tính phí 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 ở trạng thái CREATING, nên số lượng mã thông báo đã 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 gọi audienceExports.create và AudienceExport bắt đầu trạng thái CREATING.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, có độ phân giải nano giây và tối đa 9 chữ số thập phân. 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. Thông báo lỗi sẽ được điền khi không xuất được đối tượng trong quá trình tạo. Một lý do phổ biến dẫn đến lỗi này là do hết hạn mức.

percentageCompleted

number

Chỉ có đầu ra. Tỷ lệ phần trăm đã hoàn tất cho lượt 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 và sau đó trả về thuộc tính người dùng cụ thể 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 AudienceExport hiện đang tạo và sẽ có trong tương lai. Quá trình tạo diễn ra ngay sau lệnh gọi audienceExports.create.
ACTIVE AudienceExport đã được tạo đầy đủ và sẵn sàng để truy vấn. AudienceExport được cập nhật để hoạt động không đồng bộ từ một yêu cầu; việc này xảy ra sau một khoảng thời gian (ví dụ: 15 phút) kể từ lệnh gọi tạo ban đầu.
FAILED Không tạo được AudienceExport. Có thể bạn sẽ thành công khi yêu cầu xuất đối tượng này lại.

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ả tệp xuất đối tượng cho một tài sản.

query

Truy xuất tệp xuất đối tượng của người dùng.