- 資源:目標對象
- AudienceEventTrigger
- LogCondition
- AudienceExclusionDurationMode
- AudienceFilterClause
- AudienceSimpleFilter
- AudienceFilterScope
- AudienceFilterExpression
- AudienceFilterExpressionList
- AudienceDimensionOrMetricFilter
- StringFilter
- MatchType
- InListFilter
- NumericFilter
- 作業
- NumericValue
- BetweenFilter
- AudienceEventFilter
- AudienceSequenceFilter
- AudienceSequenceStep
- AudienceClauseType
- 方法
資源:Audience
代表 GA4 目標對象的資源訊息。
JSON 表示法 |
---|
{ "name": string, "displayName": string, "description": string, "membershipDurationDays": integer, "adsPersonalizationEnabled": boolean, "eventTrigger": { object ( |
欄位 | |
---|---|
name |
僅供輸出。這項 Audience 資源的資源名稱。格式:properties/{propertyId}/audiences/{audienceId} |
displayName |
必要欄位。目標對象的顯示名稱。 |
description |
必要欄位。目標對象的說明。 |
membershipDurationDays |
必要欄位。不可變動。使用者留在目標對像中的時間長度。不得設為超過 540 天。 |
adsPersonalizationEnabled |
僅供輸出。對於非個人化廣告目標對象,Google Analytics (分析) 會自動將其設為 false,且不再用於廣告個人化。 |
eventTrigger |
選用設定。指定使用者加入目標對象時要記錄的事件。如未設定,當使用者加入目標對象時,系統就不會記錄任何事件。 |
exclusionDurationMode |
不可變動。針對符合排除篩選器的使用者,指定排除項目的效期。會套用至所有 EXCLUDE 篩選器子句,且如果「目標對象」中沒有 EXCLUDE 篩選器子句,系統就會忽略這個值。 |
filterClauses[] |
必要欄位。不可變動。未排序的清單。定義「目標對象」的篩選器子句。所有子句都會以 AND 結合在一起。 |
AudienceEventTrigger
指定使用者加入目標對象時要記錄的事件。
JSON 表示法 |
---|
{
"eventName": string,
"logCondition": enum ( |
欄位 | |
---|---|
eventName |
必要欄位。要記錄的事件名稱。 |
logCondition |
必要欄位。記錄事件的時機。 |
LogCondition
決定記錄事件的時機。
列舉 | |
---|---|
LOG_CONDITION_UNSPECIFIED |
未指定記錄條件。 |
AUDIENCE_JOINED |
只有在使用者加入時,才應記錄事件。 |
AUDIENCE_MEMBERSHIP_RENEWED |
每次符合目標對象條件時,就算使用者已是目標對象成員,系統仍應記錄這個事件。 |
AudienceExclusionDurationMode
針對符合排除篩選器的使用者,指定排除項目的效期。
列舉 | |
---|---|
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED |
未指定。 |
EXCLUDE_TEMPORARILY |
在特定期間,只要使用者符合篩選器子句,就將他們從目標對像中排除。 |
EXCLUDE_PERMANENTLY |
將曾符合篩選器子句的使用者從目標對像中排除。 |
AudienceFilterClause
用於定義簡易篩選器或序列篩選器的子句。篩選器可以包含 (例如將符合篩選器子句的使用者納入目標對象) 或排除 (例如將符合篩選器子句的使用者從目標對像中排除)。
JSON 表示法 |
---|
{ "clauseType": enum ( |
欄位 | |
---|---|
clauseType |
必要欄位。指定這是包含或排除篩選器子句。 |
聯集欄位
|
|
simpleFilter |
使用者只要符合這個簡單的篩選器,就能成為目標對象的成員。 |
sequenceFilter |
使用者必須按照特定順序建立篩選器,才能成為目標對象成員。 |
AudienceSimpleFilter
定義一個簡單的篩選器,使用者必須符合條件才能成為目標對象的成員。
JSON 表示法 |
---|
{ "scope": enum ( |
欄位 | |
---|---|
scope |
必要欄位。不可變動。指定這個篩選器的範圍。 |
filterExpression |
必要欄位。不可變動。目標對象維度、指標或事件篩選器的邏輯運算式。 |
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 。套用至篩選器的運算式。expr 只能是下列其中一項: |
|
andGroup |
要結合 AND 的運算式清單。當中只能包含 AudienceFilterExpressions 和 orGroup。您必須針對頂層 AudienceFilterExpression 設定這個屬性。 |
orGroup |
要結合 OR 的運算式清單。當中不可包含有 andGroup 或 orGroup 的 AudienceFilterExpressions。 |
notExpression |
要「NOT」的篩選運算式 (例如反轉、互補)。其中只能包含維度 OrMetricFilter。無法在頂層 AudienceFilterExpression 上設定此屬性。 |
dimensionOrMetricFilter |
單一維度或指標的篩選器。無法在頂層 AudienceFilterExpression 上設定此屬性。 |
eventFilter |
建立與特定事件相符的篩選器。無法在頂層 AudienceFilterExpression 上設定此屬性。 |
AudienceFilterExpressionList
目標對象篩選運算式清單。
JSON 表示法 |
---|
{
"filterExpressions": [
{
object ( |
欄位 | |
---|---|
filterExpressions[] |
目標對象篩選運算式清單。 |
AudienceDimensionOrMetricFilter
單一維度或指標的專用篩選器。
JSON 表示法 |
---|
{ "fieldName": string, "atAnyPointInTime": boolean, "inAnyNDayPeriod": integer, // Union field |
欄位 | |
---|---|
fieldName |
必要欄位。不可變動。要篩選的維度名稱或指標名稱。如果欄位名稱參照自訂維度或指標,系統會在自訂維度或指標名稱的前方加上範圍前置字元。如要進一步瞭解範圍前置字元或自訂維度/指標,請參閱 Google Analytics Data API 說明文件。 |
atAnyPointInTime |
選用設定。指出這個篩選器是否需要動態評估。如果設為 True,使用者只要滿足條件就會加入目標對象 (靜態評估)。如未設定或設為 False,目標對象評估功能會動態調整,符合條件的使用者加入後,不再符合使用者時移除。 只有在目標對象範圍為 ACROSS_ALL_SESSIONS 時,才能設定這項設定。 |
inAnyNDayPeriod |
選用設定。設定後,可指定用於評估資料 (以天數為單位) 的時間範圍。如未設定,系統會根據生命週期資料 (例如無限時間範圍) 評估目標對象資料。 例如,如果設為 1 天,系統只會評估當天的資料。參照點是指未設定 atAnyPointInTime 或設為 false 的當天日期。 只有在目標對象範圍為 ACROSS_ALL_SESSIONS 時,才能設定鍵/值,而且不能超過 60 天。 |
聯集欄位 one_filter 。以上其中一個篩選器。one_filter 只能是下列其中一項: |
|
stringFilter |
篩選符合特定模式的字串類型維度。 |
inListFilter |
符合特定選項清單的字串維度篩選器。 |
numericFilter |
用來篩選維度或指標數值或日期值的篩選器。 |
betweenFilter |
用來篩選維度或指標中特定值之間的數值或日期值。 |
StringFilter
篩選符合特定模式的字串類型維度。
JSON 表示法 |
---|
{
"matchType": enum ( |
欄位 | |
---|---|
matchType |
必要欄位。字串篩選器的比對類型。 |
value |
必要欄位。要比對的字串值。 |
caseSensitive |
選用設定。如果為 true,則比對會區分大小寫。如果設為 False,比對時不區分大小寫。 |
MatchType
字串篩選器的比對類型。
列舉 | |
---|---|
MATCH_TYPE_UNSPECIFIED |
未指定 |
EXACT |
完全符合字串值。 |
BEGINS_WITH |
以字串值開頭。 |
ENDS_WITH |
以字串值結尾。 |
CONTAINS |
包含字串值。 |
FULL_REGEXP |
完整的規則運算式與字串值相符。 |
InListFilter
符合特定選項清單的字串維度篩選器。
JSON 表示法 |
---|
{ "values": [ string ], "caseSensitive": boolean } |
欄位 | |
---|---|
values[] |
必要欄位。要比對的可能字串值清單。不得空白。 |
caseSensitive |
選用設定。如果為 true,則比對會區分大小寫。如果設為 False,比對時不區分大小寫。 |
NumericFilter
用來篩選維度或指標數值或日期值的篩選器。
JSON 表示法 |
---|
{ "operation": enum ( |
欄位 | |
---|---|
operation |
必要欄位。套用至數字篩選器的作業。 |
value |
必要欄位。要比對的數字或日期值。 |
作業
套用至數字篩選器的作業。
列舉 | |
---|---|
OPERATION_UNSPECIFIED |
未指明 |
EQUAL |
等於。 |
LESS_THAN |
小於。 |
GREATER_THAN |
大於。 |
NumericValue
表示數字。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位 one_value 。其中一個數值。one_value 只能是下列其中一項: |
|
int64Value |
整數值。 |
doubleValue |
雙精度浮點值。 |
BetweenFilter
用來篩選維度或指標中特定值之間的數值或日期值。
JSON 表示法 |
---|
{ "fromValue": { object ( |
欄位 | |
---|---|
fromValue |
必要欄位。以這個數字開頭 (含首尾)。 |
toValue |
必要欄位。結尾是這個數字 (含)。 |
AudienceEventFilter
比對單一事件名稱事件的篩選器。如果指定事件參數,則只有部分事件同時符合單一事件名稱和參數篩選器運算式,才會符合這個事件篩選器。
JSON 表示法 |
---|
{
"eventName": string,
"eventParameterFilterExpression": {
object ( |
欄位 | |
---|---|
eventName |
必要欄位。不可變動。要比對的事件名稱。 |
eventParameterFilterExpression |
選用設定。如有指定,這個篩選器會比對同時符合單一事件名稱和參數篩選運算式的事件。無法在參數篩選器運算式中設定 AudienceEventFilter (例如,不支援巢狀事件篩選器)。這應為維度 OrMetricFilter 或 notExpression 的單一 andGroup;不支援 OR 的 AND 。此外,如果篩選器包含「eventCount」的篩選器,系統只會考慮這個篩選器,並忽略所有其他篩選器。 |
AudienceSequenceFilter
定義篩選器,使用者須按照特定順序執行,才能成為目標對象成員。
JSON 表示法 |
---|
{ "scope": enum ( |
欄位 | |
---|---|
scope |
必要欄位。不可變動。指定這個篩選器的範圍。 |
sequenceMaximumDuration |
選用設定。定義整個序列必須發生的時間範圍。 時間長度以秒為單位,最多可有 9 個小數位數,並結尾為「 |
sequenceSteps[] |
必要欄位。按照順序排列的步驟順序。使用者必須完成每個步驟,才能加入序列篩選器。 |
AudienceSequenceStep
這種條件必須符合使用者指定的步驟順序,才能比對序列。
JSON 表示法 |
---|
{ "scope": enum ( |
欄位 | |
---|---|
scope |
必要欄位。不可變動。指定這個步驟的範圍。 |
immediatelyFollows |
選用設定。如果為 true,完成這個步驟的事件必須是滿足最後一個步驟事件後的下一個事件。如未設定或設為 False,這個步驟會間接跟著前一個步驟;例如,前一個步驟和步驟之間可能會出現事件。第一個步驟會忽略這個欄位。 |
constraintDuration |
選用設定。設定之後,必須在上一個步驟的 constraintDuration 內 (例如 t[i] - t[i-1] <= constraintDuration)。如未設定,則沒有時間長度限制 (有效無限制)。第一個步驟會忽略這個欄位。 時間長度以秒為單位,最多可有 9 個小數位數,並結尾為「 |
filterExpression |
必要欄位。不可變動。每個步驟中目標對象維度、指標或事件篩選器的邏輯運算式。 |
AudienceClauseType
指定這是包含或排除篩選器子句。
列舉 | |
---|---|
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED |
未指定的子句類型。 |
INCLUDE |
如果符合篩選器子句,系統就會將使用者納入目標對象。 |
EXCLUDE |
如果使用者符合篩選器子句,就會從目標對像中排除。 |
方法 |
|
---|---|
|
封存資源中的目標對象。 |
|
建立目標對象。 |
|
查詢單一目標對象。 |
|
列出資源上的目標對象。 |
|
更新資源上的目標對象。 |