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)
    }
  ]
}
字段
name

string

仅供输出。此受众群体资源的资源名称。格式：properties/{propertyId}/audiences/{audienceId}
displayName

string

必需。相应受众群体的显示名称。
description

string

必需。相应受众群体的说明。
membershipDurationDays

integer

必需。不可变。用户应在受众群体中保留的时长。此值不能设为超过 540 天。
adsPersonalizationEnabled

boolean

仅供输出。如果这是 NPA 受众群体且已从广告个性化中排除，Google Analytics（分析）会自动将其设置为 false。
eventTrigger

object (AudienceEventTrigger)

（可选）指定在用户加入受众群体时要记录的事件。如果未设置，当用户加入受众群体时，系统不会记录任何事件。
exclusionDurationMode

enum (AudienceExclusionDurationMode)

不可变。针对符合排除过滤器的用户，指定排除会话的持续时长。该过滤条件会应用于所有“排除”过滤条件子句，并在受众群体中没有任何“排除”过滤条件子句时被忽略。
filterClauses[]

object (AudienceFilterClause)

必需。不可变。无序列表。过滤用于定义受众群体的子句。所有子句将以 AND 逻辑关系结合在一起。

AudienceEventTrigger 类中的方法

指定在用户加入受众群体时要记录的事件。

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

string

必需。将记录的事件名称。
logCondition

enum (LogCondition)

必需。何时记录事件。

日志条件

确定何时记录事件。

枚举
LOG_CONDITION_UNSPECIFIED 未指定日志条件。
AUDIENCE_JOINED 只有在用户加入时，系统才会记录该事件。
AUDIENCE_MEMBERSHIP_RENEWED 每当满足受众群体条件时，系统应记录该事件，即使用户已经是受众群体成员也是如此。

AudienceExclusionDurationMode

针对符合排除过滤器的用户，指定排除会话的持续时长。

枚举
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED 未指定。
EXCLUDE_TEMPORARILY 在符合过滤条件子句的时段内从受众群体中排除用户。
EXCLUDE_PERMANENTLY 从受众群体中排除已经满足过滤条件子句的用户。

受众群体过滤条件

用于定义简单过滤条件或顺序过滤条件的子句。过滤条件可以是包容性（即，满足过滤条件条款的用户包含在受众群体中）或排除范围（即，从受众群体中排除满足过滤条件条款的用户）。

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)

必须按照特定顺序让用户成为受众群体成员的过滤条件。

受众群体简单过滤器

定义要成为受众群体成员，用户必须满足的简单过滤条件。

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 的 AudienceFilterExpression。必须为顶级 AudienceFilterExpression 设置此字段。
orGroup

object (AudienceFilterExpressionList)

用 OR 连接在一起的表达式列表。它不能包含带有 ANDGroup 或 OrGroup 的 AudienceFilterExpression。
notExpression

object (AudienceFilterExpression)

不加过滤条件的过滤条件表达式（即反转、补充）。它只能包含 dimensionOrMetricFilter。不能在顶级 AudienceFilterExpression 上设置。
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

针对单个维度或指标的过滤条件。不能在顶级 AudienceFilterExpression 上设置。
eventFilter

object (AudienceEventFilter)

创建与特定事件匹配的过滤条件。不能在顶级 AudienceFilterExpression 上设置。

AudienceFilterExpressionList

受众群体过滤条件表达式列表。

JSON 表示法 
{
  "filterExpressions": [
    {
      object (AudienceFilterExpression)
    }
  ]
}
字段
filterExpressions[]

object (AudienceFilterExpression)

受众群体过滤条件表达式列表。

受众群体维度或指标过滤器

针对单个维度或指标的特定过滤条件。

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

必需。不可变。要过滤的维度名称或指标名称。
atAnyPointInTime

boolean

（可选）指明此过滤器是否需要动态评估。如果设置为 true，则只要用户符合条件，就会加入受众群体（静态评估）。如果此政策未设置或设为 false，受众群体的动态评估便是动态的；当用户符合条件时将其添加到受众群体中，然后当用户不再符合条件时将其移除。

仅当受众群体范围为 ACROSS_ALL_SESSIONS 时才能进行此设置。
inAnyNDayPeriod

integer

（可选）如果设置此参数，请指定要在多少天内评估数据的时间范围。如果未设置，则根据生命周期数据（即无限时间期限）评估受众群体数据。

例如，如果设置为 1 天，则仅评估当天的数据。该参考点是未设置 AtAnyPointInTime 时当天的日期。

仅当受众群体范围为 ACROSS_ALL_SESSIONS 且不超过 60 天时才能设置此值。
联合字段 one_filter。上述过滤器之一。one_filter 只能是下列其中一项：
stringFilter

object (StringFilter)

过滤条件，用于匹配特定模式的字符串类型维度。
inListFilter

object (InListFilter)

针对与特定选项列表匹配的字符串维度的过滤条件。
numericFilter

object (NumericFilter)

对维度或指标的数值或日期值的过滤条件。
betweenFilter

object (BetweenFilter)

过滤条件，用于过滤维度或指标中特定值之间的数字或日期值。

字符串过滤器

过滤条件，用于匹配特定模式的字符串类型维度。

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 完整正则表达式与字符串值匹配。

列表过滤器

针对与特定选项列表匹配的字符串维度的过滤条件。

JSON 表示法 
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
字段
values[]

string

必需。要匹配的可能字符串值的列表。不得为空。
caseSensitive

boolean

（可选）如果为 true，则匹配时区分大小写。如果为 false，则匹配不区分大小写。

数字过滤器

对维度或指标的数值或日期值的过滤条件。

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

双精度值。

之间

过滤条件，用于过滤维度或指标中特定值之间的数字或日期值。

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 的 OR。此外，如果该过滤器包含“eventCount”过滤器，系统仅会考虑该过滤器；所有其他过滤器都会被忽略。

AudienceSequenceFilter

定义必须按照特定顺序成为用户受众群体成员的过滤条件。

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

enum (AudienceFilterScope)

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

string (Duration format)

（可选）定义整个序列必须发生的时间段。

此时间以秒为单位，最多包含九个小数位，并以“s”结尾。示例："3.5s"。
sequenceSteps[]

object (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)

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

受众群体类型

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

枚举
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED 未指定的子句类型。
INCLUDE 如果满足过滤条件子句，用户将包含在受众群体中。
EXCLUDE 如果满足过滤条件子句，用户将不会出现在受众群体中。

方法

archive

 将媒体资源归档。

create

 创建受众群体。

get

 查找单个受众群体。

list

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

patch

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