Reference documentation and code samples for the Google Analytics Admin V1alpha Client class AudienceSequenceStep.
A condition that must occur in the specified step order for this user to match the sequence.
Generated from protobuf message google.analytics.admin.v1alpha.AudienceSequenceFilter.AudienceSequenceStep
Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ scope |
int
Required. Immutable. Specifies the scope for this step. |
↳ immediately_follows |
bool
Optional. If true, the event satisfying this step must be the very next event after the event satisfying the last step. If unset or false, this step indirectly follows the prior step; for example, there may be events between the prior step and this step. It is ignored for the first step. |
↳ constraint_duration |
Google\Protobuf\Duration
Optional. When set, this step must be satisfied within the constraint_duration of the previous step (i.e., t[i] - t[i-1] <= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step. |
↳ filter_expression |
Google\Analytics\Admin\V1alpha\AudienceFilterExpression
Required. Immutable. A logical expression of Audience dimension, metric, or event filters in each step. |
getScope
Required. Immutable. Specifies the scope for this step.
Returns | |
---|---|
Type | Description |
int |
setScope
Required. Immutable. Specifies the scope for this step.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getImmediatelyFollows
Optional. If true, the event satisfying this step must be the very next event after the event satisfying the last step. If unset or false, this step indirectly follows the prior step; for example, there may be events between the prior step and this step. It is ignored for the first step.
Returns | |
---|---|
Type | Description |
bool |
setImmediatelyFollows
Optional. If true, the event satisfying this step must be the very next event after the event satisfying the last step. If unset or false, this step indirectly follows the prior step; for example, there may be events between the prior step and this step. It is ignored for the first step.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getConstraintDuration
Optional. When set, this step must be satisfied within the constraint_duration of the previous step (i.e., t[i] - t[i-1] <= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Duration|null |
hasConstraintDuration
clearConstraintDuration
setConstraintDuration
Optional. When set, this step must be satisfied within the constraint_duration of the previous step (i.e., t[i] - t[i-1] <= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Duration
|
Returns | |
---|---|
Type | Description |
$this |
getFilterExpression
Required. Immutable. A logical expression of Audience dimension, metric, or event filters in each step.
Returns | |
---|---|
Type | Description |
Google\Analytics\Admin\V1alpha\AudienceFilterExpression|null |
hasFilterExpression
clearFilterExpression
setFilterExpression
Required. Immutable. A logical expression of Audience dimension, metric, or event filters in each step.
Parameter | |
---|---|
Name | Description |
var |
Google\Analytics\Admin\V1alpha\AudienceFilterExpression
|
Returns | |
---|---|
Type | Description |
$this |