ActivationPlatform | Metadata API Developer Guide

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

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

Version

ActivationPlatform components are available in API version 54.0 and later.

Special Access Rules

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

Fields

Field Name	Description
dataConnector	Field Type string Description Reference to the ActvPfrmDataConnectorS3 metadata type, which contains S3 bucket and export directory information into which Customer Data Platform writes data.
description	Field Type string Description Required. The description for ActivationPlatform.
enabled	Field Type boolean Description Required. Indicates if ActivationPlatform is enabled (`true`) or not (`false`). The default is false.
includeSegmentNames	Field Type boolean Description Indicates whether to include the segment name in metadata (`true`) or not (`false`).
logoUrl	Field Type string Description URL of the logo for the activation channel destination.
masterLabel	Field Type string Description Required. The name for the activation channel destination.
notes	Field Type string Description Notes for this ActivationPlartform.
outputFormat	Field Type ActivationPlatformFileOutputFormat (enumeration of type string) Description Required. The output format of the file. Valid values are: `CSV` `JSON` `PARQUET`
outputGrouping	Field Type ActivationPlatformFileOutputGrouping (enumeration of type string) Description Required. The grouping of the output. Valid values are: `PER_ACCOUNT` `PER_SEGMENT`
periodicRefreshFrequecy	Field Type ActivationPlatformPeriodicFullRefresh (enumeration of type string) Description Reserved for internal use.
platformType	Field Type ActivationPlatformType (enumeration of type string) Description Required. The type of the Activation Platform. Valid values are: `Advertising` `Analytics` `Marketing` `Publishing` `Technology`
refreshFrequency	Field Type ActivationPlatformRefreshFrequency (enumeration of type string) Description Required. Indicates how often the activation platform accepts data delivery. Valid value is: `TWENTY_FOUR`
refreshMode	Field Type ActivationPlatformRefreshMode (enumeration of type string) Description Required. Defines how the refresh method handles refreshing files. Valid values are: `FULL` `INCREMENTAL`

Declarative Metadata Sample Definition

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>

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.