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

DescribeLayoutResult

describeLayout() コールは、渡された sObjectType に関する最上位のレコードタイプ情報を含む DescribeLayoutResult オブジェクトを返します。また、レコードタイプからレイアウトへの対応付けも返します。使用しているクライアントアプリケーションは、このオブジェクトを詳細に辿り、レイアウトの詳細なメタデータを取得します。

組織でパブリッシャーのアクションが有効になっている場合、sObjectType として GlobalrecordTypeId として null を使用することで、グローバルパブリッシャーレイアウトのレイアウト定義を取得できます。

ヒント

名前 説明
feedView DescribeLayoutFeedView[] フィードベースのレイアウトのフィードビュー関連レイアウトデータ。この項目は、フィードベースではないページレイアウトでは null になります。
layouts DescribeLayout[] 指定された sObjectType と関連付けられたレイアウト。通常、レイアウトとオブジェクトは 1 対 1 対応です。ただし、場合によっては 1 つのオブジェクトにユーザプロファイルによって異なる複数のレイアウトが割り当てられている場合があります。
recordTypeMappings RecordTypeMapping[] ユーザはレコードタイプの対応付けが利用可能です。ユーザプロファイルのオブジェクトには複数のレコードタイプが存在する場合があります。コールしたユーザが利用可能なものだけではなく、すべてのレコードタイプが返されます。これにより、クライアントアプリケーションは指定されたユーザプロファイルに適切なレイアウトで表示できます。たとえば、ユーザ A がレコードの所有者であり、このレコードにはレコードタイプ X が設定されているとします。ユーザ B がレコードを表示しようとした場合、クライアントアプリケーションはユーザ B のプロファイルのレコードタイプに関連付けられたレイアウトを使用しレコードを表示します (そのユーザが利用できないレコードタイプの場合も同様)。
recordTypeSelectorRequired boolean true の場合、レコードタイプ選択ページが必要です。false の場合、デフォルトのレコードタイプを使用します。

DescribeLayout

指定された sObjectType 固有のレイアウトを表します。各 DescribeLayout は一意なレイアウト ID を使用して参照し、2 つのタイプのビューが存在します (DescribeLayoutSection の配列としてこのオブジェクトで表されます)。

  • 詳細ビュー — オブジェクトを参照のみの形式で表示します。詳細レイアウトでは、特定の情報 (詳細な住所など) を 1 つの DescribeLayoutItem にまとめることができます。
  • 編集ビュー — オブジェクトを編集可能な形式で表示します。編集レイアウトでは、個々の情報 (住所など) はそれぞれの項目に分けられます。

個々の DescribeLayout には、次の項目があります。

名前 説明
buttonLayoutSection DescribeLayoutButtonSection 指定されたレイアウトに関連付けられた標準ボタンとカスタムボタンのセクション。
detailLayoutSections DescribeLayoutSection[] 詳細ビューのレイアウトセクション。
editLayoutSections DescribeLayoutSection[] 編集ビューのレイアウトセクション。
highlightsPanelLayoutSection DescribeLayoutSection[] 強調表示パネルビューのレイアウトセクション。
multirowEditLayoutSections DescribeLayoutSection[] 複数行レイアウトビューのレイアウトセクション。この項目は、API バージョン 35.0 以降で使用できます。
id ID このレイアウトの一意の ID。ID についての詳細は、ID データ型を参照してください。
quickActionList DescribeQuickActionListResult 指定されたレイアウトに関連付けられたアクションのリスト。この項目は API バージョン 28.0 以降で使用できます。
relatedContent RelatedContent 指定されたレイアウトに関連付けられたモバイルカードセクション。この項目は、API バージョン 29.0 以降で使用できます。
relatedLists RelatedList[] 指定されたレイアウトと関連付けられた関連リスト。

DescribeLayoutButtonSection

標準ボタンまたはカスタムボタンのいずれかを含むレイアウトの 2 つのセクションのいずれかを表します。

名前 説明
detailButtons DescribeLayoutButton[] 指定されたボタンセクションに関連付けられた標準ボタンまたはカスタムボタン。

DescribeLayoutButton

DescribeLayout の単一の標準ボタン、カスタムボタン、またはカスタムリンクを表します。

名前 説明
behavior WebLinkWindowType ボタンまたはリンクをクリックしたときの動作 (JavaScript を実行したり、そのコンテンツソースを新しいウィンドウで開いたりする動作)。

この項目は API バージョン 31.0 以降で使用できます。

