CustomSite

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

詳細は、Salesforce ヘルプの「Salesforce サイト」を参照してください。

CustomSite では、現在シンジケーションフィードはサポートされていません。

メモ

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所

Lightning プラットフォームの CustomSite コンポーネントは、対応するパッケージディレクトリの sites ディレクトリに保存されます。ファイル名はサイト名に一致し、拡張子は .site です。

バージョン

Lightning プラットフォームの CustomSite コンポーネントは、API バージョン 14.0 以降で使用できます。

項目

項目	項目の型	説明
active	boolean	必須。サイトが有効かどうかを決定します。
allowHomePage	boolean	必須。標準ホームページが一般ユーザに表示されるかどうかを決定します。この項目は、API バージョン 15.0 以降で使用できます。
allowStandardAnswersPages	boolean	標準回答ページが一般ユーザに表示されるかどうかを決定します。この項目は、API バージョン 19.0 以降で使用できます。
allowStandardIdeasPages	boolean	必須。標準のアイデアページが一般ユーザに表示されるかどうかを決定します。この項目は、API バージョン 15.0 以降で使用できます。
allowStandardLookups	boolean	必須。標準ルックアップページが一般ユーザに表示されるかどうかを決定します。この項目は、API バージョン 15.0 以降で使用できます。
allowStandardPortalPages	boolean	必須。有効にすると、このサイトの認証済みユーザは、そのユーザのアクセス制御で許可されている標準の Salesforce ページにアクセスできます。無効にすると、このサイトの認証済みユーザは、そのユーザのアクセス制御で許可されていても標準の Salesforce ページにアクセスできません。サイトで Visualforce ページのみを提供する場合、この設定を無効にすることでアクセス保護のレイヤをサイトに追加できます。この項目は、API バージョン 39.0 以降で使用できます。
allowStandardSearch	boolean	必須。標準検索ページが一般ユーザに表示されるかどうかを決定します。この項目は、API バージョン 15.0 以降で使用できます。
analyticsTrackingCode	string	サイトに関連付けられている追跡コード。Google アナリティクスなどのサービスは、このコードを使用してサイトのページ要求データを追跡できます。この項目は、API バージョン 17.0 以降で使用できます。
authorizationRequiredPage	string	ゲストユーザが許可されていないページにアクセスしようとすると表示される Visualforce ページの名前。
bandwidthExceededPage	string	サイトがその割り当て帯域幅を超えると表示される Visualforce ページの名前。
browserXssProtection	boolean	必須。反射型クロスサイトスクリプティング攻撃に対する保護を有効にするかどうかを決定します。反射型クロスサイトスクリプティング攻撃が検出されると、コンテンツのない空白のページがブラウザに表示されます。API バージョン 41.0 以降で利用できます。
cachePublicVisualforcePagesInProxyServers	boolean	プロキシサーバで、認証されていないゲストユーザに対してのみ、サイトの公開されているページをキャッシュするか (`true`)、否か (`false`) を示します。この項目を `false` にすると、このサイトのキャッシュが有効な Visualforce ページが、認証済みのユーザと未認証のユーザの両方の Web ブラウザにキャッシュされます。デフォルトは `true` です。詳細は Salesforce ヘルプの「Salesforce サイトページのキャッシュ」を参照してください。この項目は、API バージョン 52.0 以降で使用できます。
changePasswordPage	string	ポータルまたは Chatter アンサーのいずれかのパスワードをポータルユーザが変更しようとすると表示される Visualforce ページの名前 (有効になっている場合)。
chatterAnswersForgotPasswordConfirmPage	string	仮パスワードを記載したメールが送信されたことをユーザに知らせるために表示される Visualforce ページの名前。この項目は、組織で Chatter アンサーが有効になっている場合に使用できます。この項目は、API バージョン 27.0 以降で使用できます。
chatterAnswersForgotPasswordPage	string	ユーザがリンクをクリックして忘れたパスワードを取得する場合に表示される Visualforce ページの名前。この項目は、組織で Chatter アンサーが有効になっている場合に使用できます。この項目は、API バージョン 27.0 以降で使用できます。
chatterAnswersHelpPage	string	ユーザがヘルプリンクをクリックすると表示される Visualforce ページの名前。この項目は、組織で Chatter アンサーが有効になっている場合に使用できます。この項目は、API バージョン 27.0 以降で使用できます。
chatterAnswersLoginPage	string	ユーザが��ータルにログインできるようにするために表示される Visualforce ページの名前。この項目は、組織で Chatter アンサーが有効になっている場合に使用できます。この項目は、API バージョン 27.0 以降で使用できます。
chatterAnswersRegistrationPage	string	ユーザを登録してポータルにアクセスできるようにするために表示される Visualforce ページの名前。この項目は、API バージョン 27.0 以降で使用できます。
clickjackProtectionLevel	SiteClickjackProtectionLevel (string 型の列挙)	必須。クリックジャック保護レベルを設定します。選択肢は次のとおりです。 `AllowAllFraming` — すべてのページでフレーム化を許可 (保護なし) `External` — 外部ドメイン上でサイトまたは Experience Cloud サイトページのフレーム化を許可 (適切な保護) `SameOriginOnly` — 公開元が同じページのみでフレーム化を許可 (推奨) `NoFraming` — すべてのページでフレーム化を許可しない (最大保護) この項目は、API バージョン 30.0 以降で使用できます。
contentSniffingProtection	boolean	必須。ブラウザでドキュメントコンテンツから MIME タイプが推定されないかどうかを決定します。有効になっている場合、ブラウザで一部の悪意のあるファイル (JavaScript、スタイルシート) が動的コンテンツとして実行されないようにします。この項目は、API バージョン 41.0 以降で使用できます。
cspUpgradeInsecureRequests	boolean	この項目は、API バージョン 52.0 以降で削除されます。API バージョン 51.0 以前では、この項目の値は無視されます。
customWebAddresses	SiteWebAddress[]	サイトに関連付けられたルートカスタム URL。CustomSite を保存またはリリースすると、サイト内のすべてのルートカスタム URL がこのリストのルートカスタム URL に置き換えられます。ルート以外のパスプレフィックスを使用するカスタム URL はこのリストには含まれず、CustomSite を保存またはリリースしても影響を受けません。この項目は、API バージョン 21.0 以降で使用できます。
description	string	サイトの説明。
enableAuraRequests	boolean	ゲストユーザが Lightning でしか使用できない機能を表示できるかどうかを決定します (`true`)。`false` に設定すると、Lightning 機能は読み込まれません。この項目は、API バージョン 46.0 以降で使用できます。
favoriteIcon	string	サイトにアクセスしているときに、ブラウザのアドレス項目に表示されるアイコンに使用されるファイルの名前。サイト全体のお気に入りアイコンを設定します。
fileNotFoundPage	string	ゲストユーザが存在しないページにアクセスしようとすると表示される Visualforce ページの名前。
forgotPasswordPage	string	ユーザがサイトのログインページで [パスワードを忘れた場合] リンクをクリックすると表示される Visualforce ページの名前。この項目は、Experience Cloud サイトにのみ適用されます。
genericErrorPage	string	エラー時に、他に指定されていない場合に表示される Visualforce ページの名前。
guestProfile	string	参照のみ。ゲストユーザに関連付けられたプロファイルの名前。
inMaintenancePage	string	サイトがメンテナンスのためにダウンしている場合に表示される Visualforce ページの名前。
inactiveIndexPage	string	無効なサイトのホームページとして設定されている Visualforce ページの名前。
indexPage	string	必須。有効なサイトのホームページとして設定されている Visualforce ページの名前。
masterLabel	string	必須。Salesforce ユーザインターフェースでのサイトの表示ラベル名。
myProfilePage	string	サイトユーザのプロファイルページとして表示される Visualforce ページの名前。このページでは、ユーザが自分の連絡先情報を更新できます。この項目は、API バージョン 20.0 以降で使用できます。
portal	string	ログインアクセス用にこのサイトに関連付けられたポータルの名前。
redirectToCustomDomain	boolean	このサイトのシステムで管理される URL への要求が、このサイトを提供している HTTPS カスタムドメインにリダイレクトされるか (`true`)、否か (`false`) を示します。システムで管理されるサイト URL は末尾が .force.com、.my.salesforce-sites.com、または *.my.site.com になります。Experience Cloud サイトでは、デフォルト値は `false` です。Salesforce サイトでは、デフォルトは `true` です。このサイトを提供するカスタムドメインが複数あり、この項目が `true` に設定されている場合は、サイトの主カスタム URL が HTTPS カスタムドメインである場合のみ、要求が主カスタム URL に転送されます。そうでない場合は、このサイトに関連付けられている英数字順で最初の HTTPS カスタムドメインに要求がリダイレクトされます。このサイトを提供する HTTPS カスタムドメインがない場合は、このオプションの効果はありません。この項目は、API バージョン 52.0 以降で使用できます。
referrerPolicyOriginWhenCrossOrigin	boolean	必須。ページを読み込むときに、参照元ヘッダーに URL 全体ではなく Salesforce.com のみを表示するかどうかを決定します。この機能により、完全な URL だと公開されてしまう可能性のある機密情報 (組織 ID など) が参照元ヘッダーに表示されなくなります。この項目は、API バージョン 41.0 以降で使用できます。
requireHttps	boolean	この項目は、API バージョン 52.0 以降で削除されます。API バージョン 51.0 以前では、この項目の値は無視されます。
requireInsecurePortalAccess	boolean	組織のセキュリティ設定を上書きし、サイトから関連付けられたポータルにログインする場合に HTTP を排他的に使用するかどうかを決定します。API バージョン 50.0 以降では削除されています。
robotsTxtPage	string	Web クローラで使用される robots.txt ファイルに表示される Visualforce ページの名前。
selfRegPage	string	セルフ登録で使用する Visualforce ページ。
serverIsDown	string	Salesforce サーバのダウン時にキャッシュサーバから表示される静的リソースの名前。静的リソースは、1 MB 以下の公開 zip ファイルで、zip ファイルのルートレベルに maintenance.html という名前のページが含まれている必要があります。画像や CSS ファイルなどの、zip ファイル内のその他のリソースは、ディレクトリ構造上の制限はありません。この項目は、API バージョン 17.0 以降で使用できます。
siteAdmin	string	サイト管理者のユーザ名。
siteGuestRecordDefaultOwner	string	認証されていないゲストユーザが作成するすべての新規レコードを所有するユーザのユーザ名。この項目は、API バージョン 51.0 以降で使用できます。
siteIframeWhiteListUrls	SiteIframeWhiteListUrl[]	Salesforce サイトのフレーム化を許可する外部ドメインのリスト。この項目は API 49.0 以降で使用できます。
siteRedirectMappings	SiteRedirectMapping[]	サイトに設定されているすべての URL リダイレクトルールの配列。この項目は、API バージョン 20.0 以降で使用できます。
siteTemplate	string	サイトテンプレートとして使用される Visualforce ページの名前。
siteType	siteType	必須。サイトが Visualforce (Salesforce サイト) であるか、Site.com サイトであるか、ChatterNetwork (Salesforce サイト) であるかを特定します。この項目は、API バージョン 27.0 以降で使用できます。
subdomain	string	必須。参照のみ。サイトのカスタムサブドメインプレフィックス。たとえば、サイト URL が mycompany.force.com/partners である場合、mycompany は subdomain です。拡張ドメインが有効な場合、サイトの URL は異なり、サブドメインとして [私のドメイン] の名前が使用されます。詳細は、Salesforce ヘルプの「[私のドメイン] の URL の形式」を参照してください。拡張ドメインを有効にした後で Salesforce サイトまたはデジタルエクスペリエンスを有効にした場合、この項目は NULL 値を返します。拡張ドメインを有効にする前に Salesforce サイトまたはデジタルエクスペリエンスを有効にしている場合、この項目は、このサイトの前のサブドメインを返します。メモ
urlPathPrefix	string	サイトを他のサイトと区別する、サイトの URL 上のパスの最初の部分。たとえば、サイト URL が `MyDomainName`.my.salesforce-sites.com/partners である場合、partners が urlPathPrefix です。拡張ドメインを使用していない場合、組織の [私のドメイン] の URL は異なります。詳細は、Salesforce ヘルプの「[私のドメイン] の URL の形式」を参照してください。メモ

