REST Resource: properties.audiences

资源：受众群体

表示受众群体的资源消息。

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)

要联接的表达式列表。它只能包含包含 orGroup 的 AudienceFilterExpression。必须为顶级 AudienceFilterExpression 设置此值。
orGroup

object (AudienceFilterExpressionList)

要联接起来的表达式列表。它不能包含包含 andGroup 或 orGroup 的 AudienceFilterExpression。
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（例如，不支持嵌套事件过滤条件）。这应为 dimensionOrMetricFilter 或 notExpression 的单个 andGroup；不支持 OR 的 AND。此外，如果报告包含“eventCount”过滤条件，系统只会考虑该过滤条件，而忽略所有其他过滤条件。

AudienceSequenceFilter

定义用户必须按特定顺序满足的过滤条件，才能成为受众群体的成员。

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

enum (AudienceFilterScope)

必需。不可变。指定此过滤器的范围。
sequenceMaximumDuration

string (Duration format)

可选。指定整个序列必须在多长时间内完成。

该时长以秒为单位，最多包含九个小数位，以“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）。如果未设置，则无需满足时长要求（时长实际上不受限制）。系统会忽略第一步。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
filterExpression

object (AudienceFilterExpression)

必需。不可变。每个步骤中的受众群体维度、指标或事件过滤条件的逻辑表达式。

AudienceClauseType

指定这是包含还是排除过滤条件子句。

枚举
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED 未指定子句类型。
INCLUDE 如果用户符合过滤条件，系统会将其纳入受众群体。
EXCLUDE 如果用户符合过滤条件，系统会将其从受众群体中排除。

方法

archive

 归档媒体资源上的受众群体。

create

 创建受众群体。

get

 查找单个受众群体。

list

 列出媒体资源中的受众群体。

patch

 更新媒体资源的受众群体。