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

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

object (AudienceEventTrigger)

選用設定。指定在使用者加入目標對象時要記錄的事件。如果未設定，使用者加入目標對象時就不會記錄事件。
exclusionDurationMode

enum (AudienceExclusionDurationMode)

不可變動。指定符合排除篩選條件的使用者，排除時間長度為多久。這項屬性會套用至所有 EXCLUDE 篩選器子句，如果目標對象中沒有 EXCLUDE 篩選器子句，則會忽略這項屬性。
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 運算的運算式清單。只能包含含有 orGroup 的 AudienceFilterExpressions。您必須為頂層 AudienceFilterExpression 設定這項屬性。
orGroup

object (AudienceFilterExpressionList)

要一起執行 OR 運算的運算式清單。不得包含含有 andGroup 或 orGroup 的 AudienceFilterExpression。
notExpression

object (AudienceFilterExpression)

要加上「NOT」運算的篩選器運算式 (例如反轉、補足)。只能包含維度或指標篩選器。您無法在頂層 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 的維度或指標篩選器，或是 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

 更新資源的目標對象。