この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

EmbeddedServiceLiveAgent

Snap-in チャット Live Agent リリースを作成するための設定ノードを表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。

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

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

バージョン

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

項目

項目名	データ型	説明
avatarImg	string	この Snap-in のアバター画像。
customPrechatComponent	string	この Snap-in チャットリリースの事前チャットページで使用するカスタム Lightning コンポーネント。
embeddedServiceConfig	string	必須。組み込みサービス設定ノードの名前。
embeddedServiceQuickActions	EmbeddedServiceQuickAction	事前チャットフォームで使用するクイックアクション。
enabled	boolean	必須。この Snap-in チャットの `Live Agent` リリースが有効 (true) かどうかを示します。
fontSize	string	必須。Snap-in のテキストのフォントサイズ。有効な値は次のとおりです。 `Small` `Medium` `Large`
headerBackgroundImg	string	この Snap-in のヘッダーの背景画像。
liveAgentChatUrl	string	Live Agent チャットの REST エンドポイント。
liveAgentContentUrl	string	Live Agent コンテンツの REST エンドポイント。
liveChatButton	string	必須。Live Agent の設定で作成したチャットボタンへの参照。
liveChatDeployment	string	必須。Live Agent の設定で作成したリリースへの参照。
masterLabel	string	必須。Snap-in チャットの Live Agent リリースの名前。
prechatBackgroundImg	string	この Snap-in の事前チャットの背景画像。
prechatEnabled	string	必須。Snap-in チャットの事前チャットフォームがこのチャットリリースで有効かどうかを示します。
prechatJson	string	Live Agent の設定で選択した事前チャットフォームのすべての項目の JSON オブジェクト
scenario	string	必須。チャットにどのオブジェクトが関連するかを決定する Snap-in のシナリオ。有効な文字列値は次のとおりです。 `Sales` `Service` `Basic`
smallCompanyLogoImg	string	この Snap-in の会社のロゴ画像。
waitingStateBackgroundImg	string	この Snap-in の待機中のチャットの画像。

EmbeddedServiceQuickAction

EmbeddedServiceLiveAgent 設定に関連付けられたクイックアクションを返します。クイックアクションには、Snap-in で表示する事前チャットフォーム項目が含まれ、項目の表示順序が示されます。

項目名	データ型	説明
embeddedServiceLiveAgent	string	Snap-in チャットの Live Agent リリースへの参照。
order	int	Snap-ins チャットの事前チャットフォームに表示するこのクイックアクションの順序。
quickActionDefinition	string	クイックアクションへの参照。

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

次に、EmbeddedServiceLiveAgent ファイルの例を示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<EmbeddedServiceLiveAgent xmlns="http://soap.sforce.com/2006/04/metadata">
3    <embeddedServiceConfig>04ID000000000FD</embeddedServiceConfig>
4    <enabled>true</enabled>
5    <fontSize>Medium</fontSize>
6    <liveChatButton>573D00000004GgC</liveChatButton>
7    <liveChatDeployment>572D00000004GMd</liveChatDeployment>
8    <masterLabel>EmbeddedServiceLiveAgent_Parent04IRM0000004C9I2AU_15f2777f997</masterLabel>
9    <prechatEnabled>true</prechatEnabled>
10    <scenario>Service</scenario>
11</EmbeddedServiceLiveAgent>

使用方法

EmbeddedServiceLiveAgent は、Web ページに追加する Live Agent 設定を表します。EmbeddedServiceLiveAgent レコードには、システム管理者が設定時に選択する Live Agent チャットボタンと Live Agent リリースの独自の組み合わせが含まれます。

EmbeddedServiceLiveAgent レコードを作成する手順は、次のとおりです。

LiveAgent リリースレコードを作成します。
LiveAgent チャットボタンレコードを作成します。
EmbeddedServiceConfig レコードを作成します。
LiveAgent リリースレコード、LiveAgent チャットボタンレコード、および EmbeddedServiceConfig レコードの項目を EmbeddedServiceLiveAgent レコード上の参照として設定します。

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