Mapp Engage

construct

const mappEngageData = new MappIntelligenceEngage();

setAttributes

Replaces all attributes set before. Values are sent as text; empty strings, NaN, Infinity and values that are no string, number, boolean or bigint (e.g. null, objects) are dropped.

/**
 * @param a Sends user-specific data to Mapp Engage, which can be stored as Custom Profile Attributes.
 * These attributes can be created and managed in Engage.
 *
 * @return MappIntelligenceEngage
 */
mappEngageData.setAttributes(a: {[key: string]: string|number|boolean|bigint});

addAttributes

Adds the attributes to the ones set before (an existing key is overwritten). The same values are dropped as with setAttributes().

/**
 * @param a Sends user-specific data to Mapp Engage, which can be stored as Custom Profile Attributes.
 * These attributes can be created and managed in Engage.
 *
 * @return MappIntelligenceEngage
 */
mappEngageData.addAttributes(a: {[key: string]: string|number|boolean|bigint});

setEventName

/**
 * @param e Defines the name of the Engage Custom Web Event (e.g. "Size Finder Used"). This can trigger automations in the Whiteboard.
 *
 * @return MappIntelligenceEngage
 */
mappEngageData.setEventName(e: string);

setEventId

/**
 * @param e Alternative to eventName. Refers to the Engage Custom Web Event ID as defined in Engage. Mostly used for advanced setups.
 *
 * @return MappIntelligenceEngage
 */
mappEngageData.setEventId(e: number);

const mic = new MappIntelligenceConfig(
	"111111111111111",
	"analytics01.wt-eu02.net"
);
const mit = new MappIntelligenceTracking(mic);

const mappEngageData = new MappIntelligenceEngage();
mappEngageData.setAttributes({ 'engage.attribute.fittingToolUsed': "true" })
	.setEventName("Virtual Fitting Room Used")
	.setEventId(12345);

await mit.track((new MappIntelligenceDataMap()).engage(mappEngageData));
await mit.close();

construct

const mappRegistrationData = new MappIntelligenceRegistration();

setEmail

/**
 * @param e The Email address used to identify the user in Mapp Engage.
 *
 * @return MappIntelligenceRegistration
 */
mappRegistrationData.setEmail(e: string);

setGroupId

/**
 * @param g Provide the group ID in case of a new registration for the user in Mapp Engage.
 *
 * @return MappIntelligenceRegistration
 */
mappRegistrationData.setGroupId(g: string);

setMode

/**
 * @param m Provide the registration method used to register for marketing activities.
 *
 * @return MappIntelligenceRegistration
 */
mappRegistrationData.setMode(m: string);

setFirstName

/**
 * @param f First name of the user to be used in Mapp Engage.
 *
 * @return MappIntelligenceRegistration
 */
mappRegistrationData.setFirstName(f: string);

setLastName

/**
 * @param l Last name of the user to be used in Mapp Engage.
 *
 * @return MappIntelligenceRegistration
 */
mappRegistrationData.setLastName(l: string);

setGender

/**
 * @param g Gender of the user.
 *
 * @return MappIntelligenceRegistration
 */
mappRegistrationData.setGender(g: string);

setTitle

/**
 * @param t The title of the user to be used in Mapp Engage.
 *
 * @return MappIntelligenceRegistration
 */
mappRegistrationData.setTitle(t: string);

setOptIn

Only with true the registration fields (email, group ID, mode, name, gender, title, ISO code, ISO language, time zone) are sent.

/**
 * @param o Provide information that the user consented to use their data.
 *
 * @return MappIntelligenceRegistration
 */
mappRegistrationData.setOptIn(o: boolean);

setIsoCode

Two-letter ISO 3166-1 country code, e.g. DE.

/**
 * @param i The ISO code (country) of the user to be used in Mapp Engage
 *
 * @return MappIntelligenceRegistration
 */
mappRegistrationData.setIsoCode(i: string);

setIsoLanguage

Two-letter ISO 639-1 language code, e.g. de.

/**
 * @param i The ISO language of the user to be used in Mapp Engage
 *
 * @return MappIntelligenceRegistration
 */
mappRegistrationData.setIsoLanguage(i: string);

setTimezone

IANA time zone name, e.g. Europe/Berlin.

/**
 * @param t The time zone of the user to be used in Mapp Engage
 *
 * @return MappIntelligenceRegistration
 */
mappRegistrationData.setTimezone(t: string);

const mic = new MappIntelligenceConfig(
    "111111111111111",
    "analytics01.wt-eu02.net"
);
const mit = new MappIntelligenceTracking(mic);

const mappRegistrationData = new MappIntelligenceRegistration();
mappRegistrationData.setEmail('john@doe.com')
    .setGroupId('abc123')
    .setMode('c')
    .setFirstName('John')
    .setLastName('Doe')
    .setGender('m')
    .setTitle('Professor')
    .setIsoCode('DE')
    .setIsoLanguage('de')
    .setTimezone('Europe/Berlin')
    .setOptIn(true);

await mit.track((new MappIntelligenceDataMap()).registration(mappRegistrationData));
await mit.close();