Funnel goal attained when a lead completes one or more tasks, matched either by legacy task name or by the modern matchTaskName, matchTaskCategory or matchTaskTag configuration. Evaluated against each TaskCompleteFunnelEvent raised for the funnel's lead. When the legacy taskName is set it matches a single task by name; otherwise matchesModernTaskGoal requires every task matched by the configured name, category or tag to be completed before the goal advances to nextNodeId.
Group: Journeys
Extends: Goal
Implements: Serializable, AbstractTaskCompleteGoal
Properties
| Property | Returns | Description |
|---|---|---|
| description | String | A short human-readable description of this goal, naming the legacy task name it matches, for display in the funnel editor's node list. |
| matchTaskCategory | String | The category whose matching tasks must all be completed for this goal to be attained. |
| matchTaskName | String | The name of the single task that must be completed for this goal to be attained, using the modern task configuration. Null if this goal instead matches by legacy task name, category or tag. |
| matchTaskTag | String | The tag whose matching tasks must all be completed for this goal to be attained. |
| nextNodeId | String | The id of the funnel node to advance to once this goal is attained. |
| taskName | String | The legacy task name this goal matches when set. Superseded by getMatchTaskName for goals configured with the modern UI. |
Methods
getMatchTaskName()
Returns: String
The name of the single task that must be completed for this goal to be attained, using the modern task configuration. Null if this goal instead matches by legacy task name, category or tag.
getMatchTaskTag()
Returns: String
The tag whose matching tasks must all be completed for this goal to be attained.
getMatchTaskCategory()
Returns: String
The category whose matching tasks must all be completed for this goal to be attained.
getDescription()
Returns: String
A short human-readable description of this goal, naming the legacy task name it matches, for display in the funnel editor's node list.
getTaskName()
Returns: String
The legacy task name this goal matches when set. Superseded by getMatchTaskName for goals configured with the modern UI.
getNextNodeId()
Returns: String
The id of the funnel node to advance to once this goal is attained.