REST Resource: properties.audienceLists

Tài nguyên: AudienceList

Danh sách đố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 danh sách đố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,
  "recurringAudienceList": string,
  "webhookNotification": {
    object (WebhookNotification)
  }
}
Trường
name

string

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

Định dạng properties/{property}/audienceLists/{audienceList}
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 của Analytics.

Đị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à 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 trong quá trình tạo AudienceList. 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 được tính phí sẽ cố định khi một AudienceList 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 AudienceList này.
beginCreatingTime

string (Timestamp format)

Chỉ có đầu ra. Thời điểm gọi audienceLists.create và AudienceList 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" và "2014-10-02T15:01:23.045123456Z".
rowCount

integer

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

string

Chỉ có đầu ra. Thông báo lỗi sẽ xuất hiện khi danh sách đối tượng không tạo được. Một lý do phổ biến dẫn đến lỗi này là do bạn đã dùng hết hạn mức.
percentageCompleted

number

Chỉ có đầu ra. Tỷ lệ phần trăm hoàn thành của quá trình xuất đối tượng này, trong khoảng từ 0 đến 100.
recurringAudienceList

string

Chỉ có đầu ra. Danh sách đối tượng định kỳ đã tạo danh sách đối tượng này. Danh sách đối tượng định kỳ tạo danh sách đối tượng hằng ngày.

Nếu được tạo trực tiếp, danh sách đối tượng sẽ không có danh sách đối tượng định kỳ nào được liên kết và trường này sẽ trống.
webhookNotification

object (WebhookNotification)

Không bắt buộc. Định cấu hình thông báo webhook được gửi từ Google Analytics Data API đến máy chủ webhook của bạn. Bạn không bắt buộc phải sử dụng webhook. Nếu không sử dụng, bạn sẽ cần phải thăm dò API này để xác định thời điểm có thể sử dụng danh sách đối tượng. Webhook cho phép gửi thông báo đến các máy chủ của bạn và tránh nhu cầu thăm dò.

Một hoặc hai yêu cầu POST sẽ được gửi đến webhook. Yêu cầu POST đầu tiên sẽ được gửi ngay lập tức, cho thấy danh sách đối tượng mới tạo ở trạng thái ĐANG TẠO. Yêu cầu POST thứ hai sẽ được gửi sau khi danh sách đối tượng hoàn tất quá trình tạo (trạng thái ACTIVE hoặc FAILED).

Nếu bạn yêu cầu các danh sách đối tượng giống hệt nhau trong thời gian ngắn, thì danh sách đối tượng thứ hai và các danh sách đối tượng tiếp theo có thể được phân phát từ bộ nhớ đệm. Trong trường hợp đó, phương thức tạo danh sách đối tượng có thể trả về một danh sách đối tượng đã ở trạng thái ĐANG HOẠT ĐỘNG. Trong trường hợp này, chỉ một yêu cầu POST sẽ được gửi đến webhook.

Tiểu bang

AudienceList hiện đang ở trạng thái này.

Enum
STATE_UNSPECIFIED Trạng thái không xác định sẽ không bao giờ được dùng.
CREATING AudienceList hiện đang được tạo và sẽ có trong tương lai. Quá trình tạo diễn ra ngay sau lệnh gọi audienceLists.create.
ACTIVE AudienceList đã được tạo đầy đủ và sẵn sàng để truy vấn. AudienceList được cập nhật thành trạng thái hoạt động không đồng bộ từ một yêu cầu; điều này xảy ra sau 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 AudienceList. Có thể yêu cầu lại danh sách đối tượng này sẽ thành công.

Phương thức

create

 Tạo một danh sách đối tượng để truy xuất sau này.

get

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

list

 Liệt kê tất cả danh sách đối tượng cho một tài sản.

query

 Truy xuất danh sách đối tượng người dùng.