FilterDefinition
Core library FilterDefinition — create and manage data filter definitions for lists or Data Extensions.
FilterDefinition manages filter definitions used for audiences and queries. DataSource.Type must be "SubscriberList" or "DataExtension". The Filter property accepts simple or compound filter structures.
Requires Platform.Load("core", "1.1.5") before use.
Methods
| Method | Returns | Description |
|---|---|---|
FilterDefinition.Init(key) |
FilterDefinitionInstance | Bind by external key |
FilterDefinition.Add(properties) |
string | Create a filter definition |
FilterDefinition.Retrieve(filter) |
object[] | Query definitions |
<FilterDefinitionInstance>.Update(properties) |
string | Update the initialized definition |
<FilterDefinitionInstance>.Remove() |
string | Delete the definition |
FilterDefinition.Init
Initializes a FilterDefinition instance for the given external key.
Syntax
FilterDefinition.Init(key)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
key |
string | Yes | External key |
Return value
FilterDefinitionInstance
Examples
Platform.Load("core", "1");
var fd = FilterDefinition.Init("myFilterDef");
FilterDefinition.Add
Creates a new filter definition with the specified properties.
Syntax
FilterDefinition.Add(properties)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
properties |
object | Yes | Name, CustomerKey, Filter, DataSource, … |
Return value
"OK" on success.
Examples
Platform.Load("core", "1.1.5");
var filterObj = { Property: "LuckyNumber", SimpleOperator: "equals", Value: 77 };
var newFD = {
Name: "SSJS Filter Definition",
CustomerKey: "myFilterDef",
Filter: filterObj,
DataSource: { Type: "SubscriberList", CustomerKey: "example_list_key" }
};
var status = FilterDefinition.Add(newFD);
FilterDefinition.Retrieve
Queries filter definitions matching the given filter criteria.
Syntax
FilterDefinition.Retrieve(filter)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
filter |
object | Yes | WSProxy-style filter |
Return value
object[]
Examples
Platform.Load("core", "1.1.5");
var results = FilterDefinition.Retrieve({
Property: "CustomerKey",
SimpleOperator: "equals",
Value: "myFilterDef"
});
<FilterDefinitionInstance>.Update
Updates the initialized filter definition with the given properties.
Syntax
<FilterDefinitionInstance>.Update(properties)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
properties |
object | Yes | Attributes to change |
Return value
"OK" on success.
Examples
Platform.Load("core", "1.1.5");
var fd = FilterDefinition.Init("myFilterDef");
var status = fd.Update({ Name: "Updated Name" });
<FilterDefinitionInstance>.Remove
Removes the initialized filter definition.
Syntax
<FilterDefinitionInstance>.Remove()
Return value
"OK" on success.
Examples
Platform.Load("core", "1.1.5");
var myFD = FilterDefinition.Init("myFilterDef");
myFD.Remove();