MarketingAppExtension | Metadata API Developer Guide

Parent Type

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

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

File Suffix and Directory Location

MarketingAppExtension components have the suffix .marketingappextension and are stored in the marketingappextensions folder.

Version

MarketingAppExtension components are available in API version 54.0 and later.

Special Access Rules

The first Salesforce or designated marketing admin to access Marketing App Extensions in an org must have the Manage Public List Views user permission. Subsequent users don’t need the permission to work with the feature.

Fields

Field Name	Description
description	Field Type string Description The description of the extension for internal reference. Appears in the UI.
isActive	Field Type boolean Description This field makes data for a Marketing App Extension available to use in Pardot automations. Label is Active in Automations. The default value is `false`. Appears in the UI.
isProtected	Field Type boolean
marketingAppExtActivities	Field Type MarketingAppExtActivity[] Description This is a related list of associated external prospect activities.
masterLabel	Field Type string Description Required. Label for the MarketingAppExtension. In the UI, this field is Extension Name.

MarketingAppExtActivity

Represents an Activity Type, which is a prospect activity that occurs in a third-party app and can be used in Pardot automations.

Field Name	Description
description	Field Type string Description The description of the activity for internal reference. Appears in the UI.
endpointUrl	Field Type string Description A sample endpoint that can be used to help connect the activity type to a third-party app. Appears in the UI.
isActive	Field Type boolean Description This field makes data for the Activity Type available to use in Pardot automations. Label is Active in Automations. The default value is `false`. Appears in the UI.
isProtected	Field Type boolean
marketingAppExtension	Field Type string Description Required. The Marketing App Extension associated with the activity.
masterLabel	Type string Description Required. Label for the MarketingAppExtActivity. In the UI, this field is Activity Name.

Declarative Metadata Sample Definition

The following is an example of a MarketingAppExtension component that retrieves all Activity Types associated with the extension.

1<?xml version="1.0" encoding="UTF-8"?>
2<MarketingAppExtension xmlns="http://soap.sforce.com/2006/04/metadata">
3    <description>VidLand extension for US region</description>
4    <isActive>true</isActive>
5    <marketingAppExtActivities>
6        <fullName>user_attended</fullName>
7        <description>User attended activity capture for VidLand</description>
8        <isActive>true</isActive>
9        <marketingAppExtension>VidLand_US</marketingAppExtension>
10        <masterLabel>user attended</masterLabel>
11    </marketingAppExtActivities>
12    <marketingAppExtActivities>
13        <fullName>user_registered</fullName>
14        <description>User registered activity capture for VidLand</description>
15        <isActive>true</isActive>
16        <marketingAppExtension>VidLand_US</marketingAppExtension>
17        <masterLabel>user registered</masterLabel>
18    </marketingAppExtActivities>
19    <masterLabel>VidLand_US</masterLabel>
20</MarketingAppExtension>

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

1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3~ Copyright 2021 Salesforce, Inc.
4~ All Rights Reserved
5~ Company Confidential
6-->
7<Package xmlns="http://soap.sforce.com/2006/04/metadata">
8<types>
9<members>VidLand_US</members>
10<name>MarketingAppExtension</name>
11</types>
12</Package>

The following is an example of a MarketingAppExtension componant that retrieves a specific Activity Type from the associated extension.

1<?xml version="1.0" encoding="UTF-8"?>
2<MarketingAppExtension xmlns="http://soap.sforce.com/2006/04/metadata">
3    <description>VidLand extension for US region</description>
4    <isActive>true</isActive>
5    <marketingAppExtActivities>
6        <fullName>user_attended</fullName>
7        <description>User attended activity capture for VidLand</description>
8        <isActive>true</isActive>
9        <marketingAppExtension>VidLand_US</marketingAppExtension>
10        <masterLabel>user attended</masterLabel>
11    </marketingAppExtActivities>
12    <masterLabel>VidLand_US</masterLabel>
13</MarketingAppExtension>

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

1<<?xml version="1.0" encoding="UTF-8"?>
2<!--
3~ Copyright 2021 salesforce.com, inc.
4~ All Rights Reserved
5~ Company Confidential
6-->
7<Package xmlns="http://soap.sforce.com/2006/04/metadata">
8<types>
9<members>VidLand_US.user_attended</members>
10<name>MarketingAppExtActivity</name>
11</types>
12<types>
13<members>VidLand_US</members>
14<name>MarketingAppExtension</name>
15</types>
16</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.