Goal that matches when a sales record is created in a configured data series, optionally requiring up to three custom field values to also match. Used as a funnel goal node: when a SalesRecordCreatedFunnelEvent fires, matches() confirms the record belongs to the configured series and that any configured custom field name/value pairs match the record, then advances the lead to the configured next node.
Group: Journeys
Extends: Goal
Implements: Serializable, ManualInitiationNode
Properties
| Property | Returns | Description |
|---|---|---|
| customFieldName1 | String | Name of the first sales record custom field to check when matching, or blank if this constraint is not configured. |
| customFieldName2 | String | Name of the second sales record custom field to check when matching, or blank if this constraint is not configured. |
| customFieldName3 | String | Name of the third sales record custom field to check when matching, or blank if this constraint is not configured. |
| customFieldValue1 | String | Value the first custom field must equal for a record to match; if left blank, the field on the record must also be blank. |
| customFieldValue2 | String | Value the second custom field must equal for a record to match; if left blank, the field on the record must also be blank. |
| customFieldValue3 | String | Value the third custom field must equal for a record to match; if left blank, the field on the record must also be blank. |
| description | String | Short label describing this goal type. Always returns the fixed string "SalesRecordCreatedGoal". |
| nextNodeId | String | Id of the funnel node to advance to when this goal matches. |
| seriesName | String | Name of the sales data series a matching record must belong to. |
Methods
getDescription() · getNextNodeId() · getSeriesName() · getCustomFieldName1() · getCustomFieldValue1() · getCustomFieldName2() · getCustomFieldValue2() · getCustomFieldName3() · getCustomFieldValue3()
getDescription()
Returns: String
Short label describing this goal type. Always returns the fixed string "SalesRecordCreatedGoal".
getNextNodeId()
Returns: String
Id of the funnel node to advance to when this goal matches.
getSeriesName()
Returns: String
Name of the sales data series a matching record must belong to.
getCustomFieldName1()
Returns: String
Name of the first sales record custom field to check when matching, or blank if this constraint is not configured.
getCustomFieldValue1()
Returns: String
Value the first custom field must equal for a record to match; if left blank, the field on the record must also be blank.
getCustomFieldName2()
Returns: String
Name of the second sales record custom field to check when matching, or blank if this constraint is not configured.
getCustomFieldValue2()
Returns: String
Value the second custom field must equal for a record to match; if left blank, the field on the record must also be blank.
getCustomFieldName3()
Returns: String
Name of the third sales record custom field to check when matching, or blank if this constraint is not configured.
getCustomFieldValue3()
Returns: String
Value the third custom field must equal for a record to match; if left blank, the field on the record must also be blank.