CustomField

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所

カスタム項目はユーザ定義項目で、カスタムオブジェクトまたは標準オブジェクトの定義の一部です。詳細は、「CustomObject」を参照してください。標準項目は、標準オブジェクトで事前に定義されています。

カスタムオブジェクトまたは標準オブジェクトの項目の取得

カスタムオブジェクトまたは標準オブジェクトを取得するとき、カスタマイズできない標準項目を除き、そのオブジェクトに関連付けられるものすべてが返されます。package.xml で明示的にオブジェクトと項目の名前を指定することによって、オブジェクトの特定の項目のみを取得することもできます。package.xml の次の定義では、それぞれ要求された項目定義を含む、objects/MyCustomObject__c.object ファイルと objects/Account.object ファイルを作成します。

1<types>
2  <members>MyCustomObject__c.MyCustomField__c</members>
3  <members>Account.MyCustomAccountField__c</members>
4  <members>Account.Phone</members>
5  <name>CustomField</name>
6</types>

バージョン

カスタム項目および標準項目は API バージョン 10.0 以降で使用できます。

項目

別途記載がない限り、すべての項目は作成可能、除外可能で、null にすることもできます。

項目は、追加のデータ型を使用します。詳細は、「メタデータのデータ型」を参照してください。

EncryptedFieldMaskChar

このデータ型は、maskChar で使用されます。asterisk または X という 2 つの有効な値を持つ文字列です。暗号化項目についての詳細は、Salesforce オンラインヘルプの「カスタム項目の従来の暗号化」を参照してください。

EncryptedFieldMaskType

このデータ型は、maskType で使用されます。有効な値は、次のとおりです。

all

項目内のすべての文字が非表示になります。このオプションは、Salesforce の [すべての文字をマスク] オプションと同等です。

creditCard

最初の 12 桁が非表示になり、最後の 4 桁が表示されます。このオプションは、Salesforce の [クレジットカード番号] オプションと同等です。

ssn

最初の 5 桁が非表示になり、最後の 4 桁が表示されます。このオプションは、Salesforce の [社会保障番号] オプションと同等です。

lastFour

最後の 4 桁を除くすべての文字が非表示になります。このオプションは、Salesforce の [最後の 4 桁を表示] オプションと同等です。

sin

最後の 4 桁を除くすべての文字が非表示になります。このオプションは、Salesforce の [社会保険番号] オプションと同等です。

nino

すべての文字が非表示になります。項目が 9 桁の場合は、各ペアの文字の後にスペースが自動的に挿入されます。このオプションは、Salesforce の [国民保険番号] オプションと同等です。

暗号化項目についての詳細は、Salesforce オンラインヘルプの「カスタム項目の従来の暗号化」を参照してください。

LookupFilter

ルックアップ検索条件に関連付けられたメタデータを表します。API バージョン 30.0 で削除された NamedFilter コンポーネントにこれが置き換わります。LookupFilter は、API バージョン 30.0 以降で使用できます。

ルックアップ検索条件は、追加のデータ型を使用します。詳細は、「メタデータのデータ型」を参照してください。

FilterItem

一連の検索条件の 1 つのエントリを表します。

FilterOperation

これは、さまざまな絞り込み操作をリストする string 型の列挙です。有効な値は、次のとおりです。

SummaryOperations

summaryOperation のデータ型を表します。有効な値は、次のとおりです。

• Count
• Min
• Max
• Sum

宣言的なメタデータの定義のサンプル

次の例は、Comments__c という名前のカスタム項目の項目定義を示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
3....
4<fields>
5        <fullName>Comments__c</fullName>
6        <description>Add your comments about this object here</description>
7        <inlineHelpText>This field contains help text for this object</inlineHelpText>
8        <label>Comments</label>
9        <length>32000</length>
10        <type>LongTextArea</type>
11        <visibleLines>30</visibleLines>
12</fields>
13....
14</CustomObject>

次の Account 標準オブジェクトの 2 つの項目の定義を示します。1 つはカスタム項目 (MyCustomAccountField__c)、もう 1 つは履歴追跡が有効になっている標準項目 (Phone) です。

1<?xml version="1.0" encoding="UTF-8"?>
2<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
3    <fields>
4        <fullName>MyCustomAccountField__c</fullName>
5        <description>A custom field on the Account standard object.</description>
6        <externalId>false</externalId>
7        <inlineHelpText>Some help text.</inlineHelpText>
8        <label>MyCustomAccountField</label>
9        <length>100</length>
10        <required>false</required>
11        <trackFeedHistory>false</trackFeedHistory>
12        <trackHistory>false</trackHistory>
13        <type>Text</type>
14        <unique>false</unique>
15    </fields>
16    <fields>
17        <fullName>Phone</fullName>
18        <trackFeedHistory>false</trackFeedHistory>
19        <trackHistory>true</trackHistory>
20    </fields>
21</CustomObject>