REST Resource: properties.audiences

資源：Audience

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

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

string

僅供輸出。這項 Audience 資源的資源名稱。格式：properties/{propertyId}/audiences/{audienceId}
displayName

string

必要欄位。目標對象的顯示名稱。
description

string

必要欄位。目標對象的說明。
membershipDurationDays

integer

必要欄位。不可變動。使用者留在目標對像中的時間長度。不得設為超過 540 天。
adsPersonalizationEnabled

boolean

僅供輸出。如果是非個人化廣告目標對象，Google Analytics 會自動將這個欄位設為 False，且不會用於廣告個人化。
eventTrigger

object (AudienceEventTrigger)

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

enum (AudienceExclusionDurationMode)

不可變動。指定排除條件的有效期限，適用於符合排除篩選器的使用者。這個規則會套用至所有 EXCLUDE 篩選器子句，而且如果目標對像中沒有「EXCLUDE」篩選器子句，系統就會忽略這個規則。
filterClauses[]

object (AudienceFilterClause)

必要欄位。不可變動。未排序的清單。用於定義 Audience 的篩選器子句。所有子句會以 AND 結合在一起。
createTime

string (Timestamp format)

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

RFC3339 世界標準時間「Zulu」的時間戳記格式，解析度不超過奈秒，最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

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 結合的運算式清單。只能包含帶有 orGroup 的 AudienceFilterExpressions。必須在頂層 AudienceFilterExpression 中設定。
orGroup

object (AudienceFilterExpressionList)

要以 OR 結合的運算式清單。不能包含帶有 andGroup 或 orGroup 的 AudienceFilterExpression。
notExpression

object (AudienceFilterExpression)

排除的篩選運算式 (例如反轉、互補)。其中只能包含維度 OrMetricFilter。無法在頂層 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 (例如不支援巢狀事件篩選器)。應為維度 OrMetricFilter 的單一和群組，或 notExpression；系統不支援 OR 運算子。此外，如果其中包含「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，則滿足此步驟的事件必須是在符合最後一個步驟的事件之後的下一個事件。如果未設定或否，系統會間接遵循前一個步驟；例如先前步驟和這個步驟之間的事件。在第一個步驟中，系統會忽略這個屬性。
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

 可更新資源的目標對象。