Google Analytics Data V1alpha Client - Class UserSegmentSequenceGroup (0.17.1)

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

Define conditions that must occur in a specific order for the user to be a member of the segment.

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

Namespace

Google \ Analytics \ Data \ V1alpha

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ sequence_scoping int

All sequence steps must be satisfied in the scoping for the user to match the sequence. For example if sequenceScoping = USER_CRITERIA_WITHIN_SAME_SESSION, all sequence steps must complete within one session for the user to match the sequence. sequenceScoping = USER_CRITERIA_WITHIN_SAME_EVENT is not supported. Optional. If unspecified, conditionScoping = ACROSS_ALL_SESSIONS is used.

↳ sequence_maximum_duration Google\Protobuf\Duration

Defines the time period in which the whole sequence must occur; for example, 30 Minutes. sequenceMaximumDuration is inclusive of the endpoint at the microsecond granularity. For example a sequence with a maximum duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond. sequenceMaximumDuration is optional, and if unspecified, sequences can be completed in any time duration.

↳ user_sequence_steps array<Google\Analytics\Data\V1alpha\UserSequenceStep>

An ordered sequence of condition steps. A user's events must complete each step in order for the user to match the UserSegmentSequenceGroup.

getSequenceScoping

All sequence steps must be satisfied in the scoping for the user to match the sequence. For example if sequenceScoping = USER_CRITERIA_WITHIN_SAME_SESSION, all sequence steps must complete within one session for the user to match the sequence. sequenceScoping = USER_CRITERIA_WITHIN_SAME_EVENT is not supported.

Optional. If unspecified, conditionScoping = ACROSS_ALL_SESSIONS is used.

Returns
Type Description
int

setSequenceScoping

All sequence steps must be satisfied in the scoping for the user to match the sequence. For example if sequenceScoping = USER_CRITERIA_WITHIN_SAME_SESSION, all sequence steps must complete within one session for the user to match the sequence. sequenceScoping = USER_CRITERIA_WITHIN_SAME_EVENT is not supported.

Optional. If unspecified, conditionScoping = ACROSS_ALL_SESSIONS is used.

Parameter
Name Description
var int
Returns
Type Description
$this

getSequenceMaximumDuration

Defines the time period in which the whole sequence must occur; for example, 30 Minutes. sequenceMaximumDuration is inclusive of the endpoint at the microsecond granularity. For example a sequence with a maximum duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond.

sequenceMaximumDuration is optional, and if unspecified, sequences can be completed in any time duration.

Returns
Type Description
Google\Protobuf\Duration|null

hasSequenceMaximumDuration

clearSequenceMaximumDuration

setSequenceMaximumDuration

Defines the time period in which the whole sequence must occur; for example, 30 Minutes. sequenceMaximumDuration is inclusive of the endpoint at the microsecond granularity. For example a sequence with a maximum duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond.

sequenceMaximumDuration is optional, and if unspecified, sequences can be completed in any time duration.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getUserSequenceSteps

An ordered sequence of condition steps. A user's events must complete each step in order for the user to match the UserSegmentSequenceGroup.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setUserSequenceSteps

An ordered sequence of condition steps. A user's events must complete each step in order for the user to match the UserSegmentSequenceGroup.

Parameter
Name Description
var array<Google\Analytics\Data\V1alpha\UserSequenceStep>
Returns
Type Description
$this