- 资源:Audience
- 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 |
仅供输出。此受众群体资源的资源名称。格式:properties/{propertyId}/audiences/{audienceId} |
displayName |
必需。受众群体的显示名称。 |
description |
必需。受众群体的说明。 |
membershipDurationDays |
必需。不可变。用户留在受众群体中的时长。该时间范围不能超过 540 天。 |
adsPersonalizationEnabled |
仅供输出。如果是 NPA 受众群体且已排除在广告个性化范围之外,GA 会自动将其设置为 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 运算的表达式列表。它只能包含带有 orGroup 的 AudienceFilterExpressions。必须为顶级 AudienceFilterExpression 设置此字段。 |
orGroup |
通过 OR 连接在一起的表达式列表。不能包含带有 andGroup 或 orGroup 的 AudienceFilterExpressions。 |
notExpression |
要进行 NOT 运算(例如,反转、互补)的过滤表达式。它只能包含 dimensionOrMetricFilter。无法在顶级 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 关系。此外,如果其中包含“eventCount”的过滤器,则系统只会考虑该过滤器,而忽略所有其他过滤器。 |
AudienceSequenceFilter
定义过滤器,这些过滤器必须按特定顺序运行,这样用户才能成为受众群体的成员。
JSON 表示法 |
---|
{ "scope": enum ( |
字段 | |
---|---|
scope |
必需。不可变。指定此过滤器的范围。 |
sequenceMaximumDuration |
可选。定义整个序列必须发生的时间段。 时长以秒为单位,最多包含九个小数位,以“ |
sequenceSteps[] |
必需。有序的步骤序列。用户必须完成每个步骤才能加入序列过滤器。 |
AudienceSequenceStep
与序列匹配的指定步骤顺序中必须发生的条件。
JSON 表示法 |
---|
{ "scope": enum ( |
字段 | |
---|---|
scope |
必需。不可变。指定此步骤的范围。 |
immediatelyFollows |
可选。如果为 true,则满足此步骤的事件必须是满足最后一个步骤的事件之后的下一个事件。如果未设置或 false,此步骤将间接后跟前一步;例如,上一步和此步骤之间可能存在事件。在第一步中,这项设置会被忽略。 |
constraintDuration |
可选。设置后,必须在前一个步骤的 constraintDuration 内满足此条件(例如,t[i] - t[i-1] <= constraintDuration)。如果未设置,则没有时长要求(时长实际上是无限制的)。在第一步中,这项设置会被忽略。 时长以秒为单位,最多包含九个小数位,以“ |
filterExpression |
必需。不可变。每个步骤中的受众群体维度、指标或事件过滤条件的逻辑表达式。 |
AudienceClauseType
指定此为包含过滤器还是排除过滤器子句。
枚举 | |
---|---|
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED |
未指定的子句类型。 |
INCLUDE |
如果满足过滤条件子句,用户将被包含在受众群体中。 |
EXCLUDE |
如果满足过滤条件子句,用户将从受众群体中排除。 |
方法 |
|
---|---|
|
将媒体资源上的受众群体归档。 |
|
创建受众群体。 |
|
查找单个受众群体。 |
|
列出媒体资源上的受众群体。 |
|
更新媒体资源上的受众群体。 |