SiteIframeWhiteListUrl

サイトまたはエクスペリエンスページのフレーム化を許可する外部ドメインを表します。

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。コード内で用語を変更すると、現在の実装が壊れる可能性があるため、このメタデータ型の名前は維持しました。

重要

項目	項目の型	説明
url	string	必須。サイトまたは Experience Cloud サイトページのフレーム化を許可する信頼済みドメイン。`example`、`example.com`、`*example.com`、および `https://example.com` の形式が使用可能です。

SiteRedirectMapping

SiteRedirectMapping は、Salesforce サイトの URL リダイレクトルール��表します。

項目	項目の型	説明
action	SiteRedirect (string 型の列挙)	必須。リダイレクトの種別。使用可能な string 値は次のとおりです。 `Permanent` `Temporary`
isActive	boolean	リダイレクトの状況 (有効または無効)。
source	string	必須。リダイレクトする URL。相対 URL である必要がありますが、.html や .php など、任意の有効な種類の拡張子にできます。
target	string	必須。ユーザのアクセス先とする新しい URL。相対 URL または http:// や https:// プレフィックスを含む完全修飾 URL にすることができます。

SiteWebAddress

Salesforce サイトの Web アドレスを表します。

項目	項目の型	説明
certificate	string	カスタムドメインに関連付けられた証明書を識別します。Salesforce で HTTPS を提供するためにカスタムドメインが設定されている場合、この項目で使用する証明書を示します。
domainName	string	必須。Web サイトのドメイン。`www.acme.com` 形式で指定します。
primary	boolean	必須。これはプライマリドメインであるか (`true`)、否かを示します。`false` の場合は、プライマリドメインではありません。

