Google Analytics Data V1alpha Client - Class UserSequenceStep (0.16.3)

Version 0.16.3

• 0.17.1 (latest)
• 0.17.0
• 0.16.4
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.2
• 0.10.1
• 0.9.5

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Analytics Data V1alpha Client class UserSequenceStep.

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

Generated from protobuf message google.analytics.data.v1alpha.UserSequenceStep

Namespace

Google \ Analytics \ Data \ V1alpha

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ is_directly_followed_by	bool If true, the event satisfying this step must be the very next event after the event satifying the last step. If false, this step indirectly follows the prior step; for example, there may be events between the prior step and this step. isDirectlyFollowedBy must be false for the first step.
↳ step_scoping	int This sequence step must be satisfied in the scoping for the user to match the sequence. For example if sequenceScoping = WITHIN_SAME_SESSION, this sequence steps must complete within one session for the user to match the sequence. stepScoping = ACROSS_ALL_SESSIONS is only allowed if the sequenceScoping = ACROSS_ALL_SESSIONS. Optional. If unspecified, stepScoping uses the same UserCriteriaScoping as the sequenceScoping.
↳ segment_filter_expression	Google\Analytics\Data\V1alpha\SegmentFilterExpression A user matches this sequence step if their events match this expression. Expressions express criteria on dimension, metrics, and/or parameters.

getIsDirectlyFollowedBy

If true, the event satisfying this step must be the very next event after the event satifying the last step. If false, this step indirectly follows the prior step; for example, there may be events between the prior step and this step. isDirectlyFollowedBy must be false for the first step.

Returns
Type	Description
bool

setIsDirectlyFollowedBy

If true, the event satisfying this step must be the very next event after the event satifying the last step. If false, this step indirectly follows the prior step; for example, there may be events between the prior step and this step. isDirectlyFollowedBy must be false for the first step.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getStepScoping

This sequence step must be satisfied in the scoping for the user to match the sequence. For example if sequenceScoping = WITHIN_SAME_SESSION, this sequence steps must complete within one session for the user to match the sequence. stepScoping = ACROSS_ALL_SESSIONS is only allowed if the sequenceScoping = ACROSS_ALL_SESSIONS.

Optional. If unspecified, stepScoping uses the same UserCriteriaScoping as the sequenceScoping.

Returns
Type	Description
int

setStepScoping

This sequence step must be satisfied in the scoping for the user to match the sequence. For example if sequenceScoping = WITHIN_SAME_SESSION, this sequence steps must complete within one session for the user to match the sequence. stepScoping = ACROSS_ALL_SESSIONS is only allowed if the sequenceScoping = ACROSS_ALL_SESSIONS.

Optional. If unspecified, stepScoping uses the same UserCriteriaScoping as the sequenceScoping.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getSegmentFilterExpression

A user matches this sequence step if their events match this expression. Expressions express criteria on dimension, metrics, and/or parameters.

Returns
Type	Description
Google\Analytics\Data\V1alpha\SegmentFilterExpression|null

hasSegmentFilterExpression

clearSegmentFilterExpression

setSegmentFilterExpression

A user matches this sequence step if their events match this expression. Expressions express criteria on dimension, metrics, and/or parameters.

Parameter
Name	Description
var	Google\Analytics\Data\V1alpha\SegmentFilterExpression

Returns
Type	Description
$this