colors DescribeColor[] このボタンまたはリンクに関連付けられたアイコンの色情報の配列。各色はテーマに関連付けられています。

この項目は API バージョン 32.0 以降で使用できます。

content string 配信される Visualforce ページまたは Sコントロールの API 名。

この項目は API バージョン 31.0 以降で使用できます。

contentSource WebLinkType カスタムボタンまたはリンクのコンテンツソース。上書きされていない標準ボタンの contentSource は、null です。

この項目は API バージョン 31.0 以降で使用できます。

custom boolean 必須。カスタムボタンまたはリンクであるか (true)、否か (false) を示します。
encoding string ボタンまたはリンクでコールされる URL に割り当てられているエンコードタイプ。有効な値は、次のとおりです。
  • UTF-8—Unicode (UTF-8)
  • ISO-8859-1 – 米国一般および西ヨーロッパ (ISO-8859–1、ISO-LATIN-1)
  • Shift_JIS — 日本語 (Shift-JIS)
  • ISO-2022-JP — 日本語 (JIS)
  • EUC-JP — 日本語 (EUC-JP)
  • x-SJIS_0213 — 日本語 (Shift-JIS_2004)
  • ks_c_5601-1987 — 韓国語 (ks_c_5601-1987)
  • Big5 — 繁体字中国語 (Big5)
  • GB2312 — 簡体字中国語 (GB2312)
  • Big5-HKSCS – 繁体字中国語香港 (Big5–HKSCS)
この項目は、API バージョン 31.0 以降で使用できます。
height int ボタンまたはリンクの behavior 項目値が newWindowsidebar、または noSidebar に設定されている場合の高さ (ピクセル)。

この項目は API バージョン 31.0 以降で使用できます。

icons DescribeIcon[] このボタンまたはリンクのアイコンの配列。各アイコンはテーマに関連付けられています。この項目は API バージョン 29.0 以降で使用できます。
label string Salesforce ユーザインターフェースに表示されたボタンまたはリンクの表示ラベル。
menubar boolean ボタンまたはリンクの behavior 項目値が newWindow に設定されている場合にメニューバーが表示されるか (true)、否か (false) を示します。

この項目は API バージョン 31.0 以降で使用できます。

name string ボタンまたはリンクの API 名。
overridden boolean 必須。標準ボタンが上書きされているか (true)、否か (false) を示します。

この項目は API バージョン 31.0 以降で使用できます。

resizeable boolean ボタンまたはリンクの behavior 項目値が newWindow に設定されている場合に新しいウィンドウのサイズを変更できるか (true)、否か (false) を示します。

この項目は API バージョン 31.0 以降で使用できます。

scrollbars boolean ボタンまたはリンクの behavior 項目値が newWindow に設定されている場合にスクロールバーが表示されるか (true)、否か (false) を示します。

この項目は API バージョン 31.0 以降で使用できます。

showsLocation boolean ボタンまたはリンクの behavior 項目値が newWindow に設定されている場合にアドレスバーが表示されるか (true)、否か (false) を示します。

この項目は API バージョン 31.0 以降で使用できます。

showsStatus boolean ボタンまたはリンクの behavior 項目値が newWindow に設定されている場合にステータスバーが表示されるか (true)、否か (false) を示します。

この項目は API バージョン 31.0 以降で使用できます。

toolbar boolean ボタンまたはリンクの behavior 項目値が newWindow に設定されている場合にツールバーが表示されるか (true)、否か (false) を示します。

この項目は API バージョン 31.0 以降で使用できます。

url string ボタンまたはリンクでコールされる URL。関連リストの標準ボタンの場合、この項目は null です。

この項目は API バージョン 31.0 以降で使用できます。

width int ボタンまたはリンクの behavior 項目値が newWindow に設定されている場合の幅 (ピクセル)。

この項目は API バージョン 31.0 以降で使用できます。

windowPosition WebLinkPosition ボタンまたはリンクの behavior 項目値が newWindow に設定されている場合のウィンドウの位置を示します。

この項目は API バージョン 31.0 以降で使用できます。

DescribeLayoutComponent

レイアウトの最小単位である項目または境界を表します。表示するための項目の参照において、クライアントアプリケーションは次の表記法を使用し describeSObjects() コールの項目を参照します。LayoutComponent.fieldName

API バージョン 31.0 以降では、LayoutComponentType 値が Field で、記述される項目が Address または [Person Name] のいずれかの複合項目である場合、DescribeLayoutComponent は、FieldLayoutComponent によって拡張されます。

