Reference documentation and code samples for the Google Analytics Data V1alpha Client class FunnelStep.
Steps define the user journey you want to measure. Steps contain one or
more conditions that your users must meet to be included in that step of
the funnel journey.
Generated from protobuf messagegoogle.analytics.data.v1alpha.FunnelStep
Namespace
Google \ Analytics \ Data \ V1alpha
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
The distinctive name for this step. If unspecified, steps will be named by a 1 based indexed name (for example "0. ", "1. ", etc.). This name defines string value returned by thefunnelStepNamedimension. For example, specifyingname = Purchasein the request's third funnel step will produce3. Purchasein the funnel report response.
↳ is_directly_followed_by
bool
If true, this step must directly follow the previous step. If false, there can be events between the previous step and this step. If unspecified,isDirectlyFollowedByis treated as false.
If specified, this step must complete within this duration of the completion of the prior step.withinDurationFromPriorStepis inclusive of the endpoint at the microsecond granularity. For example a duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond.withinDurationFromPriorStepis optional, and if unspecified, steps may be separated by any time duration.
The condition that your users must meet to be included in this step of the funnel journey.
getName
The distinctive name for this step. If unspecified, steps will be named
by a 1 based indexed name (for example "0. ", "1. ", etc.). This name
defines string value returned by thefunnelStepNamedimension. For
example, specifyingname = Purchasein the request's third funnel step
will produce3. Purchasein the funnel report response.
Returns
Type
Description
string
setName
The distinctive name for this step. If unspecified, steps will be named
by a 1 based indexed name (for example "0. ", "1. ", etc.). This name
defines string value returned by thefunnelStepNamedimension. For
example, specifyingname = Purchasein the request's third funnel step
will produce3. Purchasein the funnel report response.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getIsDirectlyFollowedBy
If true, this step must directly follow the previous step. If false,
there can be events between the previous step and this step. If
unspecified,isDirectlyFollowedByis treated as false.
Returns
Type
Description
bool
setIsDirectlyFollowedBy
If true, this step must directly follow the previous step. If false,
there can be events between the previous step and this step. If
unspecified,isDirectlyFollowedByis treated as false.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getWithinDurationFromPriorStep
If specified, this step must complete within this duration of the
completion of the prior step.withinDurationFromPriorStepis inclusive
of the endpoint at the microsecond granularity. For example a duration of
5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1
microsecond.
withinDurationFromPriorStepis optional, and if unspecified, steps may
be separated by any time duration.
If specified, this step must complete within this duration of the
completion of the prior step.withinDurationFromPriorStepis inclusive
of the endpoint at the microsecond granularity. For example a duration of
5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1
microsecond.
withinDurationFromPriorStepis optional, and if unspecified, steps may
be separated by any time duration.
[[["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 FunnelStep (0.22.3)\n\nVersion latestkeyboard_arrow_down\n\n- [0.22.3 (latest)](/php/docs/reference/analytics-data/latest/V1alpha.FunnelStep)\n- [0.22.2](/php/docs/reference/analytics-data/0.22.2/V1alpha.FunnelStep)\n- [0.21.1](/php/docs/reference/analytics-data/0.21.1/V1alpha.FunnelStep)\n- [0.20.1](/php/docs/reference/analytics-data/0.20.1/V1alpha.FunnelStep)\n- [0.19.0](/php/docs/reference/analytics-data/0.19.0/V1alpha.FunnelStep)\n- [0.18.0](/php/docs/reference/analytics-data/0.18.0/V1alpha.FunnelStep)\n- [0.17.1](/php/docs/reference/analytics-data/0.17.1/V1alpha.FunnelStep)\n- [0.16.4](/php/docs/reference/analytics-data/0.16.4/V1alpha.FunnelStep)\n- [0.14.0](/php/docs/reference/analytics-data/0.14.0/V1alpha.FunnelStep)\n- [0.13.0](/php/docs/reference/analytics-data/0.13.0/V1alpha.FunnelStep)\n- [0.12.0](/php/docs/reference/analytics-data/0.12.0/V1alpha.FunnelStep)\n- [0.11.2](/php/docs/reference/analytics-data/0.11.2/V1alpha.FunnelStep)\n- [0.10.1](/php/docs/reference/analytics-data/0.10.1/V1alpha.FunnelStep)\n- [0.9.5](/php/docs/reference/analytics-data/0.9.5/V1alpha.FunnelStep) \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 FunnelStep.\n\nSteps define the user journey you want to measure. Steps contain one or\nmore conditions that your users must meet to be included in that step of\nthe funnel journey.\n\nGenerated from protobuf message `google.analytics.data.v1alpha.FunnelStep`\n\nNamespace\n---------\n\nGoogle \\\\ Analytics \\\\ Data \\\\ V1alpha\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nThe distinctive name for this step. If unspecified, steps will be named\nby a 1 based indexed name (for example \"0. \", \"1. \", etc.). This name\ndefines string value returned by the `funnelStepName` dimension. For\nexample, specifying `name = Purchase` in the request's third funnel step\nwill produce `3. Purchase` in the funnel report response.\n\n### setName\n\nThe distinctive name for this step. If unspecified, steps will be named\nby a 1 based indexed name (for example \"0. \", \"1. \", etc.). This name\ndefines string value returned by the `funnelStepName` dimension. For\nexample, specifying `name = Purchase` in the request's third funnel step\nwill produce `3. Purchase` in the funnel report response.\n\n### getIsDirectlyFollowedBy\n\nIf true, this step must directly follow the previous step. If false,\nthere can be events between the previous step and this step. If\nunspecified, `isDirectlyFollowedBy` is treated as false.\n\n### setIsDirectlyFollowedBy\n\nIf true, this step must directly follow the previous step. If false,\nthere can be events between the previous step and this step. If\nunspecified, `isDirectlyFollowedBy` is treated as false.\n\n### getWithinDurationFromPriorStep\n\nIf specified, this step must complete within this duration of the\ncompletion of the prior step. `withinDurationFromPriorStep` is inclusive\nof the endpoint at the microsecond granularity. For example a duration of\n5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1\nmicrosecond.\n\n`withinDurationFromPriorStep` is optional, and if unspecified, steps may\nbe separated by any time duration.\n\n### hasWithinDurationFromPriorStep\n\n### clearWithinDurationFromPriorStep\n\n### setWithinDurationFromPriorStep\n\nIf specified, this step must complete within this duration of the\ncompletion of the prior step. `withinDurationFromPriorStep` is inclusive\nof the endpoint at the microsecond granularity. For example a duration of\n5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1\nmicrosecond.\n\n`withinDurationFromPriorStep` is optional, and if unspecified, steps may\nbe separated by any time duration.\n\n### getFilterExpression\n\nThe condition that your users must meet to be included in this step of\nthe funnel journey.\n\n### hasFilterExpression\n\n### clearFilterExpression\n\n### setFilterExpression\n\nThe condition that your users must meet to be included in this step of\nthe funnel journey."]]
