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 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,
  "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 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 đố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 AudienceList. 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 số lượng mã thông báo đã tính phí này sẽ được cố định sau khi 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 audienceLists.create được gọi 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ẽ được điền khi không tạo được danh sách đối tượng. 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.
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 bạn tạo danh sách đối tượng trực tiếp, thì các danh sách đó sẽ không có danh sách đối tượng định kỳ đượ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ừ API Dữ liệu Google Analytics đế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 thăm dò ý kiến API này để xác định thời điểm một danh sách đối tượng sẵn sàng để sử dụng. Webhook cho phép gửi thông báo đến máy chủ của bạn và không cần thăm dò ý kiến.

Hệ thống sẽ gửi một hoặc hai yêu cầu POST đế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 các danh sách đối tượng giống hệt nhau được yêu cầu liên tiếp, thì danh sách đối tượng thứ hai và các danh sách 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 đã CÓ HIỆU LỰC. Trong trường hợp này, hệ thống sẽ chỉ gửi một yêu cầu POST đến webhook.

Tiểu bang

AudienceList 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 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 để 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 AudienceList. Bạn có thể yêu cầu lại danh sách đối tượng này và yêu cầu sẽ thành công.

Phương thức

create

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

exportSheet

 Xuất danh sách đối tượng gồm những người dùng sang Google Trang tính.

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 gồm những người dùng.