REST Resource: properties.audienceLists

資源：AudienceList

目標對象名單是名單建立時目標對象中的使用者清單。一個目標對象可能有多個為不同日期建立的目標對象名單。

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)
  }
}
欄位
name

string

僅供輸出。ID。建立時指派的目標對象名單資源名稱。這個資源名稱會識別這個 AudienceList。

格式：properties/{property}/audienceLists/{audienceList}
audience

string

必填。目標對象資源名稱。這個資源名稱會識別列出的目標對象，並在 Analytics Data API 和 Admin API 之間共用。

格式：properties/{property}/audiences/{audience}
audienceDisplayName

string

僅供輸出。這個目標對象的描述性顯示名稱。例如「購買者」。
dimensions[]

object (AudienceDimension)

必填。查詢回應中要求和顯示的維度。
creationQuotaTokensCharged

integer

僅供輸出。建立 AudienceList 時收取的配額權杖總數。由於權杖數量是根據 CREATING 狀態的活動計算，因此 AudienceList 進入 ACTIVE 或 FAILED 狀態後，系統就會固定收取的權杖數量。
state

enum (State)

僅供輸出。這個 AudienceList 的目前狀態。
beginCreatingTime

string (Timestamp format)

僅供輸出。呼叫 audienceLists.create 的時間，以及 AudienceList 開始進入 CREATING 狀態的時間。

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
rowCount

integer

僅供輸出。AudienceList 結果中的總列數。
errorMessage

string

僅供輸出。如果目標對象名單在建立期間失敗，系統會填入錯誤訊息。這類失敗的常見原因是配額用盡。
percentageCompleted

number

僅供輸出。這個目標對象匯出作業的完成百分比，範圍介於 0 到 100 之間。
recurringAudienceList

string

僅供輸出。建立這個目標對象名單的週期性目標對象名單。週期性目標對象名單會每天建立目標對象名單。

如果直接建立目標對象名單，這類名單就不會有相關聯的週期性目標對象名單，這個欄位也會空白。
webhookNotification

object (WebhookNotification)

(選用步驟) 設定要從 Google Analytics Data API 傳送至 Webhook 伺服器的 Webhook 通知。Webhook 為選用功能。如果未使用，您需要輪詢這個 API，判斷目標對象名單何時可供使用。Webhook 可將通知傳送至伺服器，避免輪詢。

系統會向 Webhook 傳送一或兩項 POST 要求。系統會立即傳送第一個 POST 要求，顯示處於「建立中」狀態的新建目標對象名單。目標對象名單建立完成後 (無論是 ACTIVE 或 FAILED 狀態)，系統就會傳送第二個 POST 要求。

如果連續要求相同的目標對象名單，系統可以從快取提供第二個和後續的目標對象名單。在這種情況下，目標對象名單建立方法可能會傳回目標對象名單已為「有效」狀態。在這種情況下，系統只會將一個 POST 要求傳送至 Webhook。

州

AudienceList 目前處於這個狀態。

列舉
STATE_UNSPECIFIED 系統絕不會使用未指定狀態。
CREATING 系統目前正在建立 AudienceList，日後會開放使用。建立作業會在 audienceLists.create 呼叫後立即執行。
ACTIVE AudienceList 已完全建立，隨時可供查詢。系統會從要求非同步更新 AudienceList 為有效狀態；這會在初始建立呼叫後一段時間 (例如 15 分鐘) 發生。
FAILED 無法建立目標對象名單。重新要求這個目標對象名單可能會成功。

方法

create

 建立目標對象名單，供日後擷取。

get

 取得特定目標對象名單的設定中繼資料。

list

 列出資源的所有目標對象名單。

query

 擷取使用者目標對象名單。