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 messagegoogle.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.isDirectlyFollowedBymust 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 ifsequenceScoping = WITHIN_SAME_SESSION, this sequence steps must complete within one session for the user to match the sequence.stepScoping = ACROSS_ALL_SESSIONSis only allowed if thesequenceScoping = ACROSS_ALL_SESSIONS. Optional. If unspecified,stepScopinguses the sameUserCriteriaScopingas thesequenceScoping.
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.isDirectlyFollowedBymust 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.isDirectlyFollowedBymust 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 ifsequenceScoping =
WITHIN_SAME_SESSION, this sequence steps must complete within one
session for the user to match the sequence.stepScoping =
ACROSS_ALL_SESSIONSis only allowed if thesequenceScoping =
ACROSS_ALL_SESSIONS.
Optional. If unspecified,stepScopinguses the sameUserCriteriaScopingas thesequenceScoping.
Returns
Type
Description
int
setStepScoping
This sequence step must be satisfied in the scoping for the user to
match the sequence. For example ifsequenceScoping =
WITHIN_SAME_SESSION, this sequence steps must complete within one
session for the user to match the sequence.stepScoping =
ACROSS_ALL_SESSIONSis only allowed if thesequenceScoping =
ACROSS_ALL_SESSIONS.
Optional. If unspecified,stepScopinguses the sameUserCriteriaScopingas thesequenceScoping.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Analytics Data V1alpha Client - Class UserSequenceStep (0.22.3)\n\nVersion latestkeyboard_arrow_down\n\n- [0.22.3 (latest)](/php/docs/reference/analytics-data/latest/V1alpha.UserSequenceStep)\n- [0.22.2](/php/docs/reference/analytics-data/0.22.2/V1alpha.UserSequenceStep)\n- [0.21.1](/php/docs/reference/analytics-data/0.21.1/V1alpha.UserSequenceStep)\n- [0.20.1](/php/docs/reference/analytics-data/0.20.1/V1alpha.UserSequenceStep)\n- [0.19.0](/php/docs/reference/analytics-data/0.19.0/V1alpha.UserSequenceStep)\n- [0.18.0](/php/docs/reference/analytics-data/0.18.0/V1alpha.UserSequenceStep)\n- [0.17.1](/php/docs/reference/analytics-data/0.17.1/V1alpha.UserSequenceStep)\n- [0.16.4](/php/docs/reference/analytics-data/0.16.4/V1alpha.UserSequenceStep)\n- [0.14.0](/php/docs/reference/analytics-data/0.14.0/V1alpha.UserSequenceStep)\n- [0.13.0](/php/docs/reference/analytics-data/0.13.0/V1alpha.UserSequenceStep)\n- [0.12.0](/php/docs/reference/analytics-data/0.12.0/V1alpha.UserSequenceStep)\n- [0.11.2](/php/docs/reference/analytics-data/0.11.2/V1alpha.UserSequenceStep)\n- [0.10.1](/php/docs/reference/analytics-data/0.10.1/V1alpha.UserSequenceStep)\n- [0.9.5](/php/docs/reference/analytics-data/0.9.5/V1alpha.UserSequenceStep) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Analytics Data V1alpha Client class UserSequenceStep.\n\nA condition that must occur in the specified step order for this user\nto match the sequence.\n\nGenerated from protobuf message `google.analytics.data.v1alpha.UserSequenceStep`\n\nNamespace\n---------\n\nGoogle \\\\ Analytics \\\\ Data \\\\ V1alpha\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getIsDirectlyFollowedBy\n\nIf true, the event satisfying this step must be the very next event\nafter the event satifying the last step. If false, this step indirectly\nfollows the prior step; for example, there may be events between the\nprior step and this step. `isDirectlyFollowedBy` must be false for\nthe first step.\n\n### setIsDirectlyFollowedBy\n\nIf true, the event satisfying this step must be the very next event\nafter the event satifying the last step. If false, this step indirectly\nfollows the prior step; for example, there may be events between the\nprior step and this step. `isDirectlyFollowedBy` must be false for\nthe first step.\n\n### getStepScoping\n\nThis sequence step must be satisfied in the scoping for the user to\nmatch the sequence. For example if `sequenceScoping =\nWITHIN_SAME_SESSION`, this sequence steps must complete within one\nsession for the user to match the sequence. `stepScoping =\nACROSS_ALL_SESSIONS` is only allowed if the `sequenceScoping =\nACROSS_ALL_SESSIONS`.\n\nOptional. If unspecified, `stepScoping` uses the same\n`UserCriteriaScoping` as the `sequenceScoping`.\n\n### setStepScoping\n\nThis sequence step must be satisfied in the scoping for the user to\nmatch the sequence. For example if `sequenceScoping =\nWITHIN_SAME_SESSION`, this sequence steps must complete within one\nsession for the user to match the sequence. `stepScoping =\nACROSS_ALL_SESSIONS` is only allowed if the `sequenceScoping =\nACROSS_ALL_SESSIONS`.\n\nOptional. If unspecified, `stepScoping` uses the same\n`UserCriteriaScoping` as the `sequenceScoping`.\n\n### getSegmentFilterExpression\n\nA user matches this sequence step if their events match this\nexpression. Expressions express criteria on dimension, metrics,\nand/or parameters.\n\n### hasSegmentFilterExpression\n\n### clearSegmentFilterExpression\n\n### setSegmentFilterExpression\n\nA user matches this sequence step if their events match this\nexpression. Expressions express criteria on dimension, metrics,\nand/or parameters."]]
