REST Resource: properties.audiences

資源：Audience

代表目標對象的資源訊息。

JSON 表示法 
{
  "name": string,
  "displayName": string,
  "description": string,
  "membershipDurationDays": integer,
  "adsPersonalizationEnabled": boolean,
  "eventTrigger": {
    object (AudienceEventTrigger)
  },
  "exclusionDurationMode": enum (AudienceExclusionDurationMode),
  "filterClauses": [
    {
      object (AudienceFilterClause)
    }
  ],
  "createTime": string
}
欄位
name

string

僅供輸出。這個目標對象資源的資源名稱。格式：properties/{propertyId}/audiences/{audienceId}
displayName

string

必填。目標對象的顯示名稱。
description

string

必填。目標對象的說明。
membershipDurationDays

integer

必填。不可變動。使用者應留在目標對象中的時間長度。最多只能設為 540 天。
adsPersonalizationEnabled

boolean

僅供輸出。如果這是非個人化廣告目標對象，且已從廣告個人化中排除，Google Analytics 就會自動將這項屬性設為 false。
eventTrigger

object (AudienceEventTrigger)

(選用步驟) 指定使用者加入目標對象時要記錄的事件。如果未設定，使用者加入目標對象時，系統不會記錄任何事件。
exclusionDurationMode

enum (AudienceExclusionDurationMode)

不可變動。指定符合排除篩選條件的使用者排除時間長度。這項設定會套用至所有「排除」篩選條件子句，如果目標對象中沒有「排除」篩選條件子句，系統就會忽略這項設定。
filterClauses[]

object (AudienceFilterClause)

必填。不可變動。未排序的清單。篩選定義目標對象的子句。所有子句都會以 AND 連結。
createTime

string (Timestamp format)

僅供輸出。目標對象的建立時間。

使用 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"。

AudienceEventTrigger

指定使用者加入目標對象時要記錄的事件。

JSON 表示法 
{
  "eventName": string,
  "logCondition": enum (LogCondition)
}
欄位
eventName

string

必填。系統記錄的事件名稱。
logCondition

enum (LogCondition)

必填。記錄事件的時間。

LogCondition

決定何時記錄事件。

列舉
LOG_CONDITION_UNSPECIFIED 未指定記錄條件。
AUDIENCE_JOINED 只有在使用者加入時，才應記錄事件。
AUDIENCE_MEMBERSHIP_RENEWED 只要符合目標對象條件，系統就應記錄事件，即使使用者已是目標對象成員也一樣。

AudienceExclusionDurationMode

指定符合排除篩選條件的使用者排除時間長度。

列舉
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED 不指定。
EXCLUDE_TEMPORARILY 在使用者符合篩選條件子句的期間，將他們從目標對象中排除。
EXCLUDE_PERMANENTLY 如果使用者曾符合篩選條件子句，則將他們從目標對象中排除。

AudienceFilterClause

用來定義簡單或序列篩選器的子句。篩選器可以是包含性 (例如，符合篩選器子句的使用者會納入目標對象)，也可以是排除性 (例如，符合篩選器子句的使用者會從目標對象中排除)。

JSON 表示法 
{
  "clauseType": enum (AudienceClauseType),

  // Union field filter can be only one of the following:
  "simpleFilter": {
    object (AudienceSimpleFilter)
  },
  "sequenceFilter": {
    object (AudienceSequenceFilter)
  }
  // End of list of possible types for union field filter.
}
欄位
clauseType

enum (AudienceClauseType)

必填。指定這是包含或排除篩選條件子句。

聯集欄位 filter。

filter 只能是下列其中一項：
simpleFilter

object (AudienceSimpleFilter)

使用者必須符合的簡單篩選條件，才能成為目標對象成員。
sequenceFilter

object (AudienceSequenceFilter)

使用者必須符合特定順序的篩選條件，才能成為目標對象的成員。

AudienceSimpleFilter

定義使用者必須滿足的簡單篩選條件，才能成為目標對象的成員。

JSON 表示法 
{
  "scope": enum (AudienceFilterScope),
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
欄位
scope

enum (AudienceFilterScope)

必填。不可變動。指定這個篩選器的範圍。
filterExpression

object (AudienceFilterExpression)

必填。不可變動。目標對象維度、指標或事件篩選條件的邏輯運算式。

AudienceFilterScope

指定評估使用者是否符合加入目標對象資格的方式。

列舉
AUDIENCE_FILTER_SCOPE_UNSPECIFIED 未指定範圍。
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT 如果使用者在一個事件中符合篩選條件，系統就會將他們納入目標對象。
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION 如果使用者在一個工作階段內符合篩選條件，就會加入目標對象。
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS 只要任何工作階段中的任何事件符合篩選條件，使用者就會加入目標對象。

AudienceFilterExpression

目標對象維度、指標或事件篩選條件的邏輯運算式。

JSON 表示法 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (AudienceFilterExpressionList)
  },
  "orGroup": {
    object (AudienceFilterExpressionList)
  },
  "notExpression": {
    object (AudienceFilterExpression)
  },
  "dimensionOrMetricFilter": {
    object (AudienceDimensionOrMetricFilter)
  },
  "eventFilter": {
    object (AudienceEventFilter)
  }
  // End of list of possible types for union field expr.
}
欄位
聯集欄位 expr。套用至篩選器的運算式。expr 只能是下列其中一項：
andGroup

