Newer Version Available

This content describes an older version of this product. View Latest

PardotSettings

Represents Pardot settings in your Salesforce org. Pardot is a powerful B2B marketing automation solution that helps you create meaningful connections, generate more pipeline, and empower sales to close more deals. You can use these settings to configure how Pardot collects and displays data.This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for more details.

File Suffix and Directory Location

PardotSettings is stored in one file named Pardot.Settings in the settings folder of the corresponding package directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

Version

PardotSettings is available in API version 47.0 and later.

Special Access Rules

This metadata type is available only to accounts with Pardot.

Fields

Field Name Field Type Description
enableB2bmaAppEnabled boolean This feature is deprecated and isn’t used.
enableEngagementHistoryDashboards boolean Enable the Engagement History Dashboard and allow related Pardot data to be shared to campaign records in Salesforce (true) or not (false). The default value is false. If enableEnagementHistoryDashboards is disabled after being enabled, the Engagement History Dashboard is removed, but Pardot engagement data is retained and continues to update.
enableEnhancedProspectCustomFieldsSync boolean Enable Object Sync for Pardot to enhance with B2B Marketing Analytics or B2B Marketing Analytics Plus (true) or not (false). The default value is false. Available in API version 52.0 and later.
enablePardotAppV1Enabled boolean Enable the Pardot Lightning App (true) or not (false). The default value is false.
enablePardotEnabled boolean Enable the Pardot Marketing Automation Pilot including Social Search (true) or not (false). The default value is false. This feature is deprecated and isn’t used.
enablePardotObjectSync boolean Deprecated. Enable Object Sync for Pardot to enhance with B2B Marketing Analytics or B2B Marketing Analytics Plus (true) or not (false). The default value is false. Available in API version 50.0 and later.
enableProspectActivityDataset boolean Enable the Prospect and Activity Dataset for B2B Marketing Automation apps (true) or not (false). When enableProspectActivityDataset is set to true, the datasets take some time to populate. Depending on how much data and what kind of licenses you have, enabling this preference can impact the account’s row limit for Analytics.

If enableProspectActivityDataset is disabled after being enabled:

  • The data that makes up the datasets is deleted.
  • The Prospect and Activity Dataset in existing B2B Marketing Automation apps stops getting updates.
  • The dataset isn’t available to add to new apps.
  • When apps are reconfigured, the dataset is deleted.
Requires that enableEnagementHistoryDashboards is set to true.

Declarative Metadata Sample Definition

The following is an example of a PardotSettings component.

11 <?xml version="1.0" encoding="UTF-8"?>
22 <PardotSettings xmlns="http://soap.sforce.com/2006/04/metadata">
33     <enablePardotEnabled>true</enablePardotEnabled>
44     <enablePardotAppV1Enabled>true</enablePardotAppV1Enabled>
55     <enableB2bmaAppEnabled>true</enableB2bmaAppEnabled>
66     <enableEngagementHistoryDashboards>true</enableEngagementHistoryDashboards>
77     <enableEnhancedProspectCustomFieldsSync>true</enableEnhancedProspectCustomFieldsSync>
88     <enablePardotObjectSync>true</enablePardotObjectSync>
99     <enableProspectActivityDataset>true</enableProspectActivityDataset>
1010     <enableAIOptimizedSendTime>true</enableAIOptimizedSendTime>
1111 </PardotSettings>

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

11 <?xml version="1.0" encoding="UTF-8"?>
22 <Package xmlns="http://soap.sforce.com/2006/04/metadata">
33     <types>
44         <members>Pardot</members>
55         <name>Settings</name>
66     </types>
77     <version>47</version>
88 </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.