メタデータ API 開発者ガイド
jRemoteSiteSetting
リモートサイトの設定を表します。Sコントロールやカスタムボタンで XmlHttpRequest を使用して、Visualforce ページ、Apex 呼び出し、または JavaScript コードで外部サイトを呼び出せるようにするには、事前に [リモートサイトの設定] ページにそのサイトを登録しておく必要があります。登録していないと、呼び出しは失敗します。
RemoteSiteSetting は Metadata メタデータ型を拡張し、その fullName 項目を継承します。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
RemoteSiteSetting コンポーネントは、対応するパッケージディレクトリの remoteSiteSettings ディレクトリに保存されます。ファイル名はリモートサイトの設定の一意の名前に一致し、拡張子は .remoteSite です。
バージョン
RemoteSiteSetting コンポーネントは、API バージョン 19.0 以降で利用できます。
項目
| 項目 | 項目の型 | 説明 |
|---|---|---|
| description | string | このリモートサイトの設定の使用目的を解説する説明。 |
| disableProtocolSecurity | boolean | 必須。ユーザー接続が HTTP または HTTPS 経由であるかに関係なく、Salesforce 内のコードでリモートサイトにアクセスできるか (true)、否か (false)、を示します。true である場合、Salesforce 内のコードは HTTPS セッションから HTTP セッションに、またその逆方向にもデータを渡せます。 セキュリティについて理解した上で true に設定してください。 |
| fullName | string | 名前には文字とアンダースコア (_) 文字のみを含めることができます。この名前は文字で始まる必要があり、末尾をアンダースコアにしたり、アンダースコア文字を 2 つ続けて使用したりできません。 この項目は、Metadata コンポーネントから継承されるため、このコンポーネントの WSDL では定義しません。作成時、更新時、または削除時に指定する必要があります。コールにこの項目を指定した例を確認するには、「create()」を参照してください。 |
| isActive | boolean | 必須。リモートサイトの設定が有効であるか (true)、否か (false) を示します。 |
| url | string | 必須。リモートサイトの URL。 |
宣言的なメタデータの定義のサンプル
次のコードブロックに、リモートサイトの設定の XML 定義のサンプルを示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<RemoteSiteSetting xmlns="http://soap.sforce.com/2006/04/metadata">
3 <description>Used for Apex callout to mapping web service</description>
4 <disableProtocolSecurity>false</disableProtocolSecurity>
5 <isActive>true</isActive>
6 <url>https://www.maptestsite.net/mapping1</url>
7</RemoteSiteSetting>