名前 説明
displayLines int 編集ビューの項目に表示される垂直な線の数。textarea および複数選択リストに適用されます。
tabOrder int 行のアイテムのタブの順序を示します。
type LayoutComponentType この LayoutComponent の LayoutComponentType
value string この LayoutComponent の値。LayoutComponentType の値が Field の場合、項目の名前。LayoutComponentType 値が Canvas の場合のキャンバスアプリケーションの API 名。

DescribeLayoutFeedFilter

フィードの絞り込みに使用可能な個々のフィード条件オプションを表します。

名前 説明
label string 検索条件の表示ラベル。
name string 検索条件の API 名。
type FeedLayoutFilterType Enum 以下の標準のフィード条件種別。
  • AllUpdates
  • FeedItemType

DescribeLayoutFeedView

フィードベースのページレイアウトのフィードビューのレイアウトを表します。

名前 説明
feedFilters DescribeLayoutFeedFilter[] フィードと一緒に表示されるフィード条件オプションをリストします。

DescribeLayoutItem

DescribeLayoutRow の個別のアイテムを表します。DescribeLayoutItem はコンポーネントセット (DescribeLayoutComponent) で構成され、それぞれは項目または境界です。レイアウトのほとんどの項目で、1 つのレイアウトアイテムごとにコンポーネントは 1 つだけです。ただし、表示のみのビューでは、DescribeLayoutItem は個別項目の組み合わせである場合があります (たとえば、住所は町名、市区郡、都道府��、国、郵便番号のデータから構成することができます)。対応する編集ビューでは、住所項目のそれぞれのコンポーネントは、別個の DescribeLayoutItem に分けられます。

名前 説明
editable boolean この DescribeLayoutItem が編集可能であるか (true)、否か (false) を示します。この項目は、API バージョン 30.0 以前で使用できます。API バージョン 31.0 では、editableForNew および editableForUpdate 項目に置き換わりました。
editableForNew boolean レコードの新規作成時に、新規 DescribeLayoutItem を編集できるか (true)、否か (false) を示します。

この項目は API バージョン 31.0 以降で使用できます。

editableForUpdate boolean レコードの編集時に、既存の DescribeLayoutItem を編集できるか (true)、否か (false) を示します。

この項目は API バージョン 31.0 以降で使用できます。

label string この DescribeLayoutItem の表示ラベルテキスト。
layoutComponents DescribeLayoutComponent[] この DescribeLayoutItem の DescribeLayoutComponent
placeholder boolean この DescribeLayoutItem がプレースホルダか (true)、否か (false) を示します。true の場合、この DescribeLayoutItem は空白となります。
required boolean この DescribeLayoutItem が必須項目か (true)、否か (false) を示します。この機能は、目立つ色 (赤など) で必須項目を表示する場合などに便利です。

DescribeLayoutRow

DescribeLayoutSection の行を表します。DescribeLayoutRow は DescribeLayoutItem で構成されています。それぞれの DescribeLayoutRow について、DescribeLayoutItem は特定の項目または「空白の」DescribeLayoutItem ( DescribeLayoutComponent オブジェクトを含まない DescribeLayoutItem) を参照します。空の DescribeLayoutItem は、指定された DescribeLayoutRow がまばらである場合返されます (たとえば、左の列より右の列の方が項目が多い場合)。レイアウトに空白がある場合、空の DescribeLayoutItem がプレースホルダとして返されます。

名前 説明
layoutItems DescribeLayoutItem[] 特定の項目または「空」の LayoutItem (DescribeLayoutComponent オブジェクトを含まない LayoutItem) を参照します。
numItems int layoutItems の数。この情報は冗長ですが、一般的な SOAP ツールキットのバグによる逐次化の問題を避けるために必要です。

DescribeLayoutSection

DescribeLayout のセクションを表し、1 つ以上の列および 1 つ以上の行から構成されます (DescribeLayoutRow の配列)。

名前 説明
columns int この DescribeLayoutSection の列数。
heading string この DescribeLayoutSection のヘッダーのテキスト (表示ラベル)。
layoutRows DescribeLayoutRow[] 1 つ以上の DescribeLayoutRow オブジェクトの配列。
parentLayoutId ID この DescribeLayoutSection が存在するレイアウトの ID。

この項目は API バージョン 35.0 以降で使用できます。

rows int この DescribeLayoutSection の行数。
tabOrder string 編集ビューのセクションの項目のタブ順序を示します。有効な値は、次のとおりです。
  • LeftToRight
  • TopToBottom

