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

採用 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 目前正在建立，將於日後推出。系統會在目標對象 Exports.create 呼叫後立即建立。
ACTIVE AudienceExport 已建立完成，您隨時可以開始查詢。AudienceExport 會更新為非同步啟用，在要求初始建立呼叫後，過了一段時間 (例如 15 分鐘) 才啟用。
FAILED 無法建立 AudienceExport。您有可能重新要求這項目標對象匯出作業。

方法

create

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

get

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

list

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

query

 擷取使用者匯出的使用者資料。