Google Analytics Admin V1alpha Client - Class AudienceSequenceStep (0.14.0)

Reference documentation and code samples for the Google Analytics Admin V1alpha Client class AudienceSequenceStep.

A condition that must occur in the specified step order for this user to match the sequence.

Generated from protobuf message google.analytics.admin.v1alpha.AudienceSequenceFilter.AudienceSequenceStep

Namespace

Google \ Analytics \ Admin \ V1alpha \ AudienceSequenceFilter

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ scope int

Required. Immutable. Specifies the scope for this step.

↳ immediately_follows bool

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.

↳ constraint_duration Google\Protobuf\Duration

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

↳ filter_expression Google\Analytics\Admin\V1alpha\AudienceFilterExpression

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

getScope

Required. Immutable. Specifies the scope for this step.

Returns
TypeDescription
int

setScope

Required. Immutable. Specifies the scope for this step.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getImmediatelyFollows

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.

Returns
TypeDescription
bool

setImmediatelyFollows

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.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getConstraintDuration

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

Returns
TypeDescription
Google\Protobuf\Duration|null

hasConstraintDuration

clearConstraintDuration

setConstraintDuration

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

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this

getFilterExpression

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

Returns
TypeDescription
Google\Analytics\Admin\V1alpha\AudienceFilterExpression|null

hasFilterExpression

clearFilterExpression

setFilterExpression

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

Parameter
NameDescription
var Google\Analytics\Admin\V1alpha\AudienceFilterExpression
Returns
TypeDescription
$this