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