REST Resource: properties.audienceLists

{
  "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)
  }
}

string

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

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

string

必要欄位。目標對象資源名稱。這個名稱可用來識別列出的目標對象，且可在 Analytics 資料與Admin API

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

string

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

object (AudienceDimension)

必要欄位。要求的維度，會顯示在查詢回應中。

integer

僅供輸出。建立 AudienceList 時收取的配額權杖總數。這個權杖數量是依據 CREATING 狀態的活動計算，因此在目標對象名單進入 ACTIVE 或 FAILED 狀態後，這個計費權杖就會固定。

enum (State)

僅供輸出。這份目標對象名單的目前狀態。

string (Timestamp format)

僅供輸出。呼叫 audienceLists.create 且 AudienceList 開始處於 CREATING 狀態的時間。

RFC3339 世界標準時間「Zulu」的時間戳記格式，解析度為奈秒，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

integer

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

string

僅供輸出。目標對象名單建立期間若建立失敗，系統就會填入錯誤訊息。導致這類失敗的常見原因為配額耗盡。

number

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

string

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

如果是直接建立的目標對象名單，這些名單不會有相關的週期性目標對象名單，且這個欄位會留空。

object (WebhookNotification)

選用設定。設定 Webhook 通知，從 Google Analytics Data API 傳送至 Webhook 伺服器。但不一定要使用 Webhook。如果未使用，您必須輪詢這個 API，才能判斷目標對象名單的可用時機。Webhook 允許傳送通知到您的伺服器，就不必進行輪詢

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

如果要求快速連續請求相同的目標對象名單，則第二個和而後續的目標對象名單則可透過快取提供。在這種情況下，目標對象名單建立方法可以傳回已啟用的目標對象名單。在這個情境中，系統只會將一個 POST 要求傳送至這個 Webhook。