DataExtension.Fields
After DataExtension.Init — add fields, retrieve field definitions, update the sendable field mapping.
Use DataExtension.Init first, then de.Fields to manage columns: add fields, list definitions, or change which field maps to subscribers for sendable DEs.
Requires Platform.Load("core", "1.1.5") before use.
Methods
| Method | Returns | Description |
|---|---|---|
<DataExtensionInstance>.Fields.Add(properties) |
string | Add a column |
<DataExtensionInstance>.Fields.Retrieve() |
object[] | Field definitions |
<DataExtensionInstance>.Fields.UpdateSendableField(deFieldName, subscriberField) |
string | Map DE field to subscriber attribute |
<DataExtensionInstance>.Fields.Add
Adds a new column to the initialized Data Extension. properties.Name is required; FieldType accepts values such as 'Boolean', 'Date', 'Decimal', 'EmailAddress', 'Locale', 'Number', 'Phone', 'Text'.
Syntax
<DataExtensionInstance>.Fields.Add(properties)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
properties |
object | Yes | Field definition (Name, CustomerKey, FieldType, MaxLength, …) |
Return value
"OK" on success.
Examples
Platform.Load("core", "1.1.5");
var de = DataExtension.Init("SSJSTest");
var newField = {
Name: "NewFieldV2",
CustomerKey: "CustomerKey",
FieldType: "Number",
IsRequired: true,
DefaultValue: "100"
};
var status = de.Fields.Add(newField);
<DataExtensionInstance>.Fields.Retrieve
Returns field metadata for all columns in this Data Extension.
Syntax
<DataExtensionInstance>.Fields.Retrieve()
Return value
object[] — field metadata for this Data Extension.
Examples
Platform.Load("core", "1.1.5");
var birthdayDE = DataExtension.Init("birthdayDE");
var fields = birthdayDE.Fields.Retrieve();
<DataExtensionInstance>.Fields.UpdateSendableField
Updates which DE column relates the extension to All Subscribers for sending. subscriberField is "Subscriber Key" or "Subscriber Id".
Syntax
<DataExtensionInstance>.Fields.UpdateSendableField(deFieldName, subscriberField)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
deFieldName |
string | Yes | Data extension field name to use for the relationship |
subscriberField |
string | Yes | "Subscriber Key" or "Subscriber Id" |
Return value
"OK" on success (or throws on failure).
Examples
Platform.Load("core", "1.1.5");
var updateDE = DataExtension.Init("sendableDataExtension");
var status = updateDE.Fields.UpdateSendableField("DifferentSubKey", "Subscriber Key");