ActvPlatformAdncIdentifier

Represents the information about the identifiers to be activated, such as Email, Phone, Mobile Advertiser (MAID) ID, and Over-the-top (OTT) ID.

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

ActvPlatformAdncIdentifier components have the suffix .actvPlatformAdncIdentifier and are stored in the actvPlatformAdncIdentifiers folder.

Version

ActvPlatformAdncIdentifier 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.Reference to ActivationPlatform.
identifierHashMethod
Field Type
ActivationPlatformIdentifierHashMethod (enumeration of type string)
Description
The hash method of the identifier type. The supported hash method for Email and Phone is SHA256. The supported hash method for MAID and OTT is NONE.
identifierType
Field Type
ActivationPlatformIdentifierType (enumeration of type string)
Description

Required.

The type of identifier to be activated.

Valid values are:

  • EMAIL
  • MAID
  • OTT
  • PHONE
masterLabel
Field Type
string
Description

Required.

The name of the identifier.

Declarative Metadata Sample Definition

The following is an example of an ActvPlatformAdncIdentifier component.

<?xml version="1.0" encoding="UTF-8"?>
<ActvPlatformAdncIdentifier xmlns="http://soap.sforce.com/2006/04/metadata">
    <activationPlatform>APlatform</activationPlatform>
    <identifierHashMethod>SHA256</identifierHashMethod>
    <identifierType>EMAIL</identifierType>
    <masterLabel>EmailIdentifier</masterLabel>
</ActvPlatformAdncIdentifier>

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">
    <fullName>MyActivationPlatform</fullName>
    <types>
        <members>APlatform</members>
        <name>ActivationPlatform</name>
    </types>
    <types>
        <members>EmailIdentifier</members>
        <name>ActvPlatformAdncIdentifier</name>
    </types> 
    <version>54.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.