REST Resource: properties.audienceLists

Tài nguyên: AudienceList

Danh sách đố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 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 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 Danh sách đối tượng. 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 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 Danh sách đối tượng 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 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" 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. Hệ thống sẽ điền thông báo lỗi khi danh sách đối tượng bị lỗi 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.
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 danh sách đối tượng được tạo trực tiếp, thì chúng sẽ không có danh sách đối tượng định kỳ liên kết và trường này sẽ được để trống.
webhookNotification

object (WebhookNotification)

Không bắt buộc. Định cấu hình thông báo webhook để gửi từ API Dữ liệu của Google Analytics đến máy chủ webhook. 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ò 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à để tránh việc thăm dò ý kiến.

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 để hiển thị danh sách đối tượng mới được 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 nhau được yêu cầu liên tiếp nhanh chóng, thì yêu cầu 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 pháp tạo danh sách đối tượng có thể trả về một danh sách đối tượng đã HOẠT ĐỘNG. Trong trường hợp này, chỉ một yêu cầu POST được gửi đến webhook.

Tiểu bang

Danh sách đối tượng 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 sử dụng.
CREATING Danh sách đối tượng hiện đang được tạo và sẽ được cung cấp trong tương lai. Việc tạo sẽ diễn ra ngay sau lệnh gọi audienceLists.create.
ACTIVE Danh sách đối tượng đã được tạo đầy đủ và sẵn sàng để truy vấn. AudienceList đượ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 thể tạo Danh sách đối tượng. Có thể việc 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 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 cơ sở lưu trú.

query

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