メタデータの一覧表示とデータクエリ時に、API 名の代わりにカラムの表示名を使用するかどうを指定します。

データ型

bool

デフォルト値

false

解説

デフォルトでは、本製品 は静的で開発者向けのSalesforce API 名を使用してカラム名を表示します。 UseDisplayNames がtrue に設定されている場合、本製品 はカラムの表示名を使用し、ユーザーがSalesforce UI で見るものと一致させます。 これにより、基本的なAPI 用語よりもSalesforce インターフェースに慣れているユーザーにとって、クエリとメタデータの操作がより直感的になります。

エンドユーザーやビジネスユーザー向けのレポートやクエリを作成する際に、Salesforce UI に表示されるフィールド名を期待する場合は、このプロパティを使用してください。

UseDisplayNames を有効にすると、API 名を表示名にマッピングするために必要な追加処理により、メタデータ処理時間がわずかに増加する可能性があります。 ただし、メタデータAPI 呼び出しの数は増加しません。 表示名はSalesforce 管理者によって変更される可能性があるため、これらを使用するとクエリの安定性が時間の経過とともに低下する可能性があります。長期的な連携では、一貫性のためにAPI 名を推奨します。

このプロパティは、UI ベースのレポートやビジネス向けクエリを構築する際の可読性とユーザーフレンドリーさを向上させる場合に役立ちます。