Metadata API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
OmniExtTrackingDef
Parent Type
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 |
|
| developerName |
|
| isActive |
|
| masterLabel |
|
| omniExtTrackingDefKey |
|
| omniExtTrackingEventDefs |
|
| trackingFrameworkInformation |
|
| trackingServiceProvider |
|
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 |
|
| description |
|
| developerName |
|
| inclusionRule |
|
| masterLabel |
|
| omniExtTrackingDef |
|
| omniExtTrackingEventDefKey |
|
| payloadTemplate |
|
Declarative Metadata Sample Definition
The following is an example of an OmniExtTrackingDef component.
<?xml version="1.0" encoding="UTF-8"?>
<OmniExtTrackingDef xmlns="http://soap.sforce.com/2006/04/metadata">
<developerName>Purchase_Tracking_Google</developerName>
<isActive>true</isActive>
<masterLabel>Purchase_Tracking_Google</masterLabel>
<trackingFrameworkInformation>{ "id": "GTM-XXXXXXX" }</trackingFrameworkInformation>
<trackingServiceProvider>Google</trackingServiceProvider>
<omniExtTrackingEventDefs>
<componentType>Omniscript</componentType>
<developerName>Purchase_Funnel_Google</developerName>
<inclusionRule></inclusionRule>
<masterLabel>Purchase_Funnel_Google</masterLabel>
<payloadTemplate>
{
"event": "promotionClick",
"ecommerce": {
"promoClick": {
"promotions": [
{
"name": "%BusinessEvent%"
}
]
}
}
}
</payloadTemplate>
</omniExtTrackingEventDefs>
</OmniExtTrackingDef>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>*</members>
<name>OmniExtTrackingDef</name>
</types>
<version>60.0</version>
</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.