宣言的なメタデータの定義のサンプル

次に、サイトの XML 定義のサンプルを示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<CustomSite xmlns="http://soap.sforce.com/2006/04/metadata">
3    <active>true</active>
4    <allowHomePage>true</allowHomePage>
5    <allowStandardAnswersPages>true</allowStandardAnswersPages>
6    <allowStandardIdeasPages>true</allowStandardIdeasPages>
7    <allowStandardLookups>true</allowStandardLookups>
8    <allowStandardPortalPages>true</allowStandardPortalPages>
9    <allowStandardSearch>true</allowStandardSearch>
10    <analyticsTrackingCode>UA-000000-2</analyticsTrackingCode>
11    <authorizationRequiredPage>Unauthorized</authorizationRequiredPage>
12    <bandwidthExceededPage>BandwidthExceeded</bandwidthExceededPage>
13    <browserXssProtection>true</browserXssProtection>
14    <cachePublicVisualforcePagesInProxyServers>false</cachePublicVisualforcePagesInProxyServers>
15    <changePasswordPage>ChangePassword</changePasswordPage>
16    <chatterAnswersForgotPasswordConfirmPage>ChatterAnswersForgotPasswordConfirm</chatterAnswersForgotPasswordConfirmPage>
17    <chatterAnswersForgotPasswordPage>ChatterAnswersForgotPassword</chatterAnswersForgotPasswordPage>
18    <chatterAnswersHelpPage>ChatterAnswersHelp</chatterAnswersHelpPage>
19    <chatterAnswersLoginPage>ChatterAnswersLogin</chatterAnswersLoginPage>
20    <chatterAnswersRegistrationPage>ChatterAnswersRegistration</chatterAnswersRegistrationPage>
21    <clickjackProtectionLevel>SameOriginOnly</clickjackProtectionLevel>
22    <contentSniffingProtection>true</contentSniffingProtection>
23    <customWebAddresses>
24      <domainName>www.testing123.com</domainName>
25      <primary>true</primary>
26    </customWebAddresses>
27    <description>Partners portal for My Company</description>
28    <enableAuraRequests>true</enableAuraRequests>
29    <favoriteIcon>myFavIcon</favoriteIcon>
30    <fileNotFoundPage>FileNotFound</fileNotFoundPage>
31    <forgotPasswordPage>ForgotPassword</forgotPasswordPage>
32    <genericErrorPage>Exception</genericErrorPage>
33    <guestProfile>Guest</guestProfile>
34    <inMaintenancePage>InMaintenance</inMaintenancePage>
35    <inactiveIndexPage>Inactive</inactiveIndexPage>
36    <indexPage>UnderConstruction</indexPage>
37    <masterLabel>customSite</masterLabel>
38    <myProfilePage>UserProfile</myProfilePage>
39    <portal>Customer Portal</portal>
40    <redirectToCustomDomain>true</redirectToCustomDomain>
41    <referrerPolicyOriginWhenCrossOrigin>true</referrerPolicyOriginWhenCrossOrigin>
42    <robotsTxtPage>RobotsTxt</robotsTxtPage>
43    <selfRegPage>SelfReg</selfRegPage>
44    <serverIsDown>MyServerDownResource</serverIsDown>
45    <siteAdmin>admin@myco.org</siteAdmin>
46    <siteGuestRecordDefaultOwner>admin@myco.org</siteGuestRecordDefaultOwner>
47    <siteIframeWhiteListUrl>
48      <url>example.com</url>
49    </siteIframeWhiteListUrl>
50    <siteTemplate>SiteTemplate</siteTemplate>
51    <siteType>Siteforce</siteType>
52    <subdomain>myco</subdomain>
53    <urlPathPrefix>partners</urlPathPrefix>
54</CustomSite>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。

メタデータ API 開発者ガイド