メタデータ API 開発者ガイド
jメタデータ API 開発者ツール
メタデータ API コマンドにアクセスするには、Salesforce CLI で Visual Studio Code 向け Salesforce 拡張機能を使用します。Salesforce CLI、および Visual Studio Code 向け Salesforce 拡張機能は、メタデータ API を使用するプロセスを合理化します。
Visual Studio Code 向け Salesforce 拡張機能または Salesforce CLI を使用すると、最も簡単にメタデータ API の機能にアクセスできます。どちらのツールもメタデータ API の上位に構築され、メタデータ API を使用した作業を簡略化するために標準のツールが使用されます。
- Visual Studio Code 向け Salesforce 拡張機能には、軽量で拡張可能な VS Code エディターを使用して Salesforce Platform 上で開発を行うためのツールが含まれています。これらのツールでは、開発組織 (スクラッチ組織、Sandbox、DE 組織)、Apex、Aura コンポーネント、Visualforce を操作する機能が提供されています。
- Salesforce CLI は、スクリプトまたはコマンドラインを使用してローカルディレクトリと Salesforce 組織間でメタデータを移動する場合に最適です。
Visual Studio Code 向け Salesforce 拡張機能や Salesforce CLI についての詳細は、「Salesforce ツールおよびツールキット」を参照してください。
独自のクライアントアプリケーションを作成したい場合は、メタデータ API の基礎となるコールが公開されているため、このコールを直接使用してください。このガイドでは、メタデータ API を直接使用する方法について詳しく説明します。
メタデータ API を使用して、Salesforce の設定とカスタマイズ情報 (メタデータ) を管理できます。次に例を示します。
- カスタマイズを XML メタデータファイルとしてエクスポートします。「Zip ファイルの使用」および「retrieve()」を参照してください。
- 組織間で設定の変更を移行します。「deploy()」および「retrieve()」を参照してください。
- XML メタデータファイルを使用して既存のカスタマイズを変更します。「deploy()」および「retrieve()」を参照してください。
- カスタマイズをプログラムで管理します。「CRUD ベースのメタデータ開発」を参照してください。
Developer Edition または Sandbox でテスト組織のメタデータを変更し、Enterprise Edition、Unlimited Edition、または Performance Edition でテスト済みの変更を本番組織リリースできます。また、カスタムオブジェクト、カスタム項目およびその他のコンポーネントを使用して新しい組織を入力するスクリプトも作成できます。