Metadata API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
PrivacySettings
In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for details.
File Suffix and Directory Location
PrivacySettings values are stored in the Privacy.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.
Version
PrivacySettings components are available in API version 47.0 and later.
Special Access Rules
To use PrivacySettings, you need the Customize Application or Modify Data Classification user permission.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| enableConsentAuditTrail | boolean | Reserved for future use. |
| enableConsentEventStream | boolean | Allows orgs to stream consent changes to the party data model via platform events. This field has a default value of false. Available in API version 47.0 and later. |
| enableDefaultMetadataValues | boolean | Indicates whether a default data sensitivity value is applied to all contacts, leads, person accounts, and users (true) or not (false). This field has a default value of false. Available in API version 47.0 and later. |
| useUmaDefaultConsentRecs | boolean | Indicates whether a Preference Manager setup in Privacy Center uses default Marketing Cloud consent parameters and features. This field has a default value of false. Available in API version 58.0 and later. |
Declarative Metadata Sample Definition
The following is an example of a PrivacySettings component.
<?xml version="1.0" encoding="UTF-8"?>
<PrivacySettings xmlns="http://soap.sforce.com/2006/04/metadata">
<enableDefaultMetadataValues>false</enableDefaultMetadataValues>
</PrivacySettings>The following is an example package.xml that references the previous definition.
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>Privacy</members>
<name>Settings</name>
</types>
<version>47.0</version>
</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.