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 資料與管理員 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 狀態的時間。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如 "2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
rowCount

integer

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

string

僅供輸出。建立目標對象清單時發生錯誤時，系統會顯示錯誤訊息。這類失敗的常見原因是配額用盡。
percentageCompleted

number

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

string

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

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

object (WebhookNotification)

選用設定。設定從 Google Analytics Data API 傳送至 webhook 伺服器的 webhook 通知。您可以選擇是否要使用 webhook。如果未使用，您必須輪詢此 API，判斷目標對象名單何時可供使用。Webhooks 可將通知傳送至伺服器，避免需要輪詢。

系統會將一或兩個 POST 要求傳送至 Webhook。系統會立即傳送第一個 POST 要求，顯示新建立的目標對象清單處於「CREATING」狀態。目標對象清單建立完成 (處於「有效」或「失敗」狀態) 後，系統會傳送第二個 POST 要求。

如果系統連續要求相同的目標對象名單，第二個及後續的目標對象名單就會從快取中放送。在這種情況下，目標對象名單建立方法可以傳回已啟用的目標對象名單。在這種情況下，系統只會將一個 POST 要求傳送至 Webhook。

州

AudienceList 目前處於這個狀態。

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

方法

create

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

exportSheet

 將使用者的目標對象名單匯出至 Google 試算表。

get

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

list

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

query

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