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

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如 "2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
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 已完成建立，可供查詢。系統會在初始建立呼叫後的一段時間 (例如 15 分鐘) 內，將 AudienceExport 異步更新為有效狀態。
FAILED 無法建立 AudienceExport。重新要求匯出目標對象可能會成功。

方法

create

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

get

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

list

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

query

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