ActivationPlatform

Represents the ActivationPlatform configuration, such as platform name, delivery schedule, output format, and destination folder.

This type extends Metadata and inherits its fields.

ActivationPlatform components have the suffix .activationPlatform and are stored in the activationPlatforms folder.

Introduced in API version 54.0.

There are no additional access requirements that are specific to this type.

• Type: ActivationFlowType (enumeration of type string)
• Required: No

• Type: string
• Required: No
• Description: Provides additional details about the activation platform, including subscriber override options, partner supported IDs, and file output properties such as maximum file size, compression settings, and the maximum number of records per file.

• Type: ActivationPlatformConnectorType (enumeration of type string)
• Required: No
• Description: Reserved for future use.

• Type: ActivationPlatformCreationType (enumeration of type string)
• Required: No

• Type: string
• Required: No
• Description: Reference to the ActvPfrmDataConnectorS3 metadata type, which contains S3 bucket and export directory information into which writes data.

• Type: string

• Required: Yes

• Description: Required.

  The description for ActivationPlatform.

• Type: boolean

• Required: Yes

• Description: Required.

  Indicates whether the ActivationPlatform is enabled (true) or not (false). The default is false.

• Type: boolean
• Required: No
• Description: Indicates whether to include the segment name in metadata (true) or not (false).

• Type: string
• Required: No
• Description: URL of the logo for the activation channel destination.

• Type: string

• Required: Yes

• Description: Required.

  The name for the activation channel destination.

• Type: string
• Required: No
• Description: Notes for this ActivationPlartform.

• Type: ActivationPlatformFileOutputFormat (enumeration of type string)

• Required: Yes

• Description: Required.

  The output format of the file.

• Possible values:

  • CSV
  • JSON
  • PARQUET

• Type: ActivationPlatformFileOutputGrouping (enumeration of type string)

• Required: Yes

• Description: Required.

  The grouping of the output.

• Possible values:

  • PER_ACCOUNT
  • PER_SEGMENT
  • PER_USER

• Type: ActivationPlatformPeriodicFullRefresh (enumeration of type string)
• Required: No
• Description: The frequency (in days) for periodic full refreshes when using incremental refresh mode.
• Possible values:
  • REFRESH_30
  • REFRESH_60

• Type: ActivationPlatformProcessingType (enumeration of type string)
• Required: No

• Type: ActivationPlatformType (enumeration of type string)

• Required: Yes

• Description: Required.

  The type of the Activation Platform.

• Possible values:

  • Advertising
  • Analytics
  • Marketing
  • Publishing
  • Technology

• Type: ActivationPlatformRefreshFrequency (enumeration of type string)

• Required: Yes

• Description: Required.

  Indicates how often the activation platform accepts data delivery.

  Valid value is:

• Possible values:

  • TWENTY_FOUR

• Type: ActivationPlatformRefreshMode (enumeration of type string)

• Required: Yes

• Description: Required.

  Defines how the refresh method handles refreshing files.

• Possible values:

  • FULL
  • INCREMENTAL

The following is an example of an ActivationPlatform component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ActivationPlatform xmlns="http://soap.sforce.com/2006/04/metadata">
3    <dataConnector>S3Connector</dataConnector>
4    <description>Activation Platform Description</description>
5    <enabled>false</enabled>
6    <includeSegmentNames>false</includeSegmentNames>
7    <logoUrl>link to logo</logoUrl>
8    <masterLabel>MyExternalPlatform</masterLabel>
9    <notes>Notes about this Platform</notes>
10    <outputFormat>CSV</outputFormat>
11    <outputGrouping>PER_ACCOUNT</outputGrouping>
12    <refreshMode>FULL</refreshMode>
13    <refreshFrequency>TWENTY_FOUR</refreshFrequency>
14    <periodicRefreshFrequecy>NEVER</periodicRefreshFrequecy>
15    <platformType>Advertising</platformType>
16</ActivationPlatform>

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    <fullName>MyActivationPlatform</fullName>
4    <types>
5        <members>APlatform</members>
6        <name>ActivationPlatform</name>
7    </types>
8    <types>
9        <members>AccountIdField</members>
10        <name>ActivationPlatformField</name>
11    </types>
12    <types>
13        <members>S3Connector</members>
14        <name>ActvPfrmDataConnectorS3</name>
15    </types>
16    <types>
17        <members>EmailIdentifier</members>
18        <name>ActvPlatformAdncIdentifier</name>
19    </types>
20    <types>
21        <members>AccountIdFieldValue</members>
22        <name>ActvPlatformFieldValue</name>
23    </types>
24    <version>54.0</version>
25</Package>

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.