メタデータ API 開発者ガイド
jEmbeddedServiceConfig
ファイルのサフィックスおよびディレクトリの場所
EmbeddedServiceConfig コンポーネントは、EmbeddedServiceConfig フォルダの developer_name.EmbeddedServiceConfig ファイルに保存されます。
バージョン
EmbeddedServiceConfig は、API バージョン 37.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| areGuestUsersAllowed | boolean | ユーザが組み込みコンポーネントにアクセスするときにログインする必要があるかどうかを指定します。API バージョン 45.0 以降で利用できます。 |
| authMethod | EmbeddedServiceAuthMethod (string 型の列挙) | この組み込みサービスリリースに選択されたログイン方法のタイプ。有効な値は、次のとおりです。
|
| customMinimizedComponent | string | この組み込みサービスリリースの最小化された状態で使用されるカスタム Lightning コンポーネント。API バージョン 43.0 以降で利用できます。 |
| deploymentFeature | EmbeddedServiceDeploymentType(string 型の列挙) | この組み込みサービスリリースの会話種別。有効な値は、次のとおりです。
|
| deploymentType | EmbeddedServiceDeploymentType (string 型の列挙) | この組み込みサービスがリリースされるプラットフォーム。有効な値は、次のとおりです。
|
| embeddedServiceCustomComponents | EmbeddedServiceCustomComponent[] | この組み込みサービスリリースで使用されるカスタムコンポーネント。API バージョン 44.0 以降で利用できます。 |
| embeddedServiceCustomLabels | EmbeddedServiceCustomLabel[] | この組み込みサービスリリースで使用されるカスタム表示ラベル。API バージョン 44.0 以降で利用できます。 |
| embeddedServiceCustomizations | EmbeddedServiceCustomization[] | この組み込みサービスリリースで使用されるカスタマイズ。各カスタマイズは静的リソースに関連付けられています。API バージョン 50.0 以降で利用できます。 |
| embeddedServiceFlowConfig | EmbeddedServiceFlowConfig[] | 組み込みフローを作成するための設定ノードを表します。API バージョン 45.0 以降で利用できます。 |
| embeddedServiceFlows | EmbeddedServiceFlow[] | この組み込みサービスリリースで使用されるすべてのフロー。API バージョン 45.0 以降で利用できます。 |
| isEnabled | boolean | この組み込みサービスリリースが有効 (true) かどうかを示します。 |
| masterLabel | string | 必須。組み込みサービス設定ノードの名前。API バージョン 37.0 以降で利用できます。 |
| shouldHideAuthDialog | boolean | フロー中に顧客に再ログインを要求する応答メッセージを非表示にするか (true)、否か (false) を指定します。非表示になっていると、直接ログインページに移動します。この項目は、デフォルトで false に設定されます。API バージョン 43.0 以降で利用できます。 |
| site | string | 必須。この組み込みサービスリリースに接続されたエクスペリエンスサイトまたは Web サイトの名前。API バージョン 37.0 以降で利用できます。 |
EmbeddedServiceCustomComponent
EmbeddedServiceConfig 設定に関連付けられたカスタムコンポーネントを返します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| customComponent | string | カスタムコンポーネントの名前。 |
| customComponentType | EmbeddedServiceCustomComponent (string 型の列挙) | カスタムコンポーネントの種類。有効な値は、次のとおりです。
|
EmbeddedServiceCustomLabel
EmbeddedServiceConfig 設定に関連付けられたカスタム表示ラベルを返します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| customLabel | string | 組み込みコンポーネントに表示されるカスタム表示ラベル。 |
| feature | EmbeddedServiceFeature (string 型の列挙) | この組み込みコンポーネントで使用する機能。有効な値は、次のとおりです。
|
| labelKey | EmbeddedServiceLabelKey (string 型の列挙) | この組み込みコンポーネントの表示ラベルの種別。この値は、表示ラベルグループ (チャットの状態の下位の状態またはページ種別) 内の表示ラベルに対応します。 |
EmbeddedServiceCustomization
組み込みサービス機能に関連付けられているカスタマイズを返します。API バージョン 50.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| customizationName | string | 必須。組み込みサービスに適用されるカスタマイズの名前。この名前は、アンダースコアと英数字のみを使用でき、EmbeddedServiceConfig 設定で���意にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。 |
| description | string | カスタマイズの説明。 |
| embeddedServiceResources | EmbeddedServiceResource[] | 必須。カスタマイズの javascript ファイルを含む静的リソースへの参照。 |
EmbeddedServiceResource
組み込みサービスチャット機能のカスタマイズに関連付けられている静的リソースを返します。API バージョン 50.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| resource | string | 必須。カスタマイズの javascript ファイルを含む静的リソースの ID。 |
| resourceType | EmbeddedServiceResourceType (string 型の列挙) | 必須。カスタマイズする組み込みサービス機能。チャット機能のみがサポートされます。有効な値は、次のとおりです。
|
EmbeddedServiceFlow
EmbeddedServiceConfig 設定に関連付けられた埋め込みフローを返します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| flow | string | フローの API 参照名。 |
| flowType | EmbeddedServiceFlowType (string 型の列挙) | フローの種別。有効な値は、次のとおりです。
|
| isAuthenticationRequired | boolean | ユーザが組み込みサービスコンポーネントにアクセスするためにログインする必要があるかどうかを指定します。FS_Flow 値は true にできず、その他すべての値は true にする必要があります。 |
EmbeddedServiceFlowConfig
EmbeddedServiceFlowConfig 型を返します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| enabled | boolean | 組み込みフローが有効かどうかを示します。 |
宣言的なメタデータの定義のサンプル
次に、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>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) はサポートされません。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。