Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

OmniExtTrackingDef

Represents a connection between an OmniTrackingGroup in OmniAnalytics and a third-party Analytics system such as Google Analytics.

This metadata type is part of Omnistudio Standard, not Omnistudio for Vlocity.

Note

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

Parent Type

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

File Suffix and Directory Location

OmniExtTrackingDef components have the suffix .OmniExtTrackingDef and are stored in the OmniExtTrackingDefs folder.

Version

OmniExtTrackingDef components are available in API version 60.0 and later.

Special Access Rules

Using OmniAnalytics requires having an Omnistudio license and enabling OmniAnalytics in Setup.

Fields

Field Name	Description
description	Field Type string Description A description of the OmniExtTrackingDef.
developerName	Field Type string Description Required. The unique name of the OmniExtTrackingDef in the API. This name can contain only underscores and alphanumeric characters and must be unique in your organization. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. Limit: 80 characters. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. Note
isActive	Field Type boolean Description Required. Specifies whether the OmniExtTrackingDef is active.
masterLabel	Field Type string Description Required. The unique master label of the OmniExtTrackingDef. This internal label doesn’t get translated.
omniExtTrackingDefKey	Field Type string Description A UUID generated internally by Salesforce to uniquely identify an OmniExtTrackingDef record across all orgs.
omniExtTrackingEventDefs	Field Type OmniExtTrackingEventDef[] Description The OmniExtTrackingEventDef objects related to this OmniExtTrackingDef.
trackingFrameworkInformation	Field Type string Description Required. JSON data containing information about an external service, such as the API call and input parameter names.
trackingServiceProvider	Field Type ExternalTrackingVendor (enumeration of type string) Description Required. The third-party Analytics system to which user interaction data is sent. Values are: `Google` `Mixpanel`

OmniExtTrackingEventDef

Represents a format for FlexCard or OmniScript user interaction data that a third-party Analytics system such as Google Analytics can accept.

Field Name	Description
componentType	Field Type OmniAnalyticsComponentType (enumeration of type string) Description Required. The type of component for which user interactions are tracked. Values are: `Flexcard` `Omniscript`
description	Field Type string Description A description of the OmniExtTrackingEventDef.
developerName	Field Type string Description Required. The unique name of the OmniExtTrackingEventDef in the API. This name can contain only underscores and alphanumeric characters and must be unique in your organization. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. Limit: 80 characters. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. Note
inclusionRule	Field Type string Description Required. A true-or-false condition that determines whether an event is sent to the third-party Analytics system.
masterLabel	Field Type string Description Required. The unique master label of the OmniExtTrackingEventDef. This internal label doesn’t get translated.
omniExtTrackingDef	Field Type string Description The ID of the related OmniExtTrackingDef object.
omniExtTrackingEventDefKey	Field Type string Description A UUID generated internally by Salesforce to uniquely identify an OmniExtTrackingEventDef record across all orgs.
payloadTemplate	Field Type string Description Required. The payload template structure with placeholders for runtime data. This is used at runtime to generate the actual payload to be sent to the external Analytics service.

Declarative Metadata Sample Definition

The following is an example of an OmniExtTrackingDef component.

1<?xml version="1.0" encoding="UTF-8"?>
2<OmniExtTrackingDef xmlns="http://soap.sforce.com/2006/04/metadata">
3    <developerName>Purchase_Tracking_Google</developerName>
4    <isActive>true</isActive>
5    <masterLabel>Purchase_Tracking_Google</masterLabel>
6    <trackingFrameworkInformation>{ "id": "GTM-XXXXXXX" }</trackingFrameworkInformation>
7    <trackingServiceProvider>Google</trackingServiceProvider>
8    <omniExtTrackingEventDefs>
9        <componentType>Omniscript</componentType>
10        <developerName>Purchase_Funnel_Google</developerName>
11        <inclusionRule></inclusionRule>
12        <masterLabel>Purchase_Funnel_Google</masterLabel>
13        <payloadTemplate>
14{
15  "event": "promotionClick",
16  "ecommerce": {
17    "promoClick": {
18      "promotions": [
19        {
20          "name": "%BusinessEvent%"
21        }
22      ]
23    }
24  }
25}
26        </payloadTemplate>
27    </omniExtTrackingEventDefs>
28</OmniExtTrackingDef>

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

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

Industries Common Resources Developer Guide