メタデータ API 開発者ガイド
jListView
Metadata メタデータ型を拡張し、その fullName 項目を継承します。Salesforce ヘルプの「Salesforce Classic でのカスタムリストビューの���成」を参照してください。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
リストビューは CustomObject コンポーネント内に保存されます。コンポーネントは、取引先などのカスタムオブジェクトまたは標準オブジェクトを表すことができます。
バージョン
カスタムオブジェクトの ListView コンポーネントは、API バージョン 14.0 以降で使用できます。取引先などの標準オブジェクトの ListView コンポーネントは、API バージョン 17.0 以降で使用できます。
項目
| 項目 | 項目の型 | 説明 |
|---|---|---|
| booleanFilter | string | この項目は検索条件の詳細オプションを表します。検索条件の詳細オプションでは、複数の検索条件行項目に対する AND Boolean 演算子と OR Boolean 演算子の組み合わせを使用する検索条件を作成できます。たとえば、(1 AND 2) OR 3 では最初の 2 つの検索条件行項目または 3 番目の検索条件行項目に一致するレコードが検索されます。 |
| columns | string[] | リストビューの項目のリスト。各カスタム項目に MyCustomField__c などのオブジェクト名を基準にした項目名が指定されます。 |
| division | string |
組織がディビジョンを使用してデータを分類しており、「ディビジョンの使用」権限を取得済みの場合は、リストビュー内のレコードがこのディビジョンに一致する必要があります。この項目は、すべてのレコードを検索する場合にのみ利用できます。 この項目は、API バージョン 17.0 以降で使用できます。 |
| filterScope | FilterScope (string 型の列挙) | 必須。この項目は、所有者でレコードを絞り込むか、すべてのレコードを表示するかを示します。 |
| filters | ListViewFilter[] | 検索条件行項目のリスト。 |
| fullName | string | 必須。Metadata から継承されるこの項目は、このメタデータ型の WSDL で定義されます。作成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「createMetadata()」を参照してください。 |
| label | string | 必須。リストビューの名前。 |
| language | Language |
組織がトランスレーションワークベンチを使用し、startsWith または contains 演算子を使用している場合、条件検索に使用する言語。検索用語として入力した値は検索条件の言語と同じ言語である必要があります。 有効な言語の値の一覧は、「言語」を参照してください。 この項目は、API バージョン 17.0 以降で使用できます。 |
| queue | string | キューの名前。キューへのアクセス権を持つユーザがオブジェクトを監視および管理できるように、オブジェクトがキューに割り当てられている場合があります。キューを作成すると、対応するリストビューが自動的に作成されます。Salesforce ヘルプの「キューの作成」を参照してください。 |
| SharedTo |
この項目は、API バージョン 17.0 以降で使用できます。 |
ListViewFilter
ListViewFilter は検索条件行項目を表します。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| filter | string | 必須。検索条件に指定された項目を表します。 |
| operation | FilterOperation (string 型の列挙) | 必須。equals など、検索条件で使用する演算。有効な値は次のとおりです。
|
| value | string | 操作される検索条件項目の値を表します。たとえば、検索条件が my_number_field__c > 1 である場合、value の値は 1 です。 |
FilterScope
FilterScope は、レコードの検索条件を表す string 型の列挙です。有効な値のリストを次の表に示します。
宣言的なメタデータの定義のサンプル
カスタムオブジェクトのリストビューの XML 定義のサンプルを次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
3. . .
4 <listViews>
5 <fullName>All_Mileages</fullName>
6 <filterScope>everything</filterScope>
7 <label>All Mileages</label>
8 </listViews>
9 <listViews>
10 <fullName>My_Mileages</fullName>
11 <booleanFilter>1 AND 2</booleanFilter>
12 <columns>NAME</columns>
13 <columns>CREATED_DATE</columns>
14 <filterScope>mine</filterScope>
15 <filters>
16 <field>NAME</field>
17 <operation>equals</operation>
18 <value>Eric Bristow</value>
19 </filters>
20 <filters>
21 <field>City__c</field>
22 <operation>equals</operation>
23 <value>Paris</value>
24 </filters>
25 <label>My Mileages</label>
26 </listViews>
27. . .
28</CustomObject>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) はサポートされません。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。