MarketSegmentDefinition

Represents the field values for MarketSegmentDefinition. MarketSegmentDefinition is used to store the exportable metadata of a segment, such as segment criteria and other attributes. Developers can create segment definition packages, pass segment definition in the form of data build tool (DBT), and publish it on AppExchange for subscriber organizations to install and instantiate these segments.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type

This type extends the Metadata type and inherits its fullName field.

File Suffix and Directory Location

MarketSegmentDefinition components have the suffix .marketSegmentDefinition and are stored in the marketSegmentDefinitions folder.

Version

MarketSegmentDefinition components are available in API version 55.0 and later.

Fields

Field Name	Description
additionalMetadata	Field Type string Description An XML clob to hold name value pairs for storing additional metadata. Not applicable for DBT type segment.
excludeCriteria	Field Type string Description Holds the JSON exclude criteria for UI based segments. Not applicable for DBT or Lookalike segments.
includeCriteria	Field Type string Description An XML wrapped in a CDATA section that captures DBT definition. Only single model DBT is supported.
masterLabel	Field Type string Description Required. Display name of the field value.
segmentOn	Field Type string Description Required when segmentType is `UI`. Points to relevant MktDataModelObject entity instance. Must be a valid developerName for an MktDataModelObject instance of Profile type.
segmentType	Field Type MarketSegmentType (enumeration of type string) Description Required. Type of the segment to be created. Only DBT is supported via API. Values are: `DBT` `Lookalike` `UI`

Declarative Metadata Sample Definition

The following is an example of a MarketSegmentDefinition component.

1<?xml version="1.0" encoding="UTF-8"?>
2<MarketSegmentDefinition>
3    <segmentType>DBT</segmentType>
4    <includeCriteria>
5    <![CDATA[
6        <DbtPipeline>
7            <models>
8                <model>
9                    <name>m1</name>
10                    <sql>select ssot__Individual__dlm.ssot__Id__c from ssot__Individual__dlm</sql>
11                </model>
12            </models>
13        </DbtPipeline>
14        ]]>
15    </includeCriteria>
16    <masterLabel>msd2_simple</masterLabel>
17</MarketSegmentDefinition>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
2<ns2:Package xmlns:ns2="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>MarketSegmentDefinition</name>
6    </types>
7    <version>55.0</version>
8</ns2:Package>

Wildcard Support in the Manifest File

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide