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 狀態的活動計算，因此在目標對象匯出檔案進入 ACTIVE 或 FAILED 狀態後，這個計費權杖就會固定。
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 無法建立目標對象匯出。重新要求這項目標對象匯出作業可能會成功。

方法

create

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

get

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

list

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

query

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