ObjectSourceTargetMap

Contains the object-level mappings between the source and the target objects. The source and target objects can be an MktDataLakeObject or an MktDataModelObject. For example, an Email source object can be mapped to the ContactPointEmail object.

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 Metadata and inherits its fields.

File Suffix and Directory Location 

ObjectSourceTargetMap components have the suffix .objectSourceTargetMap and are stored in the objectSourceTargetMaps folder.

Version 

Introduced in API version 51.0.

Special Access Rules 

To access this metadata type, you must have the Customize Application user permission.

Fields 

creationType 

  • Type: DefinitionCreationType (enumeration of type string)
  • Required: No
  • Description: Describes whether this object was added by the user or as part of a standard taxonomy.
  • Possible values:
    • ADG
    • Activation_Audience
    • Bridge
    • Calculated_Insight
    • CG_Audience — (Available in API version 62.0 and later)
    • Chunk
    • Curated
    • Custom
    • Derived
    • Directory_Table
    • External
    • Ml_Prediction
    • Segment_Membership
    • Semantic
    • Standard
    • System
    • Transform
    • Vector_Embedding

fieldSourceTargetMaps 

  • Type: FieldSourceTargetMap[]
  • Required: No
  • Description: Contains the field-level mappings associated with this object mapping.

masterLabel 

  • Type: string
  • Required: Yes
  • Description: Required. The UI name for the target map.

sequenceNbr 

  • Type: int
  • Required: No
  • Description: Use this field to display multiple mappings between the same two objects, for a consistent customer experience when presenting the mappings.

sourceObjectName 

  • Type: string
  • Required: Yes
  • Description: Required. Name of the source object that’s mapped, such as Email, or SfmcEnt1_Subscriber.

targetObjectName 

  • Type: string
  • Required: Yes
  • Description: Required. Name of the target object that’s mapped, such as ContactPointEmail or Individual.

FieldSourceTargetMap Type 

Contains the field-level mappings between the source and the target objects.

The source and target can be MktDataLakeField or MktDataModelField.

For example, you can map a Person source object’s field called emailAddress to an Individual target object’s field called emailAddress.

Fields 

creationType 

  • Type: DefinitionCreationType (enumeration of type string)

  • Required: No

  • Description: Describes whether this object was added by the user or as part of a standard taxonomy.

    Values are:

    Valid values available in API version 67.0 and later are:

  • Possible values:

    • ADG
    • Activation_Audience
    • Bridge
    • Calculated_Insight
    • Chunk
    • Curated
    • Custom
    • Derived
    • Directory_Table
    • External
    • Ml_Prediction
    • Segment_Membership
    • Semantic
    • Standard
    • System
    • Transform
    • Vector_Embedding
    • Ad_Audience_Insights
    • Auxiliary
    • Clean_Room
    • Deletion_Records
    • Problem_Records

filterApplied 

  • Type: boolean
  • Required: No
  • Description: Specifies whether the field-level mapping is an event type filter (true) or not (false).

filterOperationType 

  • Type: string (enumeration of type string)

  • Required: No

  • Description: If the field-level mapping is an event type filter, specifies the filtering operator.

    Value is:

  • Possible values:

    • Equal

filterValue 

  • Type: string
  • Required: No
  • Description: If the field-level mapping is an event type filter, specifies the object that contains the event type field.

isSourceFormula 

  • Type: boolean
  • Required: No
  • Description: Specifies whether the source field is a formula (true) or not (false). If true, you must include the sourceFormula value.

sourceField 

  • Type: string
  • Required: Yes
  • Description: Required. The source object field that’s mapped, such as EmailAddr or SfmcEnt1_Subscriber.FName.

sourceFormula 

  • Type: string
  • Required: No
  • Description: A formula, such as concatenation, date function, or constant value.

targetField 

  • Type: string
  • Required: Yes
  • Description: Required. The target object field that’s mapped, such as SfmcEnt1_Email.EmailAddr or Individual.FirstName.