object (AudienceFilterExpressionList)

要以 AND 運算符合併的運算式清單。只能包含具有或群組的 AudienceFilterExpressions。頂層 AudienceFilterExpression 必須設定此值。
orGroup

object (AudienceFilterExpressionList)

要以 OR 運算子合併的運算式清單。不得包含具有 andGroup 或 orGroup 的 AudienceFilterExpressions。
notExpression

object (AudienceFilterExpression)

要 NOT 運算的篩選運算式 (例如反轉、補足)。只能包含 dimensionOrMetricFilter。這項設定無法在頂層 AudienceFilterExpression 中設定。
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

單一維度或指標的篩選條件。這項設定無法在頂層 AudienceFilterExpression 中設定。
eventFilter

object (AudienceEventFilter)

建立符合特定事件的篩選條件。這項設定無法在頂層 AudienceFilterExpression 中設定。

AudienceFilterExpressionList

目標對象篩選運算式清單。

JSON 表示法 
{
  "filterExpressions": [
    {
      object (AudienceFilterExpression)
    }
  ]
}
欄位
filterExpressions[]

object (AudienceFilterExpression)

目標對象篩選運算式清單。

AudienceDimensionOrMetricFilter

單一維度或指標的特定篩選器。

JSON 表示法 
{
  "fieldName": string,
  "atAnyPointInTime": boolean,
  "inAnyNDayPeriod": integer,

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
欄位
fieldName

string

必填。不可變動。要篩選的維度名稱或指標名稱。如果欄位名稱是指自訂維度或指標，系統會在自訂維度或指標名稱前方加上範圍前置字元。如要進一步瞭解範圍前置字元或自訂維度/指標，請參閱 Google Analytics Data API 說明文件。
atAnyPointInTime

boolean

(選用步驟) 指出這個篩選器是否需要動態評估。如果設為 true，只要使用者曾經符合條件，就會加入目標對象 (靜態評估)。如果未設定或設為 false，系統會採用動態的評估方式，目標對象符合條件時就加進名單，不符條件時則移除。

只有在「目標對象範圍」為「ACROSS_ALL_SESSIONS」時，才能設定這個值。
inAnyNDayPeriod

integer

(選用步驟) 如果已設定，請指定評估資料的時間範圍 (以天為單位)。如未設定，系統會根據生命週期資料評估目標對象資料 (例如無限時間範圍)。

舉例來說，如果設為 1 天，系統只會評估當天的資料。如果 atAnyPointInTime 未設定或為 false，參考點就是當天。

只有在目標對象範圍為 ACROSS_ALL_SESSIONS 時才能設定，且不得超過 60 天。
聯集欄位 one_filter。上述任一篩選器。one_filter 只能是下列其中一項：
stringFilter

object (StringFilter)

字串類型維度的篩選器，符合特定模式。
inListFilter

object (InListFilter)

字串維度的篩選器，符合特定選項清單。
numericFilter

object (NumericFilter)

針對維度或指標的數值或日期值套用的篩選條件。
betweenFilter

object (BetweenFilter)

篩選維度或指標上介於特定值之間的數值或日期值。

StringFilter

字串類型維度的篩選器，符合特定模式。

JSON 表示法 
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
欄位
matchType

enum (MatchType)

必填。字串篩選器的比對類型。
value

string

必填。要比對的字串值。
caseSensitive

boolean

(選用步驟) 如果是 true，比對時會區分大小寫。如果設為 False，比對時不區分大小寫。

MatchType

字串篩選器的比對類型。

列舉
MATCH_TYPE_UNSPECIFIED 未指定
EXACT 字串值完全相符。
BEGINS_WITH 以字串值開頭。
ENDS_WITH 結尾為字串值。
CONTAINS 包含字串值。
FULL_REGEXP 完整規則運算式與字串值相符。

InListFilter

字串維度的篩選器，符合特定選項清單。

JSON 表示法 
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
欄位
values[]

string

必填。要比對的可能字串值清單。不得為空白。
caseSensitive

boolean

(選用步驟) 如果是 true，比對時會區分大小寫。如果設為 False，比對時不區分大小寫。

NumericFilter

針對維度或指標的數值或日期值套用的篩選條件。

JSON 表示法 
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
欄位
operation

enum (Operation)

必填。套用至數字篩選器的運算。
value

object (NumericValue)

必填。要比對的數值或日期值。

作業

套用至數字篩選器的運算。

列舉
OPERATION_UNSPECIFIED 未指明
EQUAL 相等。
LESS_THAN 小於。
GREATER_THAN 大於。

NumericValue

代表數字。

JSON 表示法 
{

  // Union field one_value can be only one of the following:
  "int64Value": string,
  "doubleValue": number
  // End of list of possible types for union field one_value.
}
欄位
聯集欄位 one_value。數值。one_value 只能是下列其中一項：
int64Value

string (int64 format)

整數值。
doubleValue

number

雙重值。

BetweenFilter

篩選維度或指標上介於特定值之間的數值或日期值。

JSON 表示法 
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
欄位
fromValue

object (NumericValue)

必填。起始數字 (包含在內)。
toValue

object (NumericValue)

必填。結尾為這個數字 (含)。

AudienceEventFilter

篩選器會比對單一事件名稱的事件。如果指定事件參數，只有符合單一事件名稱和參數篩選器運算式的事件子集，才會符合這個事件篩選器。

JSON 表示法 
{
  "eventName": string,
  "eventParameterFilterExpression": {
    object (AudienceFilterExpression)
  }
}
欄位
eventName

string

必填。不可變動。要比對的事件名稱。
eventParameterFilterExpression

object (AudienceFilterExpression)

(選用步驟) 如果指定了這項篩選器，系統會比對符合單一事件名稱和參數篩選器運算式的事件。無法在參數篩選運算式中設定 AudienceEventFilter (例如，不支援巢狀事件篩選器)。這應該是單一 andGroup 的 dimensionOrMetricFilter 或 notExpression；系統不支援 OR 的 AND。此外，如果包含「eventCount」的篩選器，系統只會考量該篩選器，並忽略所有其他篩選器。

AudienceSequenceFilter

定義篩選條件，使用者必須依特定順序符合這些條件，才能成為目標對象的成員。

JSON 表示法 
{
  "scope": enum (AudienceFilterScope),
  "sequenceMaximumDuration": string,
  "sequenceSteps": [
    {
      object (AudienceSequenceStep)
    }
  ]
}
欄位
scope

enum (AudienceFilterScope)

必填。不可變動。指定這個篩選器的範圍。
sequenceMaximumDuration

string (Duration format)

(選用步驟) 定義整個序列必須發生在哪個時間範圍內。

時間長度以秒為單位，最多可有 9 個小數位數，並應以「s」結尾，例如："3.5s"。
sequenceSteps[]

object (AudienceSequenceStep)

必填。一系列有順序的步驟。使用者必須完成每個步驟，才能加入序列篩選條件。

AudienceSequenceStep

使用者必須符合的條件，且須按照指定步驟順序發生，才能符合序列。

JSON 表示法 
{
  "scope": enum (AudienceFilterScope),
  "immediatelyFollows": boolean,
  "constraintDuration": string,
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
欄位
scope

enum (AudienceFilterScope)

必填。不可變動。指定這個步驟的範圍。
immediatelyFollows

boolean

(選用步驟) 如果為 true，滿足這個步驟的事件必須是滿足上一個步驟的事件之後的下一個事件。如果未設定或設為 false，這個步驟會間接接續前一個步驟；舉例來說，前一個步驟和這個步驟之間可能會有事件。第一步會忽略這項設定。
constraintDuration

string (Duration format)

(選用步驟) 設定後，這個步驟必須在先前步驟的 constraintDuration 內完成 (例如 t[i] - t[i-1] <= constraintDuration)。如未設定，則沒有時間長度限制 (時間長度實際上不受限制)。第一步會忽略這項設定。

時間長度以秒為單位，最多可有 9 個小數位數，並應以「s」結尾，例如："3.5s"。
filterExpression

object (AudienceFilterExpression)

必填。不可變動。每個步驟中目標對象維度、指標或事件篩選條件的邏輯運算式。

AudienceClauseType

指定這是包含或排除篩選條件子句。

列舉
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED 未指定子句類型。
INCLUDE 只要符合篩選子句，使用者就會納入目標對象。
EXCLUDE 如果符合篩選器子句，系統就會將使用者排除在目標對象之外。

方法

archive

 封存資源中的目標對象。

create

 建立目標對象。

get

 查詢單一目標對象。

list

 列出資源中的目標對象。

patch

 更新資源中的目標對象。