この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

ArticleType CustomField

記事タイプカスタム項目に関連付けられたメタデータを表します。記事タイプカスタム項目の定義を作成、更新、または削除するには、このメタデータ型を使用します。

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

カスタム項目を作成または更新するときには必ず完全名を指定します。たとえば、カスタムオブジェクトのカスタム項目は次のように表されます。

1MyArticleType__kav.MyCustomField__c

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

カスタム項目は記事タイプの一部として定義されます。ArticleType 項目名にはその他のカスタムオブジェクトと同様に __c サフィックスを使用し、属する記事タイプの名前を使ってドット修飾する必要があります。詳細は、「ArticleType」を参照してください。

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

カスタムオブジェクトまたは標準オブジェクトを取得するとき、そのオブジェクトに関連付けられるものすべてが返されます。ただし、package.xml で明示的にオブジェクトと項目の名前を指定することによって、オブジェクトのカスタム項目のみを取得することもできます。package.xml 内の次の定義は、それぞれに 1 つのカスタム項目の定義を含む、objects/MyCustomObject__c.object、objects/Account.object__c.object、および objects/MyArticleType__kav.object ファイルを取得します。

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

バージョン

ArticleType カスタム項目は、API バージョン 19.0 以降で使用できます。

ArticleType の項目

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

ナレッジ入力規則を作成する場合、項目の横に追加しても、エラーは常にページの上部に表示されます。そのため、著者が入力規則を満たす方法がわかるようなエラーメッセージを作成します。たとえば、エラーの原因となっている項目を示します。Salesforce Classic のユーザインターフェースでは、記事の項目レベルのエラーメッセージはサポートされません。

メモ

項目名	データ型	説明
defaultValue	string	指定されている場合、項目のデフォルト値を表します。
deleteConstraint	DeleteConstraint (string 型の列挙)	参照関係の削除オプションを提供します。有効な値は、次のとおりです。 `SetNull` これはデフォルトです。参照レコードが削除されると、参照項目は消去されます。 `Restrict` レコードが参照関係にある場合に、そのレコードが削除されないように防止します。 `Cascade` 参照レコードも関連付けられた参照項目も削除します。参照関係についての詳細は、Salesforce ヘルプの「オブジェクトリレーション」を参照してください。
description	string	項目の説明。
formula	string	指定されている場合、項目の数式を表します。
formulaTreatBlankAs	TreatBlanksAs (string 型の列挙)	数式内の空白の処理方法を示します。有効な値は、`BlankAsBlank` および `BlankAsZero` です。
fullName	string	Metadata から継承されるこの項目は、このメタデータ型の WSDL では定義されません。作成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「`create()`」を参照してください。この値は `null` にできません。
inlineHelpText	string	項目レベルのヘルプの内容を表します。詳細は、Salesforce ヘルプの「項目レベルのヘルプの定義」を参照してください。
label	string	項目の表示ラベル。[記事タイプ] の標準項目の [タイトル]、[URL 名]、[概要] などの表示ラベルを更新することはできません。
length	int	項目の長さ。
picklist	Picklist (連動選択リストを含む)	(非推奨。この項目は API バージョン 37.0 以前でのみ使用してください。それ以降のバージョンでは、代わりに valueSet を使用してください。指定されている場合、項目は選択リストで、この項目は選択リスト値および表示ラベルを列挙します。
referenceTo	string	指定されている場合、この項目に含まれる別のオブジェクトへの参照を示します。
relationshipLabel	string	リレーションの表示ラベル。
relationshipName	string	指定されている場合、一対多のリレーションの値を示します。たとえば、YourObject へのリレーションを持っていた MyObject オブジェクトでは、そのリレーション名は YourObjects となります。
required	boolean	作成時に項目への値の入力が必須であるか (`true`)、否か (`false`) を示します。
type	FieldType	必須。項目のデータ型を示します。有効な値は、次のとおりです。 `Checkbox` (バージョン 30.0 以降で使用可能) `Currency` `ArticleCurrency` `Date` `DateTime` `Email` `File` `Formula` `Html` `Lookup` `Number` `Percent` `Phone` `Picklist` `DependentPicklist` `MultiselectPicklist` `Text` `TextArea` `LongTextArea` `URL`
visibleLines	int	項目に表示される線の数を示します。

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

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        <label>Comments</label>
8        <length>32000</length>
9        <type>LongTextArea</type>
10        <visibleLines>30</visibleLines>
11        </fields>
12        ....
13        </CustomObject>

メタデータ API 開発者ガイド