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 (分析) 資料和 Admin API 之間共用。

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

audienceDisplayName

string

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

dimensions[]

object (AudienceDimension)

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

creationQuotaTokensCharged

integer

僅供輸出。建立 AudienceExport 時收取的配額權杖總數。這個權杖數量是根據 CREATING 狀態的活動計算,因此在 AudienceExport 進入 ACTIVEFAILED 狀態後,將會修正這個權杖的費用。

state

enum (State)

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

beginCreatingTime

string (Timestamp format)

僅供輸出。呼叫 AudienceExports.create 且 AudienceExport 開始 CREATING 狀態的時間。

RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度,且最多 9 個小數位數。範例:"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 已建立完成,可供查詢。來自要求的 AudienceExport 已更新為非同步啟用,這項作業會在初次建立呼叫後的一段時間 (例如 15 分鐘) 發生。
FAILED 無法建立 AudienceExport。重新要求這項目標對象匯出作業可能會成功。

方法

create

建立目標對象匯出項目,供日後擷取。

get

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

list

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

query

擷取使用者目標對象匯出項目。