AppAnalyticsSettings

Represents settings to retrieve AppExchange App Analytics usage data.

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

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

AppAnalyticsSettings values are stored in the AppAnalytics.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

Version 

Introduced in API version 50.0.

Fields 

enableAppAnalyticsEnabled 

  • Type: boolean
  • Required: No

enableAppAnalyticsNamespaceOrgEnabled 

  • Type: boolean
  • Required: No

enableAppAnalyticsOptOut 

  • Type: boolean
  • Required: No
  • Introduced: API version 60.0
  • Description: Indicates whether the collection of AppExchange App Analytics package usage data from this org is disabled (true) or not (false). Default is false.

enableSimulationMode 

  • Type: boolean
  • Required: No
  • Introduced: API version 50.0
  • Description: Indicates whether AppExchange App Analytics simulation mode is enabled (true) or disabled (false). Default is false.

Declarative Metadata Sample Definition 

The following is an example of the AppAnalytics.settings file:

1<?xml version="1.0" encoding="UTF-8"?>
2<AppAnalyticsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3	<enableSimulationMode>true</enableSimulationMode>
4	<enableAppAnalyticsOptOut>false</enableAppAnalyticsOptOut>
5</AppAnalyticsSettings>

Example Package Manifest 

This example package manifest deploys or retrieves AppAnalytics settings metadata.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3	<types>
4 <members>AppAnalytics</members>
5 <name>Settings</name>
6	</types>
7	<version>50.0</version>
8</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.