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

ファイルのサフィックスおよびディレクトリの場所

EmbeddedServiceConfig コンポーネントは、EmbeddedServiceConfig フォルダの developer_name.EmbeddedServiceConfig ファイルに保存されます。

バージョン

EmbeddedServiceConfig は、API バージョン 37.0 以降で使用できます。

項目

項目名	項目の型	説明
areGuestUsersAllowed	boolean	ユーザが Snap-in にアクセスするにはログインが必要かどうかを指定します。API バージョン 45.0 以降で使用できます。
authMethod	EmbeddedServiceAuthMethod (string 型の列挙)	この Snap-in リリースに選択されたログイン方法のタイプ。次のいずれかの値になります。 `CommunitiesLogin` – 顧客はコミュニティを使用してログインします。 `CustomLogin` – 顧客は独自のカスタム認証を使用してログインします。 API バージョン 43.0 以降で利用できます。
customMinimizedComponent	string	この Snap-in リリースの最小化された Snap-in で使用されているカスタム Lightning コンポーネント。API バージョン 43.0 以降で利用できます。
embeddedServiceCustomComponents	EmbeddedServiceCustomComponent[]	この Snap-in リリースで使用されるカスタムコンポーネント。API バージョン 44.0 以降で利用できます。
embeddedServiceCustomLabels	EmbeddedServiceCustomLabel[]	この Snap-in リリースで使用されるカスタム表示ラベル。API バージョン 44.0 以降で利用できます。
embeddedServiceFlowConfig	EmbeddedServiceFlowConfig	フロー Snap-in を作成するための設定ノードを表します。API バージョン 45.0 以降で使用できます。
embeddedServiceFlows	EmbeddedServiceFlow[]	この Snap-in リリースで使用されるすべてのフロー。API バージョン 45.0 以降で利用できます。
masterLabel	string	必須。組み込みサービス設定ノードの名前。API バージョン 37.0 以降で利用できます。
shouldHideAuthDialog	boolean	フロー中に顧客に再ログインを要求する応答メッセージを非表示にするか (`true`)、否か (`false`) を指定します。非表示になっていると、直接ログインページに移動します。この項目は、デフォルトで `false` に設定されます。API バージョン 43.0 以降で利用できます。
site	string	必須。この Snap-in リリースに接続された Salesforce コミュニティまたはサイトの名前。API バージョン 37.0 以降で利用できます。

EmbeddedServiceCustomComponent

EmbeddedServiceConfig 設定に関連付けられたカスタムコンポーネントを返します。

項目名	項目の型	説明
customComponent	string	カスタムコンポーネントの名前。
customComponentType	EmbeddedServiceCustomComponent (string 型の列挙)	カスタムコンポーネントの種類。次のいずれかの値になります。 `LA_Prechat` (Snap-in チャットの事前チャットのコンポーネント) `LA_Minimized` (最小化されたチャット Snap-in のコンポーネント) `LA_PlainTextChatMessage` (Snap-in のテキストエリアのコンポーネント)

EmbeddedServiceCustomLabel

EmbeddedServiceConfig 設定に関連付けられたカスタム表示ラベルを返します。

項目名	項目の型	説明
customLabel	string	Snap-in に表示されるカスタム表示ラベル。
feature	EmbeddedServiceFeature (string 型の列挙)	この Snap-in で使用する機能。次のいずれかの値になります。 `Base` `FieldService` `Flows` `LiveAgent` `NotInUse`
labelKey	EmbeddedServiceLabelKey (string 型の列挙)	この Snap-in の表示ラベルの種別。この値は、表示ラベルグループ (チャットの状態の下位の状態またはページ種別) 内の表示ラベルに対応します。

EmbeddedServiceFlow

EmbeddedServiceConfig 設定に関連付けられた埋め込みフローを返します。

項目名	項目の型	説明
フロー	string	フローの API 参照名。
flowType	EmbeddedServiceFlowType (string 型の列挙)	フローの種別。次のいずれかの値になります。 `FS_Flow` `FS_NewAppointment` `FS_ModifyAppointment` `FS_CancelAppointment`
isAuthenticationRequired	boolean	ユーザが Snap-in にアクセスするにはログインが必要かどうかを示します。`FS_Flow` 値については `true` にできず、その他すべての値については `true` にする必要があります。

EmbeddedServiceFlowConfig

EmbeddedServiceFlowConfig 型を返します。

項目名	項目の型	説明
enabled	boolean	フロー Snap-in が有効かどうかを示します。

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

次に、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 ファイルを使用したメタデータのリリースと取得」を参照してください。