この項目は API バージョン 31.0 以降で使用できます。

useCollapsibleSection boolean この DescribeLayoutSection が折りたたみ可能な (「twistie」な) セクションかどうかを示します (可能な場合は true、不可能な場合は false)。
useHeading boolean heading を表示するか (true)、否か (false) を示します。

DescribeQuickActionListResult

ページレイアウトに割り当てられたアクションのリストを表します。API バージョン 28.0 以降で利用できます。

名前 説明
quickActionListItems DescribeQuickActionListItemResult[] 0 個以上の QuickActionListItemResult オブジェクトの配列。

DescribeQuickActionListItemResult

ページレイアウトのアクションリストに割り当てられた QuickAction を表します。API バージョン 28.0 以降で利用できます。

名前 説明
colors DescribeColor[] 色情報の配列。各色はテーマに関連付けられています。この項目は API バージョン 29.0 以降で使用できます。
iconUrl string アクションに関連付けられたアイコンの URL。このアイコン URL は、Spring '10 で導入された現在の Salesforce テーマに使用される 32x32 アイコンに対応します。
icons DescribeIcon[] このアクションのアイコンの配列。各アイコンはテーマに関連付けられています。この項目は API バージョン 29.0 以降で使用できます。
label string アクションの表示ラベル。
miniIconUrl string アクションに関連付けられたミニアイコンの URL。このアイコン URL は、Spring '10 で導入された現在の Salesforce テーマに使用される 16×16 アイコンに対応します。
quickActionName string アクションの API 名。
targetSobjectType string アクションの対象オブジェクトの API 名。
type string アクションの QuickActionType。有効な値は、次のとおりです。
  • 作成
  • VisualforcePage

CustomLinkComponent

LayoutComponentType の値が CustomLink の場合、この型にはページレイアウト上の 1 ��のカスタムリンクに関する情報が含まれます。

名前 説明
customLink DescribeLayoutButton 種別が CustomLink の 1 つの LayoutComponent オブジェクト。

FieldLayoutComponent

DescribeLayoutComponent で返される情報を拡張します。LayoutComponentType の値が Field、記述される項目が Address または [Person Name] 項目の場合、FieldLayoutComponent には項目のコンポーネントに関する情報が含まれます。

API バージョン 31.0 以降で利用できます。

名前 説明
components DescribeLayoutComponent[] 種別が Field の 0 個以上の LayoutComponent オブジェクトの配列。
fieldType FieldType 項目のデータ型。

FieldLayoutComponent の使用方法を示すサンプルコード

LayoutComponentType

DescribeLayoutComponent のタイプを表します。次の値の 1 つを含みます。
  • AnalyticsCloud — ページレイアウトの Wave Analytics ダッシュボードAPI バージョン 34.0 以降で使用できます。
  • Canvas — ページレイアウトのキャンバスコンポーネント。このレイアウトコンポーネントの種類は、API バージョン 31.0 以降で使用できます。
  • CustomLink — ページレイアウトのカスタムリンク。
  • EmptySpace — ページレイアウトの空白スペース。
  • ExpandedLookup — ページレイアウトのモバイルカードセクションにある拡張ルックアップコンポーネント。
  • Field — 項目名。describeSObjectResultname 項目への対応付け。
  • ReportChart — ページレイアウトのレポートグラフ。
  • SControl — 今後の使用のための予約。
  • Separator — セミコロン (:) やスラッシュ (/) などの区切り文字。
  • VisualforcePage — ページレイアウトの Visualforce コンポーネント。

PicklistForRecordType

RecordTypeMapping の単一のレコードタイプ選択リストを表します。picklistName は、describeSObjectResultfields 配列の各項目の name 属性に一致します。picklistValues は、recordType の利用可能な値セットです。

名前 説明
picklistName string 選択リストの名前。
picklistValues PicklistEntry[] RecordTypeMappingrecordTypeIds に関連付けられた選択リストの値セット。

注意: picklistValues を取得した場合、validFor の値は null 値となります。validFor 値が必要な場合、DescribeSObjectResult に関連付けられた Field オブジェクトから取得した PicklistEntry から取得します。

RecordTypeMapping

DescribeLayoutResult オブジェクトの recordTypeMappings 項目の単一のレコードタイプの対応付けを表します。このオブジェクトは、有効な recordTypeIdslayoutId に対する対応付けです。詳細ビューを表示するために、クライアントアプリケーションはこの対応付けを使用して、レコードのレコードタイプに関連付けられたレイアウトを確認します。編集ビューを表示するために、クライアントアプリケーションはこの対応付けを使用して使用するレイアウトを確認します (また、ユーザによる複数のレコードタイプの選択を許可します)。また、利用可能な選択リストの値セットも確認します。

