REST Resource: properties.audienceExports

資源：AudienceExport

目標對象匯出內容是目標對象名單建立時的使用者清單。一個目標對象可能有多個目標對象匯出作業，分別為不同日期建立。

JSON 表示法 
{
  "name": string,
  "audience": string,
  "audienceDisplayName": string,
  "dimensions": [
    {
      object (AudienceDimension)
    }
  ],
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "rowCount": integer,
  "errorMessage": string,
  "percentageCompleted": number
}
欄位
name

string

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

格式：properties/{property}/audienceExports/{audienceExport}
audience

string

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

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

string

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

object (AudienceDimension)

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

integer

僅供輸出。建立 AudienceExport 時收取的配額權杖總數。由於這個權杖計數是以 CREATING 狀態的活動為準，因此 AudienceExport 進入 ACTIVE 或 FAILED 狀態後，系統就會固定收取權杖費用。
state

enum (State)

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

string (Timestamp format)

僅供輸出。呼叫 audienceExports.create 的時間，以及 AudienceExport 開始進入 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

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

string

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

number

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

AudienceDimension

目標對象維度是使用者屬性，系統會要求提供特定使用者屬性，然後在 QueryAudienceExportResponse 中傳回。

JSON 表示法 
{
  "dimensionName": string
}
欄位
dimensionName

string

(選用步驟) 維度的 API 名稱。如需維度名稱清單，請參閱「API 維度」。

州

AudienceExport 目前處於這個狀態。

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

方法

create

 建立目標對象匯出作業，以便日後擷取。

get

 取得特定目標對象匯出作業的設定中繼資料。

list

 列出資源的所有目標對象匯出作業。

query

 擷取使用者的目標對象匯出資料。