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 message google.analytics.data.v1alpha.FunnelStep
Namespace
Google \ Analytics \ Data \ V1alphaMethods
__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 the |
↳ 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, |
↳ within_duration_from_prior_step |
Google\Protobuf\Duration
If specified, this step must complete within this duration of the completion of the prior step. |
↳ filter_expression |
FunnelFilterExpression
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 the funnelStepName dimension. For
example, specifying name = Purchase in the request's third funnel step
will produce 3. Purchase in 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 the funnelStepName dimension. For
example, specifying name = Purchase in the request's third funnel step
will produce 3. Purchase in 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, isDirectlyFollowedBy is 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, isDirectlyFollowedBy is 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. withinDurationFromPriorStep is 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.
withinDurationFromPriorStep is optional, and if unspecified, steps may
be separated by any time duration.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasWithinDurationFromPriorStep
clearWithinDurationFromPriorStep
setWithinDurationFromPriorStep
If specified, this step must complete within this duration of the
completion of the prior step. withinDurationFromPriorStep is 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.
withinDurationFromPriorStep is optional, and if unspecified, steps may
be separated by any time duration.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilterExpression
The condition that your users must meet to be included in this step of the funnel journey.
| Returns | |
|---|---|
| Type | Description |
FunnelFilterExpression|null |
|
hasFilterExpression
clearFilterExpression
setFilterExpression
The condition that your users must meet to be included in this step of the funnel journey.
| Parameter | |
|---|---|
| Name | Description |
var |
FunnelFilterExpression
|
| Returns | |
|---|---|
| Type | Description |
$this |
|