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 & 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 狀態的時間。

採用 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)

選用設定。設定 Webhook 通知從 Google Analytics (分析) Data API 傳送至 Webhook 伺服器。使用 Webhook 是選擇性的。如未使用這個 API，您就必須輪詢這個 API，判斷何時可以使用目標對象名單。Webhook 可讓系統將通知傳送到您的伺服器，讓您不必進行輪詢。

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

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

狀態

AudienceList 目前為這個狀態。

列舉
STATE_UNSPECIFIED 系統一律不會使用未指定的狀態。
CREATING 目標對象名單目前正在建立，將於日後提供。系統會在 AudienceLists.create 呼叫後立即建立。
ACTIVE AudienceList 建立完成，可供查詢。AudienceList 會在初次建立呼叫後，改為以非同步方式運作；這個情況會在初次建立呼叫後經過一段時間 (例如 15 分鐘)。
FAILED 無法建立 AudienceList。您重新要求這份目標對象名單或許會成功。

方法

create

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

exportSheet

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

get

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

list

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

query

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