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 nhiều ngày.

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. Số nhận dạng. Tên tài nguyên của tệp 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 của đố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 bị 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ố 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.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".

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 sẵn khi tệp xuất đối tượng không tạo được. Một lý do phổ biến dẫn đến lỗi như vậy là do đã dùng hết hạn mức.

percentageCompleted

number

Chỉ có đầu ra. Tỷ lệ hoàn thành cho tệp xuất đối tượng này, từ 0 đến 100.

AudienceDimension

Phương diện đối tượng là thuộc tính người dùng. Các thuộc tính cụ thể của người dùng được yêu cầu và 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. Hãy xem Phương diện API để biết danh sách tên phương diện.

Trạng thái

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

Phương thức

create

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

get

Nhận 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.