メタデータ API 開発者ガイド
jMyDomainSettings
ファイルのサフィックスおよびディレクトリの場所
MyDomainSettings の値は、settings ディレクトリの MyDomain.settings という 1 つのファイルに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。
バージョン
MyDomainSettings コンポーネントは、API バージョン 47.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| canOnlyLoginWithMyDomainUrl | boolean |
true の場合、ユーザーはログインに組織の [私のドメイン] ログイン URL を使用する必要があります。false (デフォルト) の場合、ユーザーは組織のインスタンスの Salesforce URL (https://InstanceName.salesforce.com) を使用して、ログイン URL (https://login.salesforce.com) を介してログインすることもできます。 管理者は、Sandbox で canOnlyLoginWithMyDomainUrl が false の場合のみ、Sandboxes の [設定] ページで [ログイン] アクションによりサンドボックスにログインできます。 |
| doesApiLoginRequireOrgDomain | boolean | true の場合、ユーザーは組織の [私のドメイン] ログイン URL を使用して Salesforce API にアクセスする必要があります。false (デフォルト) の場合、ユーザーは汎用 Salesforce ページ (https://InstanceName.salesforce.com) を使用して、ログイン URL (https://login.salesforce.com) を介して Salesforce API にアクセスすることもできます。 |
| doesWarnOnForceComRedirect | boolean | この組織の以前の *.force.com サイト URL にアクセスしたユーザーに、リダイレクト中に現在の URL のメッセージを表示するか (true)、否か (false) を示します。デフォルトは、false です。 この項目は次の場合にのみ適用されます。
この項目は、API バージョン 59.0 以降で利用できます。 |
| doesWarnOnRedirect | boolean | 以前の [私のドメイン] の URL にアクセスしたユーザーに、リダイレクト中に現在の URL のメッセージを表示するか (true)、否か (false) を示します。デフォルトは、false です。 この項目は次の場合にのみ適用されます。
この項目は、API バージョン 59.0 以降で利用できます。 |
| domainPartition | OrgDomainShard (string 型の列挙) | この組織のパーティション。none の場合、分割されたドメインは有効になりません。それ以外の場合は、[私のドメイン] ホスト名にパーティション値が含まれます。たとえば、ドメインが分割されている Developer Edition 組織の [私のドメイン] ログインホスト名の形式は MyDomainName.develop.my.salesforce.com です。 これは、API では参照のみの項目です。可能な値は次のとおりです。
パーティション分割されたドメインでは、拡張ドメインが必要です。本番組織、および拡張ドメインを持たない組織の値は常に none です。 GIA Hyperforce インスタンス上の組織および Public Cloud 組織では、Sandbox パーティションのみを利用できます。それ以外の場合、Salesforce Edge ネットワークを使用しているとき、demo、develop、patch、sandbox のパーティションのみを使用できます。 新しい Sandbox は、デフォルトで拡張ドメインにパーティション分割されます。対象の新しい組織は、デフォルトでパーティション分割され、対応する domainPartition 値を取得します。これらの組織でこの機能を無効にすることはできません。 scratch domainPartition は、Salesforce Edge ネットワークの組織で Summer ’24 までに利用できるようになります。この機能のリリースの最新情報を確認するには、Trailblazer Community の「My Domain and Enhanced Domains」グループのディスカッションに参加してください。 API バージョン 55.0 以降で利用できます。 |
| enableEdgeDuringRollout | boolean | スケジュールされたロールアウト中に Salesforce Edge ネットワークをこの組織で有効にするかどうかを示します。true の場合は、Salesforce Edge ネットワークが有効になる前に管理者にメールで通知が届きます。false の場合は、Edge の有効化が延期されます。デフォルト値は true です。 useEdge が true の場合、この項目による影響はありません。 API バージョン 58.0 以降で使用できます。 |
| enableNativeBrowserForAuthOnAndroid | boolean | true の場合、Android モバイルアプリケーションの認証にネイティブブラウザーを使用します。デフォルトは false です。 |
| enableNativeBrowserForAuthOnIos | boolean | true の場合、iOS モバイルアプリケーションの認証にネイティブブラウザーを使用します。デフォルトは false です。 |
| instancedUrlRedirectHandling | OrgDomainRedirectOption (string 型の列挙) | この組織のインスタンス化された URL へアクセスしたユーザーの処理方法を示します。 使用可能な値は次のとおりです。
たとえば、ユーザーが https://InstanceName.lightning.force.com/lightning/page/home にアクセスしたときに、https://MyDomainName.lightning.force.com/lightning/page/home にリダイレクトされるかどうかは、この設定によって決まります。 この項目の値は、ユーザーが組織のインスタンス化 URL 経由でログインする動作に影響しません。この動作を制御するには、canOnlyLoginWithMyDomainUrl を使用します。 API バージョン 59.0 以降で利用できます。 |
| logRedirections | boolean |
true の場合、Salesforce は、日次イベントログが生成されたときにホスト名リダイレクトイベント種別のログを生成します。デフォルトは、false です。 ホスト名リダイレクトイベントはすべてのお客様が無料で使用でき、データは 24 時間保持されます。logRedirections が true の場合、このイベントは API では使用できますが、Event Monitoring Analytics アプリケーションでは使用できません。最新のホスト名リダイレクトイベントログファイルは、[私のドメイン] ページのボタンを使用してダウンロードすることもできます。 API バージョン 56.0 以降で利用できます。 |
| myDomainName | string | この組織の [私のドメイン] URL で使用されるサブドメイン名 (MyDomainName.my.salesforce.com や MyDomainName.lightning.force.com など)。 これは、API では参照のみの項目です。[私のドメイン] の [設定] ページから組織の [私のドメイン] 名を変更できます。 API バージョン 51.0 以降で利用できます。 |
| myDomainSuffix | OrgDomainProdSuffix (string 型の列挙) | この組織の [私のドメイン] ログイン URL のドメインサフィックス。これは、API では参照のみの項目です。 可能な値は次のとおりです。
API バージョン 51.0 以降で利用できます。 |
| redirectForceComSitesUrls | boolean |
true の場合、Experience Cloud サイトと Salesforce サイトにサービスを提供している、末尾が .force.com の URL をコールすると、対応する現在の [私のドメイン] のサイト URL にリダイレクトされます。false の場合、このコールはリダイレクトされず、ファイルが見つかりません (404) というエラーが表示されます。デフォルトは true です。 この項目は次の場合にのみ適用されます。
API バージョン 55.0 以降で利用できます。 |
| redirectPriorMyDomain | boolean |
true の場合、以前の [私のドメイン] の名前に関連付けられている URL へのコールは、現在の [私のドメイン] に関連付けられている対応する URL にリダイレクトされます。false の場合、このコールはリダイレクトされません。新しい [私のドメイン] をリリースすると、この設定はデフォルトの true にリセットされます。 この項目は次の場合にのみ適用されます。
API バージョン 54.0 以降で利用できます。 |
| use3rdPartyCookieBlockingCompatibleHostnames | boolean | サードパーティ Cookie がブロックされたときに組織のインスタンス名を Visualforce URL に含めるか (true)、否か (false) を示します。この項目のデフォルト値は true です。この項目を true に設定すると、一貫性が確保された URL を使用して Visualforce ページを読み込んだ場合に問題が起こるのを防ぐこ���ができます。 useStabilizedMyDomainHostnames が true に設定され、myDomainSuffix が MySalesforceLimited、CloudforceLimited、または DatabaseLimited に設定されている場合のみ適用されます。 API バージョン 51.0 以降で利用できます。 |
| useEdge | boolean |
この組織の適格な [私のドメイン] URL が Salesforce Edge ネットワークを介してルーティングされるか (true)、否か (false) を示します。この項目のデフォルト値は true です。 これは、API では参照のみの項目です。組織で Salesforce Edge ネットワークを使用できる場合、この設定は [私のドメイン] の [設定] ページから有効にできます。[設定] からこの項目を true に設定すると、false に設定できなくなります。 API バージョン 51.0 以降で利用できます。 |
| useEnhancedDomainsInSandbox | boolean | この項目は、Summer ’23 で削除された以前の [私のドメイン] 設定、[新しい Sandbox と更新された Sandbox ではデフォルトで拡張ドメインが使用されます] に対応するものです。 以前の API バージョン 55.0 から 57.0 で拡張ドメインが有効になっていない場合、この項目は、この組織から作成された新規および更新済みの Sandbox がデフォルトで拡張ドメインを使用するか (true)、否か (false) を示しました。デフォルト値は true でした。API バージョン 58.0 以降では、この項目の値は自分で設定した値に関係なく常に true になります。この値を変更して false と表示されていたとしても、Salesforce に対しては効果がありません。 |
| useStabilizedMyDomainHostnames | boolean | Visualforce、エクスペリエンスビルダー、Site.com Studio、およびコンテンツファイルの [私のドメイン] URL でインスタンス名が非表示か (true)、否か (false) を示します。この項目のデフォルト値は true です。たとえば、この項目が true に設定されている場合、MyDomainName--PackageName.na44.visual.force.com は MyDomainName--PackageName.visualforce.com になります。 myDomainSuffix が MySalesforceLimited、CloudforceLimited、または DatabaseLimited に設定されている場合にのみ適用されます。 |
| useStabilizedSandboxMyDomainHostnames | boolean | この項目は、Summer ’20 で適用されたリリース更新「Sandbox の [私のドメイン] URL のホスト名の一貫性の確保」に対応します。 true の場合、Sandbox 組織の [私のドメイン] URL でインスタンス名が非表示になります。たとえば、MyDomainName--test.cs5.my.salesforce.com は MyDomainName--test.my.salesforce.com になっています。API バージョン 49.0 以降では、この項目の値は自分で設定した値に関係なく常に true になります。この値を変更して false と表示されていたとしても、Salesforce に対しては効果がありません。 この変更は、この項目が最初に導入された API バージョン 47.0 まで遡って適用されます。以前は、API バージョン 47.0 から 49.0 では、この項目は Sandbox 組織の [私のドメイン] URL でインスタンス名が非表示か (true)、否か (false) を示していて、項目のデフォルト値は false でした。現在はすべての API バージョンでこの項目の値は false と表示されていたとしても常に true になります。 |
宣言的なメタデータの定義のサンプル
MyDomainSettings コンポーネントの例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<MyDomainSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3 <canOnlyLoginWithMyDomainUrl>false</canOnlyLoginWithMyDomainUrl>
4 <doesApiLoginRequireOrgDomain>false</doesApiLoginRequireOrgDomain>
5 <doesWarnOnForceComRedirect>false</doesWarnOnForceComRedirect>
6 <doesWarnOnRedirect>true</doesWarnOnRedirect>
7 <domainPartition>none</domainPartition>
8 <enableEdgeDuringRollout>true</enableEdgeDuringRollout>
9 <enableNativeBrowserForAuthOnAndroid>false</enableNativeBrowserForAuthOnAndroid>
10 <enableNativeBrowserForAuthOnIos>false</enableNativeBrowserForAuthOnIos>
11 <instancedUrlRedirectHandling></instancedUrlRedirectHandling>
12 <logRedirections>true</logRedirections>
13 <myDomainName>mycompany</myDomainName>
14 <myDomainSuffix>MySalesforce</myDomainSuffix>
15 <redirectForceComSitesUrls>true</redirectForceComSitesUrls>
16 <redirectPriorMyDomain>true</redirectPriorMyDomain>
17 <use3rdPartyCookieBlockingCompatibleHostnames>true</use3rdPartyCookieBlockingCompatibleHostnames>
18 <useEdge>true</useEdge>
19 <useEnhancedDomainsInSandbox>true</useEnhancedDomainsInSandbox>
20 <useStabilizedMyDomainHostnames>true</useStabilizedMyDomainHostnames>
21 <useStabilizedSandboxMyDomainHostnames>true</useStabilizedSandboxMyDomainHostnames>
22</MyDomainSettings>前の定義を参照する package.xml の例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>MyDomain</members>
5 <name>Settings</name>
6 </types>
7 <version>59.0</version>
8</Package>