Salesforceの導入サポート、開発・連携を行う(株)FDCのエンジニアチームが、Salesforce APIの参照名について詳しく解説します。
SalesforceでAPI連携や開発を行う際、「API参照名」という用語に出会うことが多くありますが、詳しくはよくわからないという方も多いのではないでしょうか。
そこでこの記事では、Salesforce初心者の方でもわかりやすいように、API参照名とは何か、表示ラベルとの違い、確認方法などを実践的に説明していきます。
Salesforce APIの参照名とは
API参照名（API Name）とは、ApexやSOAP API、REST API、Bulk APIなどのプログラムでSalesforceのオブジェクトや項目を操作する際に使用される一意の識別子です。画面上に表示される日本語や英語の表示ラベルとは異なり、プログラム内部で使用される技術的な名称として機能します。
Salesforceでは、オブジェクトや項目を作成する際に必ず表示ラベルとAPI参照名の両方が設定されます。表示ラベルは画面上でユーザーが目にする名前ですが、API参照名はシステム内部やプログラミングで使用される名前となり、一度作成するとあまり変更されない、安定した識別子として機能します。
標準オブジェクト・項目のAPI参照名
Salesforceの標準オブジェクト（取引先、取引先責任者、商談など）や標準項目については、API参照名が英語で固定されています。例えば以下のような形式です。
| 表示ラベル（日本語） | API参照名 |
|---|---|
| 取引先 | Account |
| 取引先責任者 | Contact |
| 商談 | Opportunity |
| 取引先名 | Name |
| 電話 | Phone |
標準項目の場合、多くはAPI参照名と表示ラベル（英語版）が同じ名前を使用しています。ただし、日本語環境では表示ラベルが日本語化されているため、画面上の名称とAPI参照名が異なって見えることがあります。
カスタムオブジェクト・項目のAPI参照名
カスタムオブジェクトやカスタム項目のAPI参照名には、末尾に「__c」（アンダースコア2つとc）が自動的に付与されるという特徴があります。これはSalesforceがカスタム要素を識別するための命名規則です。
| 種類 | 表示ラベル例 | API参照名例 |
|---|---|---|
| カスタムオブジェクト | プロジェクト | Project__c |
| カスタムオブジェクト | 注文管理 | OrderManagement__c |
| カスタム項目 | 注文日 | OrderDate__c |
| カスタム項目 | 合計金額 | TotalAmount__c |
API参照名は同じオブジェクト内で一意である必要があり、スペースを含めることはできません。一般的には英数字とアンダースコアのみを使用し、PascalCase（各単語の先頭を大文字にする記法）で命名することが推奨されています。
API参照名と表示ラベルの違い
Salesforceを理解する上で、API参照名と表示ラベルの違いを明確に把握することは非常に重要です。両者は異なる目的と特性を持っており、使い分けることでシステムの柔軟性と保守性が向上します。
表示ラベル（Field Label）の特徴
表示ラベルは、ユーザーインターフェース上でエンドユーザーが目にする名称です。以下のような特徴があります。
- 画面上、レポート、ダッシュボードなどで表示される名前
- 日本語を含む多言語での命名が可能
- いつでも自由に変更できる
- 変更してもプログラムやAPI連携に影響しない
- スペースや特殊文字の使用が可能
API参照名（API Name）の特徴
一方、API参照名はシステム内部やプログラミングで使用される技術的な識別子として機能します。
- Apex、SOQL、各種APIで使用される名前
- 英数字とアンダースコアのみ使用可能（スペース不可）
- 変更は可能だが、既存のコードやAPI連携に影響を与える可能性がある
- カスタム要素には自動的に「__c」が付与される
- 同じオブジェクト内で一意である必要がある
- プログラムの安定性のため、作成後はなるべく変更しない
具体例で見る違い
以下の表で、表示ラベルとAPI参照名の違いを具体的に見てみましょう。
| 要素 | 表示ラベル | API参照名 | 用途 |
|---|---|---|---|
| カスタム項目 | 顧客満足度スコア | CustomerSatisfactionScore__c | 画面表示 / API・Apex |
| カスタムオブジェクト | 製品カタログ | ProductCatalog__c | 画面表示 / API・Apex |
| 標準項目 | 取引先名 | Name | 画面表示 / API・Apex |
| 標準オブジェクト | 商談 | Opportunity | 画面表示 / API・Apex |
表示ラベルは「顧客満足度スコア」のように日本語で分かりやすく命名できますが、API参照名は「CustomerSatisfactionScore__c」のように英数字とアンダースコアのみで構成されます。表示ラベルを変更してもプログラムには影響しませんが、API参照名を変更するとApexコードやAPI連携が動作しなくなる可能性があるため、慎重な対応が必要です。
API参照名の確認方法
Salesforceでオブジェクトや項目のAPI参照名を確認する方法はいくつかあります。ここでは、最も一般的な方法を紹介します。
オブジェクトマネージャからの確認方法
最も基本的で確実な方法は、設定画面のオブジェクトマネージャを使用する方法です。以下の手順で確認できます。
- Salesforceにログインし、右上の歯車アイコンをクリックして「設定」を選択します
- 左側のクイック検索ボックスに「オブジェクトマネージャ」と入力し、表示された「オブジェクトマネージャ」をクリックします
- オブジェクト一覧が表示されるので、確認したいオブジェクトを見つけます
- 「API参照名」列に表示されている名称がオブジェクトのAPI参照名です
- 特定のオブジェクトをクリックすると、そのオブジェクトの詳細画面に移動します
- 「項目とリレーション」タブをクリックすると、すべての項目の一覧が表示されます
- 各項目の「API参照名」列で、項目のAPI参照名を確認できます
この方法では、標準オブジェクト・カスタムオブジェクト、標準項目・カスタム項目のすべてのAPI参照名を一箇所で確認できるため、開発やAPI連携の準備作業として最も推奨される方法です。
項目の詳細ページからの確認方法
個別の項目のAPI参照名を確認する場合は、以下の方法も利用できます。
- 設定画面から「オブジェクトマネージャ」を開きます
- 対象のオブジェクトを選択します
- 「項目とリレーション」をクリックします
- 確認したい項目の名前をクリックして項目の詳細ページを開きます
- 詳細ページ上部に「項目表示ラベル」と「API参照名」が表示されます
開発者コンソールでの確認方法
プログラマーやエンジニアの方は、開発者コンソールを使用してAPI参照名を確認することもできます。以下のようなApexコードを開発者コンソールの「Execute Anonymous Window」で実行すると、デバッグログで確認できます。
| 確認内容 | コード例 |
|---|---|
| オブジェクトのAPI参照名 | Schema.SObjectType.Account.getName() |
| 項目のAPI参照名 | Schema.SObjectType.Account.fields.Name.getName() |
| オブジェクトの全項目 | Schema.getGlobalDescribe().get(‘Account’).getDescribe().fields.getMap() |
この方法は、複数の項目を一度に確認したい場合や、プログラムで動的にAPI参照名を取得する処理を実装する際に有効です。
Chrome拡張機能の活用
2025年現在、「Salesforce Show Api Name」というChrome拡張機能が利用可能で、これを使用するとSalesforceの画面上で表示ラベルにカーソルを合わせるだけでAPI参照名を確認できるようになります。開発作業の効率化に役立つツールとして、多くの開発者に利用されています。
API参照名を使用する場面
API参照名は、Salesforceのさまざまな場面で使用されます。ここでは代表的な使用場面を紹介します。
Apexクラスでの使用
ApexはSalesforce独自のプログラミング言語であり、オブジェクトや項目を操作する際には必ずAPI参照名を使用します。例えば以下のようなコードでは、API参照名を使用してデータを操作します。
- Account（取引先オブジェクト）のNameフィールド（取引先名）にアクセスする
- Opportunity（商談オブジェクト）のCustomField__c（カスタム項目）に値を設定する
- SOQLクエリでデータを検索・抽出する
Apexコードの中では、表示ラベルではなくAPI参照名を使用しなければコンパイルエラーが発生します。
SOQL・SOSLクエリでの使用
SOQL（Salesforce Object Query Language）やSOSL（Salesforce Object Search Language）は、Salesforceのデータベースからデータを取得するためのクエリ言語です。これらのクエリを記述する際にも、オブジェクト名や項目名にはすべてAPI参照名を使用します。
例えば、カスタムオブジェクト「Project__c」からデータを取得する場合、表示ラベルの「プロジェクト」ではなく、API参照名の「Project__c」を使用する必要があります。
REST API・SOAP APIでの使用
外部システムとSalesforceを連携する際に使用するREST APIやSOAP APIでも、API参照名が必須です。APIリクエストのパラメータやレスポンスのJSON/XML内では、すべてAPI参照名でオブジェクトや項目が表現されます。
2025年現在、SalesforceではREST API、SOAP API、Bulk API、Metadata API、Streaming API、Apex SOAP API、Apex REST API、Chatter APIなど、11種類以上のAPIが提供されており、すべてのAPIでAPI参照名が使用されます。
データローダーでの使用
データローダーは、Salesforceにデータを一括でインポート・エクスポートするツールです。CSVファイルのヘッダー行には、表示ラベルではなくAPI参照名を指定する必要があります。これにより、正確にデータのマッピングが行われます。
Visualforce・Lightningコンポーネントでの使用
カスタムUI開発を行う際にも、VisualforceページやLightningコンポーネント内でオブジェクトや項目を参照する場合はAPI参照名を使用します。画面に表示する際の表示ラベルとは別に、内部的なデータ操作にはAPI参照名が必要です。
API参照名の命名規則とベストプラクティス
カスタムオブジェクトやカスタム項目を作成する際には、適切なAPI参照名を設定することが重要です。ここでは、推奨される命名規則とベストプラクティスを紹介します。
基本的な命名規則
SalesforceにおけるAPI参照名の基本的なルールは以下の通りです。
- 英数字とアンダースコアのみを使用する（スペース不可）
- 文字で始まる必要がある（数字で始めることはできない）
- 最後にアンダースコアを使用できない
- 2つ連続してアンダースコアを使用できない（__cを除く）
- 同じオブジェクト内で一意である必要がある
- カスタム要素には自動的に「__c」が付与される
文字数制限
API参照名には文字数制限があります。2025年現在、Salesforceでは主に以下の3つの長さ制限が存在します。
- 40文字以内：多くのカスタムオブジェクトや項目
- 80文字以内：一部のメタデータ要素（外部サービスのApexクラス名など）
- 255文字以内：一部の特殊な要素
一般的なカスタム項目やカスタムオブジェクトでは、__cを含めて40文字以内に収める必要があります。実質的には、__cが3文字使用されるため、実際に命名できるのは37文字までとなります。
推奨される命名パターン
保守性と可読性を高めるため、以下のような命名パターンが推奨されています。
- PascalCase（各単語の先頭を大文字にする）を使用する：OrderDate、TotalAmount
- 意味が明確で理解しやすい英単語を使用する
- 略語は一般的に認知されているもののみ使用する（例：API、URL、ID）
- 業務内容を反映した命名にする
- 一貫性のある命名規則を組織全体で統一する
例えば、「注文日」という項目を作成する場合、「OrderDate__c」のように英語で明確に意味が分かる命名にすることで、後から参加する開発者や保守担当者が理解しやすくなります。
API参照名変更時の注意点
API参照名は作成後も変更可能ですが、以下の点に注意が必要です。
- 既存のApexコードに影響が出る可能性がある
- 外部システムとのAPI連携が動作しなくなる可能性がある
- データローダーの設定ファイルを修正する必要がある
- レポートやダッシュボードのカスタム数式に影響する可能性がある
- 選択リストの値のAPI参照名は保護機能で変更を防ぐことができる（2025年機能追加）
API参照名を変更する場合は、影響範囲を事前に十分に調査し、テスト環境で動作確認を行ってから本番環境に適用することが重要です。
まとめ
いかがだったでしょうか、今回はSalesforce APIの参照名について詳しく解説してきました。
この記事を読むことで、ある程度はSalesforce APIについてや参照名、表示ラベルについてご理解いただけたと思いますが、やはりエンジニア領域のこともあり、自社内では色々と難しそうだな、と感じられている方もいらっしゃるかもしれません。
そんな方におすすめなのが、弊社(株)エフ・ディー・シーが提供している「SFsolution」。
これはSalesforce導入・活用サポートサービスで、数多くの企業様にご利用いただいています。
もちろん今回のトピックスであるAPIについてもサポート可能ですので、興味をお持ちの方はお問い合わせ、もしくは資料ダウンロードをしていただければ幸いです。