名前 説明
available boolean このレコードタイプが利用可能かどうかを示します (利用可能な場合は true、そうでない場合は false)。利用可能かどうかという情報は、新しいレコードの作成時に利用可能なレコードタイプの一覧をユーザに表示するのに使用します。
defaultRecordTypeMapping boolean デフォルトのレコードタイプの対応付けかどうかを示します (デフォルトの場合は true、そうでない場合は false)。
layoutId ID このレコードタイプに関連付けられたレイアウトの ID。
name string レコードタイプの名前。
picklistsForRecordType PicklistForRecordType[] recordTypeIds に対応付けられたレコードタイプ選択リスト。
recordTypeId ID レコードタイプの ID。

以前のバージョンでこの結果に含まれていたいくつかの項目は RecordTypeInfo に移動されました。

メモ

RelatedContent

DescribeLayout のモバイルカードセクションを表します。API バージョン 29.0 以降で利用できます。

名前 説明
relatedContentItems DescribeRelatedContentItem[] ページレイアウトのモバイルカードセクションにある項目の配列。

DescribeRelatedContentItem

DescribeRelatedContentItem リスト内の個々の項目を表します。API バージョン 29.0 以降で利用できます。

名前 説明
describeLayoutItem DescribeLayoutItem モバイルカードセクションにある個々のレイアウト項目。 モバイルカードセクションに追加するには、DescribeRelatedContentItem でラップする必要があります。

RelatedList

DescribeLayoutResult の単一の関連リストを表します。

名前 説明
buttons DescribeLayoutButton[] この関連リストに関連付けられたボタン。この項目は、API バージョン 32.0 以降で使用できます。
columns RelatedListColumn[] 関連リストに関連付けられた列。
この値を Field と組み合わせ、次のような項目の判別など、数々の便利なタスクを実行できます。
  • 名前項目かどうか (詳細へのリンクを表すため)
  • 並び替え可能かどうか (指定された列で行を並び替える目的でユーザによる ORDER BY 句での使用を許可するため)
  • 通貨項目かどうか (通貨記号またはコードを含めるため)
custom boolean true の場合、関連リストはカスタムとなります。
field string 関連するオブジェクトとのリレーションを確立する関連オブジェクトの項目名。たとえば、AccountContact 関連リストにおいて、値は AccountId となります。
label string Salesforce ユーザインターフェースに表示された関連リストの表示ラベル。
limitRows int 表示する行数。
name string DescribeLayout の引数として提供されている sObjectTypeDescribeSObjectResult の中の ChildRelationship の名前。
sobject string Name of the sObjectType that is the row type for rows within this related list.
sort RelatedListSort[] null 値でない場合、関連オブジェクトの並び替えに使用される列。

RelatedListColumn

DescribeLayoutResult が返した関連リストの単一項目を表します。

名前 説明
field string 項目の API 名。この値は常に object_type.field_name の形式で表されます。たとえば、nameContact.Account.Owner.Alias の場合、値は User.Alias となります。
format string date または dateTime 形式で表します。
label string 項目の表示ラベル。
lookupId string メインの関連リスト sObject のルックアップ ID 値を取得するための省略可能な SOQL 項目構文。この値は、ドット表記を使用した SOQL リレーションのクエリを使用する形式を使用します。

たとえば、関連リスト sObjectTypeCase であり、列の表示値が Owner.Alias の場合、ルックアップ ID 値は Owner.Id となります。

name string 関連リストのメインの sObject に関連付けられた項目の SOQL 項目構文。この値は、ドット表記を使用した SOQL リレーションのクエリの形式で表すか、toLabel() または convertCurrency() の形式を使用します。

たとえば、関連リスト sObjectTypeCase の場合、値は Owner.Alias または toLabel(Case.Status) となります。

RelatedListSort

関連リストのオブジェクトの並び替え設定を表します。

名前 説明
column string 関連オブジェクトの並び替えに使用する項目名。
ascending boolean true の場合、並び替え順序は昇順です。false の場合、並び替え順序は降順です。
ほとんどの場合、配列には RelatedListSort は 1 つしか存在しませんが、標準の関連リストの中には RelatedListSort が複数存在する特殊なものもあります。RelatedListSort が複数存在する場合は、下記のように対応する SOQL クエリに含める方法によって並び替えられます。