ActivationPlatformField | 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

ActivationPlatformField components have the suffix .activationPlatformField and are stored in the activationPlatformFields folder.

Version

ActivationPlatformField 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
activationPlatform	Field Type string Description Required. Reference to the ActivationPlatform metadata type.
helpText	Field Type string Description Information about ActivationPlatformField.
isHidden	Field Type boolean Description Required. Indicates whether ActivationPlatformField can be overridden by marketer (`false`) or not (`true`). The default is false. Field can’t be overridden by marketer when set to `true`.
isRequired	Field Type boolean Description Required. Indicates whether this ActivationPlatformField is required (`true`) or not (`false`). The default is false.
masterLabel	Field Type string Description Required. The name of the ActivationPlaformField.
type	Field Type ActivationPlatformFieldDataType (enumeration of type string) Description Represents the datatype of the field. Valid value is: `Text`

Declarative Metadata Sample Definition

The following is an example of an ActivationPlatformField component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ActivationPlatformField xmlns="http://soap.sforce.com/2006/04/metadata">
3    <activationPlatform>APlatform</activationPlatform>
4    <isHidden>false</isHidden>
5    <isRequired>true</isRequired>
6    <masterLabel>AccountId</masterLabel>
7</ActivationPlatformField>

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    <version>54.0</version>
13</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.