メタデータ API 開発者ガイド
jCustomObject
組織に固有のデータを保存するカスタムオブジェクト、または Salesforce の外部に保存されているデータに対応付けられる外部オブジェクトを表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。カスタムオブジェクトを作成または更新するときに関連するすべての項目を指定する必要があります。オブジェクトの単一の項目を更新することはできません。カスタムオブジェクトの詳細については、Salesforce オンラインヘルプの「カスタムオブジェクトの概要」を参照してください。
また、このメタデータ型を使用して、取引先などの標準オブジェクトのカスタマイズを行うこともできます。「標準オブジェクト」の例を参照してください。
すべてのメタデータコンポーネントには fullName 項目があり、すべてのカスタムオブジェクトで完全に指定されている必要があります。
たとえば、標準オブジェクトおよびカスタムオブジェクトの完全に指定された名前はそれぞれ次のようになります。
外部オブジェクトの完全に指定された名前は次のようになります。
カスタムオブジェクトを作成する Java のサンプルコードについては、「ステップ 3: Java サンプルコードの説明」を参照してください。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
カスタムオブジェクト名には、自動的に __c が追加されます。カスタムオブジェクトまたは標準オブジェクトファイルのファイルサフィックスは .object です。
外部オブジェクト名には、自動的に __x が追加されます。外部オブジェクトファイルのファイルサフィックスは、.object です。
カスタムオブジェクト、標準オブジェクト、および外部オブジェクトは、対応するパッケージディレクトリの objects フォルダに保存されます。
バージョン
カスタムオブジェクトは API バージョン 10.0 以降で使用できます。外部オブジェクトは API バージョン 32.0 以降で使用できます。
項目
別途記載がない限り、すべての項目は作成可能、除外可能で、null にすることもできます。
| 項目名 | データ型 | 説明 |
|---|---|---|
| actionOverrides | ActionOverride[] |
オブジェクトの override アクションのリスト。 この項目は API バージョン 18.0 以降で使用できます。 |
| allowInChatterGroups | boolean |
このカスタムオブジェクト種別のレコードを Chatter グループに追加できるかどうかを示します。 この項目は、API バージョン 34.0 以降で使用できます。 |
| businessProcesses | BusinessProcess[] |
オブジェクトに関連付けられたビジネスプロセスのリスト。 この項目は API バージョン 17.0 以降で使用できます。 |
| compactLayoutAssignment | string |
オブジェクトに割り当てられたコンパクトレイアウト。 この項目は API バージョン 29.0 以降で使用できます。 |
| compactLayouts | CompactLayout[] |
オブジェクトに関連付けられたコンパクトレイアウトのリスト。 この項目は API バージョン 29.0 以降で使用できます。 |
| customHelp | string | オブジェクトのヘルプコンテンツがカスタマイズされている場合に、ヘルプコンテンツが含まれる Sコントロール。この項目は、API バージョン 14.0 以降で使用できます。 |
| customHelpPage | string | オブジェクトのヘルプコンテンツがカスタマイズされている場合に、ヘルプコンテンツが含まれる Visualforce ページ。この項目は、API バージョン 16.0 以降で使用できます。 |
| customSettingsType | CustomSettingsType (string 型の列挙) |
この項目が存在する場合、このコンポーネントはカスタムオブジェクトではなくカスタム設定です。この項目はカスタム設定の型を返します。有効な文字列値は次のとおりです。
この項目は API バージョン 17.0 以降で使用できます。 |
| customSettingsVisibility | CustomSettingsVisibility (string 型の列挙) |
この項目が存在する場合、このコンポーネントはカスタムオブジェクトではなくカスタム設定です。この項目はカスタム設定の表示を返します。有効な文字列値は次のとおりです。
この項目は、API バージョン 17.0 から 33.0 で使用できます。バージョン 34.0 以降では、この項目の代わりに visibility 項目を使用します。 |
| deploymentStatus | DeploymentStatus (string 型の列挙) | オブジェクトのリリース状況を示します。 |
| deprecated | boolean | 将来の使用のために予約されています。 |
| description | string | オブジェクトの説明。最大 1000 文字です。 |
| enableActivities | boolean | 活動のオブジェクトが有効になっているか (true)、否か (false) を示します。 |
| enableBulkApi | boolean |
有効な場合、オブジェクトは、利用状況の追跡のための Enterprise Application オブジェクトとして分類されます。 有効な場合、enableSharing および enableStreamingApi も有効にする必要があります。 この項目は API バージョン 31.0 以降で使用できます。 |
| enableDivisions | boolean | ディビジョンのオブジェクトが有効になっているか (true)、否か (false) を示します。ディビジョンオブジェクトについての詳細は、『SOAP API 開発者ガイド』を参照してください。 |
| enableEnhancedLookup | boolean | 高度なルックアップのオブジェクトが有効になっているか (true)、否か (false) を示します。API バージョン 28.0 以降では、この項目を Account、Contact、および User オブジェクトにも使用できます。高度なルックアップにより、ルックアップダイアログインターフェースが更新され、検索結果の絞り込み、並び替え、およびページ操作と検索結果列のカスタマイズが可能になります。高度なルックアップについての詳細は、Salesforce オンラインヘルプの「高度なルックアップの有効化」を参照してください。 |
| enableFeeds | boolean |
フィード追跡のオブジェクトが有効になっているか (true)、否か (false) を示します。詳細は、Salesforce オンラインヘルプの「Chatter フィード追跡のカスタマイズ」を参照してください。
この項目は API バージョン 18.0 以降で使用できます。 |
| enableHistory | boolean | 履歴追跡のオブジェクトが有効になっているか (true)、否か (false) を示します。API バージョン 29.0 以降では標準オブジェクトにも使用できます。 |
| enableReports | boolean | レポートのオブジェクトが有効になっているか (true)、否か (false) を示します。外部オブジェクトは、API バージョン 38.0 以降でサポートされています。 |
| enableSearch | boolean | オブジェクトのレコードが SOSL 検索および Salesforce 検索で検索可能かどうかを示します。ユーザインターフェースの [検索を許可] に対応します。 デフォルトで、新しいカスタムオブジェクトの検索は無効になっています。この項目は API バージョン 35.0 以降のカスタムオブジェクトで使用できます。 デフォルトでは、新規外部オブジェクトの検索は無効になっています。ただし、外部データソースを検証して同期し、自動的に外部オブジェクトを作成することができます。外部データソースの検索が有効になっていると、同期によって常に外部オブジェクトの検索が有効になります (その逆もあります)。この項目は API バージョン 37.0 以降の外部オブジェクトで使用できます。 |
| enableSharing | boolean |
有効な場合、オブジェクトは、利用状況の追跡のための Enterprise Application オブジェクトとして分類されます。 有効な場合、enableBulkApi および enableStreamingApi も有効にする必要があります。 この項目は API バージョン 31.0 以降で使用できます。 |
| enableStreamingApi | boolean |
有効な場合、オブジェクトは、利用状況の追跡のための Enterprise Application オブジェクトとして分類されます。 有効な場合、enableBulkApi および enableSharing も有効にする必要があります。 この項目は API バージョン 31.0 以降で使用できます。 |
| externalDataSource | string |
必須で、外部オブジェクトでのみ使用可能です。外部オブジェクトのデータが保存される外部データソースの名前です。データソースは ExternalDataSource コンポーネントで表されます。 この項目は API バージョン 32.0 以降で使用できます。 |
| externalName | string |
必須で、外部オブジェクトでのみ使用可能です。外部オブジェクトのデータが含まれる、外部データソース内のテーブルの名前です。 この項目は API バージョン 32.0 以降で使用できます。 |
| externalRepository | string | Salesforce Connect の外部オブジェクトでのみ使用できます。ユーザインターフェースの [表示 URL の参照項目] に対応します。 外部オブジェクトの [表示 URL] 標準項目値は、外部システムから自動的に生成されます。たとえば、Salesforce Connect の OData 2.0 アダプタでは、OData プロデューサで定義された link href に基づいた値になります。デフォルト値は、同じ外部オブジェクトのカスタム項目の値で上書きできます。項目名を選択し、カスタム項目の値が有効な URL であることを確認します。 この項目は、API バージョン 32.0 以降で使用できます。 |
| externalSharingModel | SharingModel(string 型の列挙) |
ポータルユーザやコミュニティユーザなど、外部ユーザのアクセスレベルを決定する、オブジェクトの外部組織の共有設定を示します。この項目は、次のオブジェクトでサポートされます。
この項目は API バージョン 31.0 以降で使用できます。 |
| fields | CustomField[] | オブジェクトの 1 つ以上の項目を表します。 |
| fieldSets | FieldSet | このオブジェクトに存在する項目セットを定義します。 |
| fullName | string |
Metadata から継承されるこの項目は、このメタデータ型の WSDL では定義されません。作成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「create()」を参照してください。 この値は null にできません。 |
| gender | Gender | オブジェクトを表す名詞の性別を示します。これは、語の性別に基づいて、異なる処理が必要となる言語に使用されます。 |
| household | boolean | この項目は、Salesforce for Wealth Management でのみ使用できるリレーショングループという機能をサポートします。詳細は、Salesforce オンラインヘルプの「Salesforce for Wealth Management の概要」を参照してください。 |
| historyRetentionPolicy | HistoryRetentionPolicy | 将来の使用のために予約されています。 |
| label | string | Salesforce ユーザインターフェース全体でオブジェクトを表す表示ラベル。 オブジェクトの表示ラベルは、組織の標準オブジェクト、カスタムオブジェクト、外部オブジェクト全体で一意にすることをお勧めします。 |
| listViews | ListView[] | オブジェクトに関連付けられた 1 つ以上のリストビューを表します。 |
| namedFilter | NamedFilter[] | ルックアップ検索条件に関連付けられたメタデータを表します。ルックアップ検索条件の定義を作成、更新、または削除するには、このメタデータ型を使用します。 この項目は API バージョン 17.0 以降で使用できます。 この項目は API バージョン 30.0 で削除されました。それより前のバージョンでのみ使用できます。ルックアップ検索条件に関連付けられたメタデータは、CustomField コンポーネントの lookupFilter 項目によって表されるようになりました。 |
| nameField | CustomField | カスタムオブジェクトの場��、必須です。外部オブジェクトは代わりに、CustomField コンポーネントの isNameField を true に設定することで、名前項目を指定する場合があります。 このオブジェクトの名前が保存されている項目。すべてのカスタムオブジェクトには名前が必要です。この名前は、通常文字列型 または自動採番型です。 カスタムオブジェクトのレコードに付けられる識別子。この名前は、ページレイアウト、関連リスト、ルックアップダイアログ、検索結果、およびタブホームページの主要リストに表示されます。デフォルトでは、カスタムオブジェクトのページレイアウトに必須項目としてこの項目が追加されます。 |
| pluralLabel | string | label 値の複数形です。 |
| recordTypes | RecordType[] | このオブジェクトに定義された 1 つ以上のレコードタイプの配列。 |
| recordTypeTrackFeedHistory | boolean |
フィード追跡のレコードタイプが有効になっているか (true)、否か (false) を示します。この項目を true に設定するには、関連付けられた CustomObject の enableFeeds 項目も true に設定されている必要があります。詳細は、Salesforce オンラインヘルプの「Chatter フィード追跡のカスタマイズ」を参照してください。 この項目は API バージョン 19.0 以降で使用できます。 |
| recordTypeTrackHistory | boolean |
このレコードタイプの履歴追跡が有効になっているか (true)、否か (false) を示します。recordTypeTrackHistory を true に設定するには、関連付けられたカスタムオブジェクトの enableHistory 項目も true に設定されている必要があります。
この項目は API バージョン 19.0 以降で使用できます。 |
| searchLayouts | SearchLayouts | オブジェクトの検索レイアウト関連リスト情報。 |
| sharingModel | SharingModel(string 型の列挙) | オブジェクトの組織の共有設定を示します。 |
| sharingReasons | SharingReason[] | オブジェクトが共有されている理由。 |
| sharingRecalculations | SharingRecalculation[] | オブジェクトに関連付けられたカスタム共有の再適用のリスト。 |
| startsWith | StartsWith (string 型の列挙) | 名詞が母音、子音、または特殊文字で開始されているかを示します。これは、語の最初の文字に基づいて、異なる処理が必要となる言語に使用されます。有効な値は、「StartsWith」 にリストされています。 |
| validationRules | ValidationRule[] | オブジェクトの 1 つ以上の入力規則の配列。 |
| visibility | SetupObjectVisibility (string 型の列挙) | この項目が存在する場合、このコンポーネントはカスタムオブジェクトではなくカスタム設定またはカスタムメタデータ型です。この項目はカスタム設定またはカスタムメタデータ型の表示設定を返します。有効な値は次のとおりです。
デフォルト値は、Public です。 この項目は、API バージョン 34.0 以降で使用できます。カスタム設定の場合、customSettingsVisibility 項目の代わりにこの項目が使用されます。 |
| webLinks | WebLink[] | このオブジェクトに定義された 1 つ以上の Web リンクの配列。 |