Salesforceの「User Interface API」とは？

User Interface APIとは

Salesforceの「User Interface API」とは、Salesforceをユーザーや顧客にとって使いやすいようにカスタマイズするために使われるAPIです。 User Interface APIは、新しいUIであるLightning Experienceのために新しいAPIが必要となったという経緯から生まれました。これを利用することで、様々なWebフレーム言語を使用して、カスタムWebアプリケーションやネイティブモバイルアプリケーションの作成が可能です。 また、Lightning Experience自体がUser Interface APIを使用して構築されています。

これまでのAPIとの違い

過去のAPIは、システム管理者が組織のメタデータを変更するたびにUIを更新するコードを書く必要があったため、カスタムアプリケーションでレコードを処理するための動的UIを作成することは困難でした。 具体的には、レイアウトの項目はページ上のどこにあるか、メタデータのオブジェクトにはどの項目があり、それが必須であるのか、レコードデータの項目値は何かなど、たくさんのコールを実施して、必要な情報を取得する必要がありました。 しかし、現在のUser Interface APIは、UIが実行時にメタデータの変更に反応するため、システム権利者がレイアウトや共有ルールなどを変更しても、アプリケーションを変更する必要はなくなりました。 これは、変更がないかチェックするコードを書くといった作業を、User Interface APIが代わりに行ってくれるのです。

User Interface APIが活躍する場面

Salesforceには様々なAPIがあるため、自分がやろうとしていることに最適なツールを判断することが難しい時もあります。 User Interface APIは、カスタムWebまたはモバイルアプリを作成していて、ユーザーがSalesforceレコードを表示、作成、編集、削除できるユーザーインターフェース、つまりSalesforceのような外観と動作のユーザーインターフェースが必要な時に適しています。 また、ユーザーが連動選択リストやルックアップを編集できるユーザーインターフェースを作成する時にもUser Interface APIは適しています。 それは、User Interface APIには、こうした作業を容易にするリソースが含まれているためです。

User Interface APIリソースについての概要

User Interface APIリソースはいくつかのカテゴリーに分類されます。ここでは、その一部のカテゴリーを簡単にご紹介します。

レコードとレイアウト

Salesforceレコードの作成、参照、更新、削除に使用されるリソースです。このリソースは、1つ以上のレコードIDを取り込み、データやメタデータ、レイアウト情報を返します。

リストビュー

Salesforceのユーザーは、リストビューをカスタマイズして、レコードを表示・分析できるようにするのに多くの時間をかけています。User Interface APIを使用することで、レコードのリストとリストビューメタデータの取得が可能になります。

アクション

このリソースは、オブジェクトの作成やメールの送信、活動の記録などに使用されます。アクションは、モバイルアプリのアクションバーとLightning Experienceのアクションリボンに表示されます。 User Interface APIが登場する前までは、アプリケーションはSOQLを使って使用可能なアクションを見つける必要がありましたが、User Interface APIが登場してからは、Salesforceアプリ、レコードの詳細や編集ページなどでユーザーが使用できるアクションのリストを取得することが可能となりました。

お気に入り

Lightning Experienceのヘッダーにある星には、お気に入りのレコードとリストビューが含まれ、お気に入りを追加することで、簡単に移動することが可能になります。 User Interface APIには、お気に入りの作成や表示、削除などを行うリソースがあるため、カスタムアプリ内にも同じお気に入り操作を作成することが可能です。

ルックアップ

Salesforceオブジェクトには、2つのレコードを関連付ける参照項目が含まれている場合が、多々あります。 レコードの編集ページでは、参照項目を使うことで、編集中のレコードに関連付けるレコードの検索が可能です。 ルックアップと連動ルックアップのUIの作成は困難でしたが、User Interface APIが登場したことにより、非常に簡単になりました。

User Interface APIを「使用してはいけない」とされているケース

システムインテグレーションや、データのアップロードや抽出のための自動インテグレーションの作成、データの一括アップロードまたは抽出には、Enterprise APIが推奨されており、User Interface APIは使用してはいけないとされています。 また、Lightningコンポーネントを作成する場合は、User Interface APIを直接使用せずにLDSが推奨されています。 LDSは、User Interface APIに基づいて構築されていますが、応答をキャッシュして、データ変更の影響を受ける全てのレコードを更新することも可能です。 さらに、LSDが代わりに実行するため、RESTコールの実行と結果のキャッシュについて心配する必要がありません。

User Interface APIを学んでより良いUI構築を！

今回は、SalesforceのUser Interface APIについて解説しました。 リソースについてや「使用してはいけないケース」など、少し複雑な部分もありますが、過去のAPIから効率化されたUser Interface APIを利用して、より良いUI構築を行いましょう。]]>