Salesforceの表示ラベルと項目名・API参照名 - サステナリード

Salesforceでカスタム項目を作成する際に、１つの項目に対して表示ラベル・項目名の２つの名称を定義する必要があります。それぞれの違いや用途を解説します。

表示ラベル

下図はSalesforceの通常のユーザーインターフェースから、レコードを開いた画面です。

表示ラベルとは、このレコードの詳細欄に表示されている、項目の名称のことを指します。普段の業務で人間が読むためのものですので、わかりやすい名称を付けるのが通例です。

項目名とは下図で示す通り、アルファベットで構成された、項目を指し示すための名称です。

数式や、フローを使用したオートメーション、Apexを使用したコーディングなどで使用するのは「項目名」になります。

項目名はひとつのオブジェクトの中で同じものはひとつしか定義できません。

例えば、項目名がMobilePhoneという項目を、ひとつのオブジェクトの中で重複して使用することは出来ません。別オブジェクトであれば使用できます。

一方で表示ラベルの方は、ひとつのオブジェクトの中で重複して使用することが出来ます。

なお、カスタム項目には、項目名のお尻に「__c」が付きます。標準項目には付きませんので見分けに使用できます。

さて、項目のもう一つの名称の定義である、API参照名とは何なのかを見ていきます。

下図は数式項目の作成画面です。このような、裏側で設定するような場面でAPI参照名というキーワードが登場します。

API参照名とは項目名とイコールだと考えて結構です。

開発の現場でも同じものとして会話して通じます。

むしろ、「テキスト項目をつくっておいて」「項目名は何にしますか？」といった会話が展開されますので、すべてをひっくるめて項目と呼んだり、表示ラベルのことを指して項目名、と呼ぶことのほうが多いです。その方が一般的にわかりやすいからですね。

本来の「項目名」の方はあえて「API参照名」と呼ぶことで区別して使用します。

表示ラベルを設定する際には、人間が読んでわかりやすい、自社の文化にフィットする単語を使うのがよいでしょう。注意点として、重複した表示ラベルを定義してもOKだとはいえ、様々なシーンでどちらだかわからなくなり弊害が出ますので、できるだけ重複は避けましょう。

項目名（API参照名）を定義する際は、英語で意味の通る名称を付けるのが一般的です。日本語のローマ字読みは読みづらく、API参照名を連続で記述しなくてはならない、オートメーションを開発する際にミスを誘発する可能性が高まります。

面倒ですがgoogleで検索するなどして英語で記載しましょう。

記載する際は、MobilePhoneのように単語同士をつなげて、単語の頭文字を大文字にするか、Mobile_Phoneのようにアンダースコアをいれて記載するのが一般的です。

以上が、表示ラベルと項目名・API参照名の全貌になります。