メタデータ 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) を介してログインすることもできます。 |
| doesApiLoginRequireOrgDomain | boolean | true の場合、ユーザは組織の [私のドメイン] ログイン URL を使用して Salesforce API にアクセスする必要があります。false (デフォルト) の場合、ユーザは汎用 Salesforce ページ (https://InstanceName.salesforce.com) を使用して、ログイン URL (https://login.salesforce.com) を介して Salesforce API にアクセスすることもできます。 |
| enableNativeBrowserForAuthOnAndroid | boolean | true の場合、Android モバイルアプリケーションの認証にネイティブブラウザを使用します。デフォルトは false です。 |
| enableNativeBrowserForAuthOnIos | boolean | true の場合、iOS モバイルアプリケーションの認証にネイティブブラウザを使用します。デフォルトは false です。 |
| myDomainName | string | この組織の [私のドメイン] URL で使用されるサブドメイン名 (MyDomainName.my.salesforce.com や MyDomainName.lightning.force.com など)。 これは、API では参照のみの項目です。[私のドメイン] の [設定] ページから組織の [私のドメイン] 名を変更できます。 API バージョン 51.0 以降で利用できます。 |
| myDomainSuffix | OrgDomainProdSuffix (string 型の列挙) | この組織の [私のドメイン] ログイン URL のドメインサフィックス。これは、API では参照のみの項目です。[私のドメイン] の [設定] ページから [私のドメイン] のサフィックスを変更できます。 使用可能な値は次のとおりです。
API バージョン 51.0 以降で利用できます。 |
| use3rdPartyCookieBlockingCompatibleHostnames | boolean | サードパーティ Cookie がブロックされたときに組織のインスタンス名を Visualforce URL に含めるか (true)、否か (false) を示します。この項目のデフォルト値は false です。この項目を true に設定すると、一貫性が確保された URL を使用して Visualforce ページを読み込んだ場合に問題が起こるのを防ぐことができます。 useStabilizedMyDomainHostnames が true に設定され、myDomainSuffix が MySalesforceLimited、CloudforceLimited、または DatabaseLimited に設定されている場合のみ適用されます。 API バージョン 51.0 以降で利用できます。 |
| useEdge | boolean | この組織の適格な [私のドメイン] URL が Salesforce Edge Network を介してルーティングされるか (true)、否か (false) を示します。この項目のデフォルト値は true です。 これは、API では参照のみの項目です。組織で Salesforce Edge Network を使用できる場合、この設定は [私のドメイン] の [設定] ページから有効にできます。[設定] からこの項目を true に設定すると、false に設定できなくなります。 API バージョン 51.0 以降で利用できます。 |
| useStabilizedMyDomainHostnames | boolean | Visualforce、エクスペリエンスビルダー、Site.com Studio、およびコンテンツファイルの [私のドメイン] URL でインスタンス名が非表示か (true)、否か (false) を示します。この項目のデフォルト値は true です。たとえば、この項目が true に設定されている場合、MyDomainName--PackageName.na44.visual.force.com は MyDomainName--PackageName.visualforce.com になります。 |
| 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 <enableNativeBrowserForAuthOnAndroid>false</enableNativeBrowserForAuthOnAndroid>
6 <enableNativeBrowserForAuthOnIos>false</enableNativeBrowserForAuthOnIos>
7 <myDomainName>mycompany</myDomainName>
8 <myDomainSuffix>MySalesforceLimited</myDomainSuffix>
9 <use3rdPartyCookieBlockingCompatibleHostnames>true</use3rdPartyCookieBlockingCompatibleHostnames>
10 <useEdge>true</useEdge>
11 <useStabilizedMyDomainHostnames>true</useStabilizedMyDomainHostnames>
12 <useStabilizedSandboxMyDomainHostnames>true</useStabilizedSandboxMyDomainHostnames>
13</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>51.0</version>
8</Package>