CustomFieldDisplay

Represents the view type assigned to product attribute custom fields.

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 Metadata and inherits its fields.

File Suffix and Directory Location 

CustomFieldDisplay components have the suffix .customFieldDisplay.

Version 

Introduced in API version 63.0.

Fields 

displayType 

  • Type: CustomFieldDisplayType (enumeration of type string)
  • Required: Yes
  • Description: Required. The view type of the product attribute custom fields. Values are:
  • Possible values:
    • ColorSwatch
    • Dropdown
    • Pill

fieldApiName 

  • Type: string
  • Required: Yes
  • Description: Required. The unique name of the product attribute, for example, color_c.

isProtected 

  • Type: boolean
  • Required: No
  • Description: Optional. An auto-generated value that doesn’t impact the behavior of the metadata type. The default value is false.

masterLabel 

  • Type: string
  • Required: Yes
  • Description: Required. The primary label for this object.

Declarative Metadata Sample Definition 

The following is an example of a CustomFieldDisplay component.

1<?xml version="1.0" encoding="UTF-8"?>
2<CustomFieldDisplay xmlns="http://soap.sforce.com/2006/04/metadata">
3	<masterLabel>cfd1</masterLabel>
4	<fieldApiName>Color__c</fieldApiName>
5	<displayType>Pill</displayType>
6	<isProtected>false</isProtected>
7</CustomFieldDisplay>

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	<types>
4	<members>*</members>
5	<name>CustomFieldDisplay</name>
6	</types>
7	<version>63.0</version>
8</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.