REST Resource: properties.audiences

{
  "name": string,
  "displayName": string,
  "description": string,
  "membershipDurationDays": integer,
  "adsPersonalizationEnabled": boolean,
  "eventTrigger": {
    object (AudienceEventTrigger)
  },
  "exclusionDurationMode": enum (AudienceExclusionDurationMode),
  "filterClauses": [
    {
      object (AudienceFilterClause)
    }
  ],
  "createTime": string
}

string

Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId}

string

Required. The display name of the Audience.

string

Required. The description of the Audience.

integer

Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days.

boolean

Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization.

object (AudienceEventTrigger)

Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience.

enum (AudienceExclusionDurationMode)

Immutable. Specifies how long an exclusion lasts for users that meet the exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored when there is no EXCLUDE filter clause in the Audience.

object (AudienceFilterClause)

Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed together.

string (Timestamp format)

Output only. Time when the Audience was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

{
  "eventName": string,
  "logCondition": enum (LogCondition)
}

string

Required. The event name that will be logged.

enum (LogCondition)

Required. When to log the event.

{
  "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.
}

enum (AudienceClauseType)

Required. Specifies whether this is an include or exclude filter clause.

object (AudienceSimpleFilter)

A simple filter that a user must satisfy to be a member of the Audience.

object (AudienceSequenceFilter)

Filters that must occur in a specific order for the user to be a member of the Audience.

{
  "scope": enum (AudienceFilterScope),
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}

enum (AudienceFilterScope)

Required. Immutable. Specifies the scope for this filter.

object (AudienceFilterExpression)

Required. Immutable. A logical expression of Audience dimension, metric, or event filters.

{

  // 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.
}

object (AudienceFilterExpressionList)

A list of expressions to be AND’ed together. It can only contain AudienceFilterExpressions with orGroup. This must be set for the top level AudienceFilterExpression.

object (AudienceFilterExpressionList)

A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with andGroup or orGroup.

object (AudienceFilterExpression)

A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimensionOrMetricFilter. This cannot be set on the top level AudienceFilterExpression.

object (AudienceDimensionOrMetricFilter)

A filter on a single dimension or metric. This cannot be set on the top level AudienceFilterExpression.

object (AudienceEventFilter)

Creates a filter that matches a specific event. This cannot be set on the top level AudienceFilterExpression.

{
  "filterExpressions": [
    {
      object (AudienceFilterExpression)
    }
  ]
}

object (AudienceFilterExpression)

A list of Audience filter expressions.

{
  "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.
}

string

Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the Google Analytics Data API documentation.

boolean

Optional. Indicates whether this filter needs dynamic evaluation or not. If set to true, users join the Audience if they ever met the condition (static evaluation). If unset or set to false, user evaluation for an Audience is dynamic; users are added to an Audience when they meet the conditions and then removed when they no longer meet them.

This can only be set when Audience scope is ACROSS_ALL_SESSIONS.

integer

Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window).

For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when atAnyPointInTime is unset or false.

It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days.

object (StringFilter)

A filter for a string-type dimension that matches a particular pattern.

object (InListFilter)

A filter for a string dimension that matches a particular list of options.

object (NumericFilter)

A filter for numeric or date values on a dimension or metric.

object (BetweenFilter)

A filter for numeric or date values between certain values on a dimension or metric.

{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}

enum (MatchType)

Required. The match type for the string filter.

string

Required. The string value to be matched against.

boolean

Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.

{
  "values": [
    string
  ],
  "caseSensitive": boolean
}

string

Required. The list of possible string values to match against. Must be non-empty.

boolean

Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.

{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}

enum (Operation)

Required. The operation applied to a numeric filter.

object (NumericValue)

Required. The numeric or date value to match against.

{

  // 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.
}

string (int64 format)

Integer value.

number

Double value.

{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}

object (NumericValue)

Required. Begins with this number, inclusive.

object (NumericValue)

Required. Ends with this number, inclusive.

{
  "eventName": string,
  "eventParameterFilterExpression": {
    object (AudienceFilterExpression)
  }
}

string

Required. Immutable. The name of the event to match against.

object (AudienceFilterExpression)

Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single andGroup of dimensionOrMetricFilter or notExpression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored.

{
  "scope": enum (AudienceFilterScope),
  "sequenceMaximumDuration": string,
  "sequenceSteps": [
    {
      object (AudienceSequenceStep)
    }
  ]
}

enum (AudienceFilterScope)

Required. Immutable. Specifies the scope for this filter.

string (Duration format)

Optional. Defines the time period in which the whole sequence must occur.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

object (AudienceSequenceStep)

Required. An ordered sequence of steps. A user must complete each step in order to join the sequence filter.

{
  "scope": enum (AudienceFilterScope),
  "immediatelyFollows": boolean,
  "constraintDuration": string,
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}

enum (AudienceFilterScope)

Required. Immutable. Specifies the scope for this step.

boolean

Optional. If true, the event satisfying this step must be the very next event after the event satisfying the last step. If unset or false, this step indirectly follows the prior step; for example, there may be events between the prior step and this step. It is ignored for the first step.

string (Duration format)

Optional. When set, this step must be satisfied within the constraintDuration of the previous step (For example, t[i] - t[i-1] <= constraintDuration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

object (AudienceFilterExpression)

Required. Immutable. A logical expression of Audience dimension, metric, or event filters in each step.