メタデータ API 開発者ガイド
jEmbeddedServiceLiveAgent
ファイルのサフィックスおよびディレクトリの場所
EmbeddedServiceLiveAgent コンポーネントは、EmbeddedServiceLiveAgent フォルダの developer_name.EmbeddedServiceLiveAgent ファイルに保存されます。
バージョン
EmbeddedServiceLiveAgent は、API バージョン 38.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| avatarImg | string | この埋め込みチャットリリースのアバター画像。 |
| customPrechatComponent | string | この埋め込みチャットリリースの事前チャットページで使用するカスタム Lightning コンポーネント。 |
| embeddedServiceConfig | string | 必須。組み込みサービス設定ノードの名前。 |
| embeddedServiceQuickActions | EmbeddedServiceQuickAction | 事前チャットフォームで使用するクイックアクション。 |
| enabled | boolean | 必須。この埋め込みチャットリリースが有効 (true) かどうかを示します。 |
| fontSize | EmbeddedServiceFontSize (string 型の列挙) | 必須。埋め込みチャットウィンドウのテキストのフォントサイズ。次のいずれかの値になります。
|
| headerBackgroundImg | string | この埋め込みチャットウィンドウのヘッダーの背景画像。API バージョン 49.0 で削除されました。 |
| isOfflineCaseEnabled | boolean | この埋め込みチャットリリースでオフラインサポートが有効になっているかどうかを示します。API バージョン 43.0 以降で利用できます。 |
| isQueuePositionEnabled | boolean | この埋め込みチャットリリースで (エージェントを待機している間のチャット訪問者の順番を表示する) キューの位置が有効になっているかどうかを示します。API バージョン 43.0 以降で利用できます。 |
| liveAgentChatUrl | string | チャットの REST エンドポイント。 |
| liveAgentContentUrl | string | チャットコンテンツの REST エンドポイント。 |
| liveChatButton | string | 必須。チャットの設定で作成したチャットボタンへの参照。 |
| liveChatDeployment | string | 必須。チャットの設定で作成したリリースへの参照。 |
| masterLabel | string | 必須。埋め込みチャットリリースの名前。 |
| offlineCaseBackgroundImg | string | この埋め込みチャットウィンドウのオフラインサポートケースフォームの背景画像。API バージョン 43.0 以降で利用できます。 |
| prechatBackgroundImg | string | この埋め込みチャットウィンドウの事前チャットの背景画像。 |
| prechatEnabled | string | 必須。埋め込みチャットの事前チャットフォームがこのチャットリリースで有効かどうかを示します。 |
| prechatJson | string | チャットの設定で選択した事前チャットフォームのすべての項目の JSON オブジェクト。 |
| scenario | EmbeddedServiceScenario (string 型の列挙) | 必須。チャットにどのオブジェクトが関連するかを決定する埋め込みチャットウィンドウのシナリオ。次のいずれかの値になります。
|
| smallCompanyLogoImg | string | この埋め込みチャットウィンドウの会社のロゴ画像。 |
| waitingStateBackgroundImg | string | この埋め込みチャットウィンドウの待機中のチャットの画像。 |
EmbeddedServiceQuickAction
EmbeddedServiceLiveAgent 設定に関連付けられたクイックアクションを返します。クイックアクションには、組み込みのチャットウィンドウで表示する事前チャットフォーム項目が含まれ、項目の表示順序が示されます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| embeddedServiceLiveAgent | string | 埋め込みチャットリリースへの参照。 |
| order | int | 埋め込みチャットの事前チャットフォームに表示するこのクイックアクションの順序。 |
| quickActionDefinition | string | クイックアクションへの参照。 |
| quickActionType | EmbeddedServiceQuickActionType (string 型の列挙) | クイックアクション種別。次のいずれかの値になります。
|
使用方法
EmbeddedServiceLiveAgent は、Web ページに追加するチャット設定を表します。EmbeddedServiceLiveAgent レコードには、システム管理者が設定時に選択するチャットボタンとチャットリリースの独自の組み合わせが含まれます。
EmbeddedServiceLiveAgent レコードを作成する手順は、次のとおりです。
- チャットリリースレコードを作成します。
- チャットボタンレコードを作成します。
- EmbeddedServiceConfig レコードを作成します。
- チャットリリースレコード、チャットボタンレコード、および EmbeddedServiceConfig レコードの項目を EmbeddedServiceLiveAgent レコード上の参照として設定します。
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) はサポートされません。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。