メタデータ API 開発者ガイド
jEmbeddedServiceConfig
ファイルのサフィックスおよびディレクトリの場所
EmbeddedServiceConfig コンポーネントは、EmbeddedServiceConfig フォルダの developer_name.EmbeddedServiceConfig ファイルに保存されます。
バージョン
EmbeddedServiceConfig は、API バージョン 37.0 以降で使用できます。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| authMethod | EmbeddedServiceAuthMethod (string 型の列挙) | この Snap-in リリースに選択されたログイン方法のタイプ。次のいずれかの値になります。
|
| customMinimizedComponent | string | この Snap-in リリースの最小化された Snap-in で使用されているカスタム Lightning コンポーネント。API バージョン 43.0 以降で利用できます。 |
| embeddedServiceCustomLabels | EmbeddedServiceCustomLabel[] | この Snap-in リリースで使用されるカスタム表示ラベル。API バージョン 44.0 以降で利用できます。 |
| masterLabel | string | 必須。組み込みサービス設定ノードの名前。 |
| shouldHideAuthDialog | boolean | フロー中に顧客に再ログインを要求するメッセージを非表示にするか (true)、否か (false) を指定します。非表示になっていると、直接ログインページに移動します。API バージョン 43.0 以降で利用できます。 |
| site | string | 必須。この Snap-in リリースに接続された Salesforce コミュニティまたは Salesforce サイトの名前。 |
宣言的なメタデータの定義のサンプル
次に、EmbeddedServiceConfig ファイルの例を示します。
1This is an example of an EmbeddedServiceConfig file.
2<?xml version="1.0" encoding="UTF-8"?>
3<EmbeddedServiceConfig xmlns="http://soap.sforce.com/2006/04/metadata">
4 <authMethod>CommunitiesLogin</authMethod>
5 <customMinimizedComponent>customMinimized</customMinimizedComponent>
6 <masterLabel>EswFS</masterLabel>
7 <shouldHideAuthDialog>false</shouldHideAuthDialog>
8 <site>SiteName</site>
9</EmbeddedServiceConfig>